midcom_admin_help and component documentation
"Henri Bergius" <henri.bergius-ZpG/[email protected]> Thu, 16 Feb 2006 17:40:21 +0200 (EET)
| Newsgroups | gmane.comp.web.midgard.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi! Tarjei has made a new request handler helper midcom.admin.help for serving documentation from components. The documentation is stored into the "documentation" component directory in Markdown format, saved as documentname.language.txt (like create_article.en.txt). To make this useful we need to figure out some things: 1) The whole midcom_admin_help thing needs to be documented into the component authoring guide 2) We need to handle potentially needed screenshots/images in component's static dir 3) It would be great to synchronize the documents between Midgard wiki and the components themselves. The material needs to be also visible on-site Ideas? /Bergie -- Henri Bergius Consultant Partner, Nemein henri.bergius-ZpG/[email protected] Midgard CMS www.midgard-project.org