I’m building a new MODX site for an academic library. I am working on the design guide/documentation section of the site. Currently permissions only allow those logged into the manager to see the design guide(so I cannot share a link) I will not be managing the content.
Does anyone have suggestions or examples for documenting the various Templates used on the site?
I am thinking the Template docs should include the following sections
That sounds good. Since the Template list and the list of TVs for each one will probably change with some regularity, I would suggest automating the Template/TV listing with a custom snippet. It’s not terribly difficult, and would ultimately save you a lot of time. It could also automatically include each Template’s description, and make its name a link to the example page.
@bobray
Thanks for the suggestion. I do not currently program very much in php any more and I do not know the MODX API very well. I but I was reading some of your blog posts on extracting template information. So I might tackle this problem sometime in the near future.
I think this would be a great topic to tackle in your blog postings. Not just the template docs, but anyway to automate creation of documentation for a site. Now that I occasionally build sites that others manage the content, I am focusing more on documenting the site’s design. It helps the content editors for the site greatly.