2010/2/5 Frank Sundermeyer
On Thursday 04 February 2010 07:52:50 Ciro Iriarte wrote:
Hi,
Damned Gmail editor.... Just a quick question, do we have any framework/tool for book/documentation creation?, i've heard about Publican from RedHat and seems to make a lot easier document creation task than plain Docbook. How is the openSUSE documentation built?
we are using Docbook 4 and a custom Makefile plus a bunch of other command- line tools to build our documentation. The package susedoc contains the complete toolset.
Although it is shipped with opensuse, get the latest version (containing some bugfixes) of sususedoc from a repository located under http://download.opensuse.org/repositories/home:/thomas-schraitle/ (note that the susedoc package has got a _lot_ of dependencies)
To get started, create an environment by calling /usr/bin/susedoc-new.py e.g.:
/usr/bin/susedoc-new.py --bookname="my_book" --language=en \ --docroot /tmp/my_book --dtdname=docbook_45 --root=book \ --with-xinclude
Now copy your Docbook xml files to /tmp/my_book/xml and adjust xml/MAIN.my_book.xml to include your files.
To build the book, issue the following commands from /tmp/my_book:
0. source ENV-my_book
1. make validate (to make sure your xml is well-formatted and validates)
2. make pdf (to build a b/w PDF) or make color-pdf (color PDF) or make html (HTML) or make txt (formatted ASCII) or make epub (E-Book)
See make help for more make options. Documentation is available from the README in your project directory and from /usr/share/susedoc/doc.
If you have got more questions, join the openSUSE doc team on the opensuse-doc mailinglist.
-- Regards Frank
Thanks!! Regards, -- Ciro Iriarte http://cyruspy.wordpress.com -- -- To unsubscribe, e-mail: opensuse+unsubscribe@opensuse.org For additional commands, e-mail: opensuse+help@opensuse.org