Forum

Thread tagged as: Question, Suggestions, Runway

Meta info for a template?

Is there a way to add info inside a template that wouldn't get rendered that could be used by developers for documentation. Some way to comment that isn't rendered.

As templates grow on larger sites it might help a team of developers understand basic information about a particular template.

We currently use careful file and folder name conventions and share with our small dev team. Sometimes <perch:help> works too.

The elegance of the format used to on the github solutions page is quite nice although may not be a right fit. We could use <!-- Template name and purpose --> but that would get rendered on the public facing html.

Ex:

  • Created by: Joe Bloggs
  • Created date: 2014-03-11
  • Last updated: 2014-03-11
  • Authors: Joe Bloggs
  • Title: Template title
  • Purpose: Description of template.
Scott Gruber

Scott Gruber 0 points

  • 7 years ago
Drew McLellan

Drew McLellan 2638 points
Perch Support

Something like a <perch:notes> </perch:notes> tag block?

Yes. That would do it.

I too like this idea... <perch:notes> ... </perch:notes>

but I would like to see this be a Perch and Runway feature.

Robert Ketter