Bug 76 - new documentation templates needed
: new documentation templates needed
Status: RESOLVED FIXED
: ns-3
documentation
: pre-release
: All All
: P3 normal
Assigned To:
:
:
:
:
  Show dependency treegraph
 
Reported: 2007-09-17 00:51 EDT by
Modified: 2008-01-14 00:59 EDT (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2007-09-17 00:51:55 EDT
The current documentation system is based on Latex with perl-based pre-process
and post-process script, and then relies on latex2html to generate HTML.  This
system was inherited (and tweaked) from the ns-2 manual.

The goal is to write documentation that produces both clean looking PDF and
clean, easily navigable web pages with hyperlinks and styles for pasting in
code.

The current system is fragile in a number of ways, but the main problem is the
HTML that is generated:
- images are not converted correctly when latex2html is run
- latex2html does not know how to handle many Latex environments and also
specialized macros defined for ns-3
- specifying URLs that render correctly in both PDF and HTML is challenging, as
witnessed by this example post from another forum:
http://www.tug.org/pipermail/latex2html/2002-September/002033.html

Two alternatives to consider are GNU Texinfo and Doxygen (using it more than
just for APIs, such as Mathieu's tracing documentation).
------- Comment #1 From 2008-01-14 00:59:40 EDT -------
no longer using latex2html-- using Doxygen and Texinfo