Mailinglist Archive: opensuse-doc (40 mails)

< Previous Next >
[opensuse-doc] [ANN] Susedoc XML Build Environment
  • From: Thomas Schraitle <thomas.schraitle@xxxxxxx>
  • Date: Wed, 11 Oct 2006 13:49:30 +0200
  • Message-id: <200610111349.31264.thomas.schraitle@xxxxxxx>
Hi,

we like to announce the alpha release of "susedoc", a toolkit the
SUSE doc team develops and uses to build the SUSE documentation,
released under the GPL. The RPM package contains makefiles and
stylesheets for HTML, XSL-FO and Wiki. See

10.0
http://software.opensuse.org/download/home:/thomas-schraitle/SUSE_Linux_10.0/noarch/susedoc-4.2_20061011-5.1.noarch.rpm

10.1
http://software.opensuse.org/download/home:/thomas-schraitle/SUSE_Linux_10.1/noarch/susedoc-4.2_20061011-5.1.noarch.rpm


1. Features
-----------------------------------------------

* Validates your XML sources

* Contains Python script to create a working sandbox with all
necessary files.

* Creates HTML, PDF and Wiki with a simple make command

* Supports handling of conditional text in XML (aka "profiling")

* Supports XEP, FOP planned


2. Requirements
-----------------------------------------------

* libxml2, libxslt
* inkscape
* transfig
* ImageMagick
* java
* xml-commons-resolver
* docbook-xsl-stylesheets
* svg-dtd
* freefont
* fop or xep


3. Restrictions
-----------------------------------------------

* At the moment you can not build PDFs with our customized stylesheets
due to restrictions on the FOP side (we use XEP.). However, it is
possible to use the original DocBook XSLT stylesheets.

* Wiki stylesheets are a "work in progress". Small chapters or
articles should work but whole books needs more work.

* Documentation can be improved. ;)


4. Quickstart
-----------------------------------------------

With the help of susedoc-new.py after installation you can create
a "Hello World" sandbox where you can play with, for example:

$ susedoc-new.py -d docbook_44

This creates a directory "susedoc-xmltest" where you can find all the
needed files. To create HTML, run "make html". For more information,
see "susedoc-xmltest/README" or use "make help".


For the next weeks I am on vacation. If you have questions please
contact Frank Sundermeyer. :)


Have fun!
Tom


--
Thomas Schraitle

----------------------------------------------------------------------
SUSE LINUX GmbH >o) Documentation Specialist
Maxfeldstrasse 5 /\\
90409 Nuernberg _\_v http://en.opensuse.org/Documentation_Team
---------------------------------------------------------------------
To unsubscribe, e-mail: opensuse-doc+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-doc+help@xxxxxxxxxxxx

< Previous Next >
List Navigation
Follow Ups