[Lmuse-developer] "Meh, what's up doc?"

[Tim E. R. <ter...@ro...>]

(To quote the infamous Bugs Bunny.)

As requested:

New: Install three kinds of pre-built documentation:
PDF + single/split HMTL docs. 

I separated the developer docs from the user docs. 

Flo, I split the HTML at 'Depth' = 4 and it comes out
 pretty cool looking I think.
Y'all can play around with the depth by changing...

	a handy build *script* which I added. 

The build script is /doc/build_docs.sh You'll likely want to use it 
 or a variant to get the HTML .aux files for proper link display
 instead of little squares.

Er, you will need *both* pdflatex AND latex2html to run the script.

Oops, be careful, it first erases *both* existing PDF and HTML pre-built files.
I should change that to allow a choice...
Feel free to modify that script while I grab some shut-eye for the night.

And I install both the PDF and HTML, via the cmake scripts.
I don't know if an error would occur if either or both were 
 *not* present. I'll look again.

Still, if you /are/ developing docs, you want to test the HTML don't you...

------
Fixed table in my Appendix in tex file so it works with HTML.

Removed all old docs from tree and SVN repo.

For now, I've changed F1 help to open PDF, if not found fallback to HTML.
I've #define MUSE_USE_PDF_HELP_FILE in help.cpp. Undefine for HTML only.
Later, we may at least need to keep track of viewer process 
 (don't open copies), also try context-sensitive help by using a library 
 or Qt HTML features.

The Help opener (F1) has always been LANG ready (looks for _xx) 
 and I've added PDF to that opener now too, but this new build script is 
 not 'automatic' LANG aware, per-se.
Maybe after translating the tex, a person could just rename the generated 
 PDF or HTML files with the _xx extensions.

TODO: The generated HTML developer docs contain some nonsense. 
Unknown formatters? Florian any ideas there? Guys?

Anyway, hope this is a decent start for new docs.
Tim.