[Scummvm-devel] Documentation

[James 'Ender' Brown]

> > Believe it or not, I am actually good at writing proper manuals, coming
> > from my previous incarnation as a tech-writer.
> 
> Great to hear :-)

Of course, I should note that I don't LIKE it *g*

> >  However, my
> > main problem is that I do not know, and at first glance dislike, LaTeX.
> 
> Gah. That's always seems to be your reaction towards tech you don't 
> know :-). No matter, though, while I love LaTeX, I wouldn't have chosen 
> it for this particular task either...

Darn, busted :)

> > Would anyone be willing to accept HTML as the source markup format? It
> > is still easily convertable to text, PDF, Postscript, ectera.
> 
> Are there actually converters which produce nice PDF/PS/Text output 
> from HTML? All the ways I know to convert HTML to PDF in the end are 
> bad and I then prefer to stick to the HTML. Compared to pdflatex 
> output, at least, which is very nice (including such things as a PDF 
> TOC, and hyperlinks, etc., in the PDF). From the sounds of it, you have 
> more experience with using HTML as a base for docs than I, so I hope 
> you can shed some light on this :-)

There are various automated tools which do a good job if given nice
clean HTML. Text output is quite easy - I prefer using w3m's dump
capability. Worst-case scenario is using something like KDE's "print to
PDF" and "print to PS" functionality which produces quite nice output.
Not as optimised as something thrown through specialist programs such
as, for example, Distiller of course.

> > If not, I suppose I could just write it in HTML and then convert it to LaTeX that
> > way.
> That's always possible, of course.

If nobody has any particular objections to using HTML, I would like to
start on it next week.

 - Ender