Re: Confirmation of online doc

Hi Paul,

Thanks for your interest in editing the coding conventions and converting them to the wiki format!

Yes, you got it right! The tendency was to move the general docs from the bzr tree to the trac wiki. The reason for that is my previous experience with updating the docs in the html files:
- even for the smallest things (e.g. typos) I had to create commit a new bzr revision
- to keep doc.calitko.org up to date I had to rebuild the complete Doxygen docs and upload them to the web server

With trac and its wiki things got much more easier - everybody could change the docs at any time and the changes were visible right away. I was thinking about creating a download version of the wiki docs and I think that is doable with a little python coding. There exist trac plugins that convert the wiki content to .tex or .pdf but that seemed to work only on a per wiki page basis. We could extend the existing plugins to generate a .pdf file for a bunch of wiki pages I guess.

In the future it may be possible to consolidate docs, mailing lists, blogs under a single trac using a number of plugins, but that is not high priority right now.

The “Edit this page” link on the local pages sounds interesting and I think we could do this with a trac plugin that converts the wiki pages to html files. I’d suggest though that we first concentrate on moving all general docs to trac’s wiki, remove them from the Doxygen docs and then see how we could provide offline versions for download.

I think it would be a good idea to organize the wiki pages hierarchically like this:

Manuals/CodingConventions - main Coding Conventions page
Manuals/CodingConventions/CodeOrganization - subpage on Code Organization into packages
Manuals/CodingConventions/… and so on
Actually Manuals/CompilationWarnings could be moved under Manuals/CodingConventions/ too.

Trac doesn’t seem to support very well this kind of hierarchical pages but I think we could extend the TOC or PageOutline macros to automatically create a link to the parent page, so that we have a way to go one level up the hierarchy.

Best regards,

Peter

Would you like to post a relpy?


This post is a reply to:
Confirmation of online doc “roadmap”
Hi. I (newly registered "developer") am looking for confirmation in the direction of the online doc. It appears that the general developer documentation (as supposed to the happily doxygen-ated package-specific (more...)

Follow-ups:
Re: Confirmation of online doc
| I think we could extend the TOC or PageOutline macros to automatically create a link to the parent page, so that we have a way to go one level (more...)