FOray Users
Module Users

FOray Dev: Documentation



Documentation is currently maintained using the XHTML 1.0 Strict DTD. Menus are maintained using Apache server-side includes. Formatting is accomplished using CSS stylesheets. Documentation is web-oriented. Content is maintained in the repository at foray/doc/web. A script on the SourceForge server is used to pull the content from the source code repository to the web server. Ideally, we would prefer to use XSLT to generate our xhtml and PDF content, but right now that is less important than having a fairly automated update system.

Generally, every html document should appear on exactly one of the menus, and should have, as its own menu, the menu on which it appears.

When adding, moving, or removing content, be sure to consider the effect on the menus. Also, run the W3C Link Checker to find broken links.