Novell Home

Lfl/susedoc

From Developer Community

< Back to Lessons for Lizards Home

Contents

What is susedoc?

susedoc is the name of a RPM package from the SUSE Documentation department. It is used to convert DocBook-XML sources into HTML, PDF or Manpages. It consist mainly of Makefiles, stylesheets and orchestrate the tools behind it to fullfil its task.


What are the features of susedoc?

At the moment, susedoc supports the following features:

  • Validates your documents with DocBook DTD or Novdoc DTD (planned: RELAX NG validation)
  • Transforms DocBook-XML into HTML or XSL-FO
  • Creates Manpages
  • Build PDFs with and without cropmarks (only available through XEP)
  • Formats XSL-FO with FOP or XEP
  • Convert your images (for example from SVG to PNG or FIG to PNG)
  • Profiles your XML source, see Conditional Text
  • Archives your XML source and created HTML or PDFs ("make dist")


Additionally, it has some checks to prevent errors:

  • Ok, validation. :)
  • Checks your links in your documentation if they are still accessible and outputs an error report
  • Checks your PDF if all fonts are embedded
  • Spellchecks your document


Where can I download susedoc?

The RPM packages for several SUSE Linux releases can be downloaded from the openSUSE Build Server


What is the license of susedoc?

susedoc is licensed under GPL.

Novell® Making IT Work As One

© 2009 Novell, Inc. All Rights Reserved.