BOOST WIKI | Boost Documentation Format | RecentChanges | Preferences | Page List | Links List
The following requirements have so far been stated for a possible documentation system for boost:
- Should be available for UNIX, MacOS? (X only?) and Windows (without having to install POSIX emulation layers). Possibly other platforms?
- Should allow for transformation to many other formats, e.g. HTML, LaTeX? and PDF.
- Must be able to represent documents in other languages than English (to support translation efforts).
- Must support arbitrary character sets, preferably Unicode.
- Must be possible to add hyperlinks between documents.
- Should be possible to express mathematical formulas
- Should be customizable (e.g. macros / substitutions)
- The source format should be easy to write and read
- Should be easy to learn (that's the only way to get people to actually write documentation)
- Should have freely available, well-written and complete reference documentation on the typesetting language and tutorials on how to use it.
- Graphical editing front-ends should be available for major platforms.
- (jdy) I disagree with this...content based markup doesn't require graphical editing front-ends. simple programmer's editor is all that is required...the layout is determined by transformation of the source
Disclaimer: This site not officially maintained by Boost Developers