Bug 30 - HTML-ize architecture document
HTML-ize architecture document
Status: RESOLVED INVALID
Product: ns-3
Classification: Unclassified
Component: documentation
pre-release
All All
: P3 minor
Assigned To: Tom Henderson
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2007-05-20 18:41 UTC by Tom Henderson
Modified: 2008-01-14 00:57 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Tom Henderson 2007-05-20 18:41:36 UTC
architecture document does not run cleanly through latex2html.  In particular, \renewcommand is not picking up the italicized ns-3 references, and there is a problem with the includegraphics command, preventing images from being generated.

latex2html is a perl script and is reportedly hard to extend.  A workaround that ns-2 has used is to run the latex sources through a pre-process.pl script, doing necessary conversions, then run the html through a post-process.pl script to tweak the generated html.

I expect that we can do the same for our latex documents, so a starting point would be to clone the pre-process.pl, post-process.pl, and Makefile from ns-2/docs/ and adapt them to ns-3; in particular, figure out what to do with the \ns, \nstwo, and \includegraphics commands in those scripts.
Comment 1 Tom Henderson 2007-06-13 00:27:05 UTC
I have this mostly fixed; the Makefile runs the tex through a perl pre-processing script, then the html is post-processed with another perl script.  These scripts came over from ns-2 and are being customized for ns-3.

There is still some fussiness regarding automatic image conversion, but I will hand convert those for now.
Comment 2 Tom Henderson 2008-01-14 00:57:33 UTC
no longer applicable-- we have moved to doxygen for the manual and to texinfo for the tutorial.