jmbuser


FOSS Projects the FOSS Way

Chronicling the Future of Transparent Development


Previous Entry Share Next Entry
Publican - the "new" Documentation Publisher
jmbuser

I put "new" in quotes in the title because Publican, the documentation publisher, was formerly known as Documentation-Devel inside the Red Hat Documentation Group. As stated below, it has been in use for several years and is enhanced to include additional branding options.

This package goes a long way towards fulfilling my personal desire for "FOSS Docs the FOSS Way". A special "Thank you" goes to Jeff Fearn and the other Red Hat Documentation team members.

Read the announcement in full below:

>From Brian Forte:

Brisbane, Queensland, 2008/02/14 -- Red Hat Engineering Content Services is pleased to announce Publican, a new publishing package.

Publican -- which has been used by Red Hat's Documentation Group for almost two years -- takes DocBook XML input and outputs HTML, plain Unicode text and PDF. This output can be branded with the following brands: Fedora, Red Hat, and JBoss. A default, generic brand is also included. Further brands can be added, either by request, or by direct customisation. (To request an additional brand, submit a bug via <https://bugzilla.redhat.com/>. Submit the bug against the "Red Hat Enterprise Linux" product, and the "publican" component.)

But "make html" and "make pdf" are, perhaps, the least of Publican. What makes Publican worth announcing are "create_book" and "make dist-srpm".

"create_book" does what the command name implies: it creates a directory of the XML files you need to start writing a book or article using DocBook XML as well as a ready-to-roll Makefile for outputting HTML, text and PDF.

"make dist-srpm" takes a book, turns it into a tarball, adds an appropriate specfile and then wraps the whole thing up into a src.rpm. This makes it easy to incorporate documentation into the standard distribution build chain.

Publican is being incorporated into the Fedora tree in the coming days and weeks. To learn more, members of the Publican development and documentation team will be answering questions in #fedora-docs on irc.freenode.net on Thursday 2008/02/14 from 12:00 Australian Eastern Standard Time (2008/02/14 02:00 UTC/GMT; 2008/02/14 IST; 2008/02/13 22:00 American EDT; 2008/02/13 19:00 American PDT).

Thanks to Murray for posting this originally.

As mentioned in the above announcement, the meeting was held as scheduled on 14 February 2008 at 0200 hours UTC. Here is the IRC Log and the IRC Log in HTML.

See this wiki page for more details on Publican, including how to install the interim packages.


You are viewing jmbuser