Bug #5079
closed
Convert User Manual to LaTex format
Added by ben leinfelder over 14 years ago.
Updated almost 12 years ago.
Category:
morpho - general
Description
Jim suggested LaTex could streamline the user manual update process. Images/screenshots would not be embedded in the document and we could easily produce a PDF - all without MS Word. It is also spiffy, it seems.
That's one possibility. An alternate that is quite a lot more readable in its text form is Restructured Text (RST)/Sphinx. We use this for the DataONE documentation, and it works out nicely in its text, html, and pdf forms. Its basically the same idea as LaTex, but quite a lot easier to work with for people unfamiliar with the syntax (RST syntax is generally what one would use to format a text file anyways). Here's an example of RST in DataONE that is being auto-built from our svn copies of the files:
http://mule1.dataone.org/ArchitectureDocs/index.html
Matt
Summary of off-bug activity so far:
-Jim has converted the first section into LaTex from the Word doc. (nicely, I might add!)
-Ben added a task to the ant build for generating a PDF from the LaTex
Resources are in:
morpho/docs/user/latex
All the sections and images are in.
Changes have been made to reflect 1.8.1 features.
Open for comments, third set of eyes.
Original Bugzilla ID was 5079
Also available in: Atom
PDF