documentation
Tyler Smith <[email protected]> Mon, 17 Sep 2007 21:42:50 -0300
| Newsgroups | gmane.comp.tex.latex.latex2rtf.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi,
I've made some changes to the documentation that may warrant some
discussion. I've added, thanks to some built-in features of emacs'
texinfo mode, a detailed table of contents/node listing. This easily
removed if you don't like it. I have also started adding items to the
index. This is easily done with the @cindex tag - just put it on a
line immediately above the paragraph you want to point to and it's
done, for example:
@cindex boogers
This is a line about boogers.
will insert an index entry named 'booger' that will send the reader to
the beginning of the following line. I'll try and make my way through
the text to fix stuff from past editions. It would be helpful if any
new additions include appropriate indices.
The biggest change relates to a ToDo item under Georg's name:
Add a chapter with lists of all LaTeX commands that convert, and
that do not convert to RTF, including their status (for future
releases, never, partially functional, ...).
This sounds like a good idea. To get the ball rolling I've pulled out
all the LaTeX commands in commands.c and put them into a two-column
table in an appendix. It doesn't look like two columns, on account of
the second column being mostly empty. However, I've added some
comments regarding my changes to the geometry, dotfill and
doublespacing commands. Eventually it would be great to have this
table fully populated. The order right now is pretty much just plucked
right out of commands.c. We may want to rearrange it into alphabetical
order, or ordered by general functionality? I can add indexing as well
if it's helpful. I can manage this sort of administration, if people
who know better want to pick away at adding comments about unexpected
behaviours that should be documented. Eventually this could replace
parts of the 'Features' section, which could be trimmed down to a
discussion of general concepts.
Anyways, let me know if this looks like the start of something good,
or a disaster to be remedied as soon as possible.
Cheers,
Tyler
--
Who is your computer working for?
http://www.defectivebydesign.org/faq
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/