Rockbox.org home
release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Rockbox mail archive

Subject: Manual writers: HTML building works.

Manual writers: HTML building works.

From: Dominik Riebeling <dominik.riebeling_at_gmail.com>
Date: Thu, 20 Jul 2006 20:22:47 +0200

Hi devs,

finally we can build a html version of the manual. You need tex4ht
installed (http://www.cse.ohio-state.edu/~gurari/TeX4ht/mn.html, most
linux distributions should have packages for this). Also, as the make
process changed a bit you need to reconfigure your manual build.
Afterwards you have the following targets when configured to build the
manual:
- manual: like it previously did this builds the pdf manual
- manual-pdf: like above
- manual-html: builds the html version of the manual and puts it in a
subfolder "html". Currently this is split up into separate files on
each chapter. Building a single file version is possible but I simply
haven't added this yet.
- manual-zip: builds the html manual and compresses it to a zip file.

The html version isn't perfect yet, especially the config file options
table in the appendix fails, so I've just disabled it for the html
version for now (it seems to fail on the booktabs). Also, IMO we
should adjust the stylesheet for the manual a bit to make it somewhat
nicer some time later. This can be (at least partly, but I haven't
looked into that further) achieved through configuration files for
tex4ht.

I'm not too much used to make, so I guess there is still room for
improvements on the Makefile changes I made. At least I hope it didn't
break anything (as it worked for me ;-)

 - Dominik
Received on 2006-07-20


Page was last modified "Jan 10 2012" The Rockbox Crew
aaa