Publican: Difference between revisions

>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).

----

Kind Regards,

Murray.

@@ Line 1: / Line 1: @@
+{{old}}
 This page serves as a central location for all things related to Publican.  Publican was formerly known as Documentation-Devel.
-{{admon/note | Official Publican site | The official Publican site is located at http://fedorahosted.org/publican.}}
 == Public Announcement ==
@@ Line 75: / Line 75: @@
 Publican is available in the official Fedora repositories.  To install it with user documentation, run this command:
 <pre>
-yum install publican-doc publican-fedora
+dnf install publican-doc publican-fedora
 </pre>
 == Publican on Fedora Tips and Tweaks ==
-If you're running Fedora, you'll need to do a little tweaking to get Publican working properly.
+When running Fedora you may need to do a little tweaking to get Publican working properly.
-=== Brand issues ===
+=== Recent localizations ===
+Publican 0.44 does not support languages that are written right-to-left (like Arabic, Hebrew, and Persian), and does not contain recent localisations of the "Common Content" sections. Delete your '''/usr/share/publican/Common_Content/common''' directory and replace it with the version contained in [http://rlandmann.fedorapeople.org/publican_common_content.tar.gz this archive] <font color="red">'''Updated 4 September 2009'''</font>.
-The only Publican brand packages available in the Fedora repository are for Fedora and oVirt. If you want to build Red Hat- or JBoss-branded documents, you will need their respective brand packages. Download and install the Red Hat Enterprise Linux 5 packages — [http://download.devel.redhat.com/brewroot/packages/publican-redhat/0.19/0.el5/noarch/publican-redhat-0.19-0.el5.noarch.rpm publican-redhat] and [http://download.devel.redhat.com/brewroot/packages/publican-jboss/0.19/0.el5/noarch/publican-jboss-0.19-0.el5.noarch.rpm publican-jboss].
-The publican-fedora brand package contains an incorrect graphic, does not support languages that are written right-to-left (like Arabic, Hebrew, and Persian), and does not contain recent localisations of the "Common Content" sections. Delete your '''/usr/share/publican/Common_Content/common''' and '''/usr/share/publican/Common_Content/fedora''' directories and replace them with the versions contained in [http://rlandmann.fedorapeople.org/publican_common_content.tar.gz this archive]. This fixes [https://bugzilla.redhat.com/show_bug.cgi?id=492041 BZ#492041] and issues like [https://bugzilla.redhat.com/show_bug.cgi?id=442642 BZ#442642].
 === Building PDFs ===
+This issue affects Publican 0.44 (the current version in Fedora) and Publican 0.45 (the current version if you build from source) ([https://bugzilla.redhat.com/show_bug.cgi?id=492689 BZ# 492689])<br>
-- [https://bugzilla.redhat.com/show_bug.cgi?id=492689 BZ# 492689] This issue affects Publican 0.44 (the current version in Fedora) and Publican 0.45 (the current version in Red Hat Enterprise Linux, if installed on Fedora).
+'''Symptom''' — If you build a PDF of a document that contains a table or informaltable, the PDF will build correctly up to the point where the first table occurs and then stop. The result will be a perfectly valid PDF, but with all content from the first table onwards missing.<br>
-'''Symptom''' — If you build a PDF of a document that contains a <table> or <informaltable>, the PDF will build correctly up to the point where the first table occurs and then stop. The result will be a perfectly valid PDF, but with all content from the first table onwards missing. '''Fix''' — Download and install [http://rlandmann.fedorapeople.org/xslthl-2.0.0-1.fc11.noarch.rpm xslthl]
+'''Fix''' — Download and install [http://rlandmann.fedorapeople.org/xslthl-2.0.0-1.fc11.noarch.rpm xslthl]
 === Building books in languages other than English ===
+This issue appears every time that you install or update Publican on Fedora 11 or any previous version of Fedora that has had updates applied to it. ([https://bugzilla.redhat.com/show_bug.cgi?id=492673 BZ# 492673])<br>
-[https://bugzilla.redhat.com/show_bug.cgi?id=492673 BZ# 492673] - This issue appears every time that you install or update Publican on Fedora 11 or any previous version of Fedora that has had updates applied to it.
+'''Symptom''' — If you build a book in any format in any language other than en-US, the "Document Conventions" section in the preface appears partially in the language that you specified, and partially in English.<br>
-'''Symptom''' — If you build a book in any format in any language other than en-US, the "Document Conventions" section in the preface appears partially in the language that you specified, and partially in English.
 '''Fix''' — Delete your '''/usr/share/publican/Common_Content/common''' directory and replace it with the Common_Content/common directory contained in [http://rlandmann.fedorapeople.org/publican_common_content.tar.gz this archive].
 === Building PDFs in Chinese Simplified ===
+This issue affects Fedora 11, Fedora 10, and any previous version of Fedora that has had updates applied to it.([https://bugzilla.redhat.com/show_bug.cgi?id=509044 BZ# 509044])<br>
-[https://bugzilla.redhat.com/show_bug.cgi?id=509044 BZ# 509044] This issue affects Fedora 11, Fedora 10, and any previous version of Fedora that has had updates applied to it.
+'''Symptom''' — If you build a document in PDF in Chinese (Simplified) — zh-CN — the body text appears blank. The PDF contains enough white space to contain the text, but the characters themselves do not appear.<br>
-'''Symptom''' — If you build a document in PDF in Chinese (Simplified) — zh-CN — the body text appears blank. The PDF contains enough white space to contain the text, but the characters themselves do not appear.
+'''Fix''':<br>
-'''Fix'''
+# Download [http://rlandmann.fedorapeople.org/fireflysung-1.3.0.tar.gz this] archive and extract the '''fireflysung.ttf''' font from it.
+# Install the font ('''Kickoff Application Launcher > Computer > System Settings > Font Installer''' in KDE, or copy it into the .fonts directory in your home directory in GNOME).
-Download [http://rlandmann.fedorapeople.org/fireflysung-1.3.0.tar.gz this] archive and extract the '''fireflysung.ttf''' font from it.
+# Replace your '''/usr/share/publican/xsl/pdf.xsl''' file with [http://rlandmann.fedorapeople.org/pdf.xsl this copy].
-Install the font '''(Kickoff Application Launcher > Computer > System Settings > Font Installer''' in KDE, or copy it into the .fonts directory in your home directory in GNOME).
+# Delete the .fop directory from your home directory
-Replace your '''/usr/share/publican/xsl/pdf.xsl''' file with [http://rlandmann.fedorapeople.org/pdf.xsl this copy]
-Delete the .fop directory from your home directory
 === Building PDFs with xml and images in subdirectories ===
+This issue affects Fedora. ([https://bugzilla.redhat.com/show_bug.cgi?id=491782 BZ# 491782])<br>
+'''Symptom''' — If you have .xml files in a subdirectory of en-US and images in a subdirectory of en-US/images publican creates an incorrect path for the included image in the PDF.<br>
+'''Fix''' — Replace your '''/usr/share/publican/xsl/pdf.xsl''' file with [http://rlandmann.fedorapeople.org/pdf.xsl this copy].<br>
-[https://bugzilla.redhat.com/show_bug.cgi?id=491782 BZ# 491782] This issue affects both Fedora and Red Hat Enterprise Linux.
+[[Category:Documentation tools]]
-'''Symptom''' — If you have .xml files in a subdirectory of en-US and images in a subdirectory of en-US/images publican creates an incorrect path for the included image in the PDF.
-'''Fix''' — Replace your '''/usr/share/publican/xsl/pdf.xsl''' file with [http://rlandmann.fedorapeople.org/pdf.xsl this copy].
-[[Category:Publican]][[Category:Docs_Project]]

Search

Publican: Difference between revisions

Latest revision as of 17:46, 22 May 2020

Contents

Public Announcement

Publican List

IRC Log of Publican Meeting

Official Publican Site

Installing Publican

Publican on Fedora Tips and Tweaks

Recent localizations

Building PDFs

Building books in languages other than English

Building PDFs in Chinese Simplified

Building PDFs with xml and images in subdirectories