Project

General

Profile

Bug #5079

Convert User Manual to LaTex format

Added by ben leinfelder almost 9 years ago. Updated over 6 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
morpho - general
Target version:
Start date:
07/06/2010
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
5079

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.

History

#1 Updated by Matt Jones almost 9 years ago

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

#2 Updated by ben leinfelder almost 9 years ago

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

#3 Updated by ben leinfelder almost 9 years ago

All the sections and images are in.
Changes have been made to reflect 1.8.1 features.
Open for comments, third set of eyes.

#4 Updated by Redmine Admin about 6 years ago

Original Bugzilla ID was 5079

Also available in: Atom PDF