Free docbook software for linux

DocBook is an XML/SGML vocabulary that enables you to create document content in a presentation-neutral form that captures the logical structure of the content.
Using the DocBook stylesheets, you can publish DocBook content as HTML pages and PDF files and other formats, including man pages, HTML Help, and JavaHelp.
Enhancements:
- calstblx.dtd, catalog.xml, dbcentx.mod, dbgenent.mod, dbhierx.mod, dbnotnx.mod, dbpoolx.mod, docbook.cat, htmltblx.mod: Updated version number
- docbookx.dtd: DocBook V4.5CR1 Released
- freshmeat.xsl: Tweaked freshmeat changes

Pod::DocBook is a Perl module to convert pod files to DocBook SGML.

SYNOPSIS

use Pod::DocBook;
pod2docbook( [options] );

Converts files from pod format ( see perlpod ) to DocBook format. It can automatically generate indexes (but SGML does this better) and cross-references.

DocBookWiki can display DocBook documents online. Different from the other applications, which convert a DocBook document into HTML first, in order to display it online, DocBookWiki converts it on the fly, so that the format for saving the document will still be XML (DocBook). In order to do this efficiently, DocBookWiki splits it first into chunks, according to chapters, sections etc.
It can also display a list of books, and for each book it can support multiple languages (translations). When the reader is reading a certain section of a book and he changes the language, he will see the same section in the selected language.
DocBookWiki can also be used to edit a DocBook document online, from the web. Editing is done one section at a time, so the editor selects first the section that he wants to edit, and then edits it. He can edit it in several modes: text (like wiki), xml (the original format), html, latex, texi, etc., whichever is more suitable for him. The changes, however, are always saved in the XML(DocBook) format. Authentication of the editors (with username, password) can be enabled as well, if necessary. Also, different editing permissions can be assigned to editors.
It allows the viewers of a document to download the document in other formats, like PDF, RTF, Plain HTML, LaTeX, PS, etc. which can be generated automatically from the DocBook format.
DocBookWiki will also try to keep a history of all the modifications made to the document, by keeping the document chunks in CVS, and so keeping track of all the changes.
Main features:
- Can display a DocBook document online.
- Can display several documents at once (a list of books).
- Can display each of them in several languages.
- Allows to edit a certain section of a certain book in a certain language.
- Editing can be done in several modes, like text, html, xml, texi, latex etc.
- The basic format is always DocBook (XML), no matter how it is displayed or edited.
- Each document (in each language) can be converted automatically into other formats (like PDF, RTF, LaTeX, etc.) for downloading.
- All the history of modifications is kept (in CVS) and any previous versions of a document can be recovered (by tag or by date) by the admin of the site.
- Authentication of editors can be enabled and admin can assign different access rights and permissions to the editors.

docbooktoc.xsl is a XSLT file for generating a XHTML table of contents from DocBook XML documents. It is used by the LayManSys project for the documentation.

Parameters

docbooktoc accepts the following parameters:

ext

The names of linked files are determined from the chapters id, which does not contain a filename suffix. This (string) parameter tells docbooktoc the suffix to use. Its default value is html.

style.sheet

This (string) parameter may contain stylesheets for styling the output document. You can pass more than one stylesheet by delimiting their filenames with a white-space (space, tab or newline).

style.type

This (string) parameter contains the MIME type used for content stylesheets. It defaults to text/css.

Program output

docbooktoc generates a XHTML document containing the books meta information (in DocBook XML, this is the subnode bookinfo and than lists all of the books chapters and section in an ordered list. The meta information are both used for generating the < head > as well as the documents header (in the XHTML < body >) and the output is the same like the DocBook XSLT driver for XHTML generates.

The books chapters and sections are presented as a n ordered, nested list, where the chapters are top level items, that contain lists of sections, where a section item again may contain a list of subsections.

You can use the Makefile distributed in this package and the LayManSys documentation for generating the example file toc.html. The make command for this is make test.

Simple DocBook Processor project reads a DocBook XML file, processes it into typeset pages, and outputs the result as PostScript (which can easily be converted to a PDF).
It is "simple" because it supports only a subset of DocBook, and also because it does not make use of a DTD or stylesheets or any other heavyweight apparatus. Simple DocBook Processor is a single program. SDoP is used to format the Exim reference manual.
Enhancements:
- A lot of new processing parameters have been added to make it possible to change the output formatting in many ways.

DocBook XSL Configurator consists of a Java GUI used to create DocBook XSL FO customization layers.

Users click through tables, select parameters they want to include, edit those parameters, include the customization layer in a project, write out the customization layer as an XSL file, and apply the XSL to the projects DocBook XML using the projects specified XSLT processor.

DocBook XSL Configurator then runs a projects specified FO processor and PDF/PostScript viewer as external subprocesses.

DocBook XSL Configurator version 0.5.4_1672 requires a JVM compatible with Suns JVM version 1.5 or later (generic subtyping).

GDOC is a C Documentation Tool.
Main features:
- Keeps software and manual in sync.
- Improves source code readability by having extensive comments available directly.
- Improves manual as developers will more likely update the comments when they change source code.
- Support several output formats, such as Texinfo, MAN, DocBook, Doxygen, GTK-DOC tools, LaTeX, HTML.
- Only perl is required, and only for the developers (end-users do not need to have perl installed).
Then start to comment your source code. See the comments in gdoc for the full story, but here is an example:
/**
- stringprep_utf8_to_locale:
- @str: input zero terminated string.
*
- Convert string encoded in UTF-8 into the locales character set by
- using stringprep_convert().
*
- Return value: Returns newly allocated zero-terminated string which
- is @str transcoded into the locales character set.
**/
char *
stringprep_utf8_to_locale (const char *str)
{
return stringprep_convert (str, stringprep_locale_charset (), "UTF-8");
}
You can then extract Man pages, Texinfo fragments, etc, using gdoc as follows:
$ gdoc -texinfo file.c
@deftypefun {char *} {stringprep_utf8_to_locale} (const char * @var{str})
@var{str}: input zero terminated string.
Convert string encoded in UTF-8 into the locales character set by
using @code{stringprep_convert()}.
@strong{Return value:} Returns newly allocated zero-terminated string which
is @code{str} transcoded into the locales character set.
@end deftypefun
$
To simplify generating Texinfo fragments or Man pages for your entire project -- which might contain many files, each contain many functions, that would result in lots of boring Makefile rules to keep track of -- I use a Automake include file to simplify matters.
Enhancements:
- added -texinfo, -listfunc
- man page revamp
- various improvements

Docbkx Maven Plugin project provides a number of tools for supporting DocBook in a Maven environment. This may seem odd to you, since
1) Maven 2 is supposed to support DocBook natively, relying on Doxia, and
2) there is already another DocBook plugin at mojo.codehaus.org.
The thruth however is that DocBook support in Doxia is fairly limited, mainly because Doxia as a framework supports only a small fraction of the concepts found in DocBook. The subset of DocBook supported by Doxia is not even close to simplified DocBook.
The DocBook plugin at mojo.codehaus.org is supporting a wider range of DocBook markup, and is in fact more similar to the DocBook tools provided with this project. There are however some significant differences:
- The focus is on ease of use.
- You should not be required to install additional stuff to your hard disk in order to generate content from your DocBook sources. Simply adding a reference to the plugin in your POM should be sufficient.
- This project focuses on providing dedicated support for particular DocBook XSL stylesheet distributions. That means you can rely on the dedicated parameterization mechanism of Maven Plugins to pass in the XSLT parameters defined for a particular version and type of XSLT stylesheet.
- In the DocBook Plugin found at mojo.codehaus.org, you will be required to download a specific version of the DocBook XSL stylesheets manually. The plugins packaged contain the stylesheets as well. (In this project, a particular version of the stylesheets is closely tied to a particular version of the plugin. That you means you can always rely on the plugins documentation to know which parameters you could pass in.)
- The DocBook plugin found at mojo.codehaus.org requires you to have access to the Internet in order allow the plugin to resolve URIs. The plugins provided in this project act differently: if your DocBook sources are referening to a DTD, then you can simply add a dependency to a jar file containing the DTD and related entities, and the plugin will make sure that all references will be resolved correctly.
Enhancements:
- Support for Eclipse help files was added.