[ANN] Susedoc XML Build Environment

classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

[ANN] Susedoc XML Build Environment

Thomas Schraitle-2
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: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

SPAM: Re: [ANN] Susedoc XML Build Environment

jdd@dodin.org
Thomas Schraitle a écrit :
> Hi,
>
> we like to announce the alpha release of "susedoc", a toolkit the

very interesting. I see a back end for wiki. Is this really
a translator docbook (novdoc) to mediawiki?

if so, may I annouce this on the mediawiki list? it seems a
very valuable tool

thanks
jdd

--
http://www.dodin.net
http://dodin.org/galerie_photo_web/expo/index.html
http://lucien.dodin.net
http://fr.susewiki.org/index.php?title=Gérer_ses_photos
---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: [ANN] Susedoc XML Build Environment

Thomas Schraitle-2
Hi

On Wednesday 11 October 2006 14:04, jdd wrote:
> Thomas Schraitle a écrit :
> >
> > we like to announce the alpha release of "susedoc", a toolkit the
>
> very interesting. I see a back end for wiki. Is this really
> a translator docbook (novdoc) to mediawiki?

Yes it is. :) You can convert (simple) DocBook or Novdoc documents
into a Mediawiki syntax.


> if so, may I annouce this on the mediawiki list? it seems a
> very valuable tool

Yes, if you like. For small chapter it works, but if you have to
convert whole books that's another story. It's a start but don't
expect a miracle. ;)


Tom

--
Thomas Schraitle

----------------------------------------------------------------------
SUSE LINUX GmbH      >o)   Documentation Specialist
Maxfeldstrasse 5     /\\    
90409 Nuernberg     _\_v   http://en.opensuse.org/Documentation_Team
---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

SPAM: Re: [ANN] Susedoc XML Build Environment

jdd@dodin.org
Thomas Schraitle a écrit :

> Yes, if you like. For small chapter it works, but if you have to
> convert whole books that's another story. It's a start but don't
> expect a miracle. ;)

of course :-)

jdd


--
http://www.dodin.net
http://dodin.org/galerie_photo_web/expo/index.html
http://lucien.dodin.net
http://fr.susewiki.org/index.php?title=Gérer_ses_photos
---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

SPAM: Re: [ANN] Susedoc XML Build Environment

Sean Wheller
In reply to this post by Thomas Schraitle-2
On Wednesday 11 October 2006 13:49, Thomas Schraitle wrote:
> fop or xep

The package is dependant on fop. What does one do when one does manual
installations of FOP :-)

--
Ask me about the Monkey.

Sean Wheller
Technical Author
[hidden email]
+27-84-854-9408
http://www.inwords.co.za
---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: SPAM: Re: [ANN] Susedoc XML Build Environment

Thomas Schraitle-2
Hi,

On Wednesday 11 October 2006 19:52, Sean Wheller wrote:
> On Wednesday 11 October 2006 13:49, Thomas Schraitle wrote:
> > fop or xep
>
> The package is dependant on fop. What does one do when one does
> manual installations of FOP :-)

That's an interesting question. You probably mean, if you want to use
FOP from trunk, right?

The RPM requires FOP from our distribution, which is 0.20.5, if I
remember correctly. You have to install this package due to the
package requirements. To use a different formatter, for example the
latest from FOP trunk, add the following line at the end to your ENV
file:

export FOP=PATH_TO_FOP

Replace PATH_TO_FOP to your executable from trunk. Hope this helps.


Tom

--
Thomas Schraitle

----------------------------------------------------------------------
SUSE LINUX GmbH      >o)   Documentation Specialist
Maxfeldstrasse 5     /\\    
90409 Nuernberg     _\_v   http://en.opensuse.org/Documentation_Team
---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: SPAM: Re: [ANN] Susedoc XML Build Environment

Sean Wheller
On Thursday 12 October 2006 08:05, Thomas Schraitle wrote:

> On Wednesday 11 October 2006 19:52, Sean Wheller wrote:
> > On Wednesday 11 October 2006 13:49, Thomas Schraitle wrote:
> > > fop or xep
> >
> > The package is dependant on fop. What does one do when one does
> > manual installations of FOP :-)
>
> That's an interesting question. You probably mean, if you want to use
> FOP from trunk, right?
>
> The RPM requires FOP from our distribution, which is 0.20.5, if I
> remember correctly. You have to install this package due to the
> package requirements. To use a different formatter, for example the
> latest from FOP trunk, add the following line at the end to your ENV
> file:
>
> export FOP=PATH_TO_FOP
>
> Replace PATH_TO_FOP to your executable from trunk. Hope this helps.

OK, I understand. I don't use the package system to configure fop. So I use
the CLASSPATH installation method.

echo $CLASSPATH
/usr/share/saxon/saxon.jar:/usr/share/xml/docbook/stylesheet/nwalsh/current/extensions/saxon653.jar:/usr/share/fop/build/fop.jar:/usr/share/fop/lib/batik.jar:/usr/share/fop/lib/xalan-2.4.1.jar:/usr/share/fop/lib/xercesImpl-2.2.1.jar:/usr/share/fop/lib/JimiProClasses.jar:/usr/share/fop/lib/avalon-framework-cvs-20020806.jar:/usr/share/fop/lib/jai_core.jar:/usr/share/fop/lib/jai_codec.jar

I will just make changes to suse-doc to suite.

Thanks,

--
Ask me about the Monkey.

Sean Wheller
Technical Author
[hidden email]
+27-84-854-9408
http://www.inwords.co.za
---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]