how do we generate a man page?

jnweiger / pdfcompare

compare two PDF files, write a resulting PDF with highlighted changes

GNU General Public License v2.0

54 stars 16 forks source link

how do we generate a man page? #11

Closed jnweiger closed 8 years ago

jnweiger commented 8 years ago

We have man/pdfcompare.xml @tomschr What is the process to generate html, man, or pdf output formats

tomschr commented 8 years ago

@jnweiger Hi Jürgen! :wave:

The easiest way is to apply the standard DocBook XSL stylesheets to your XML file. The following list describes the easiest steps (all executed in the man directory):

Definition:

DB="/usr/share/xml/docbook/stylesheet/nwalsh/current/"

Creating Manpages:

xsltproc $DB/manpages/docbook.xsl pdfcompare.xml

Creating HTML:

xsltproc --output pdfcompare.html $DB/xhtml/docbook.xsl pdfcompare.xml

Creating PDF:

xsltproc --output pdfcompare.fo $DB/fo/docbook.xsl pdfcompare.xml
fop pdfcompare.fo pdfcompare.pdf && rm pdfcompare.fo

Of course, you can do much more, but you know that. :smile:

jnweiger commented 8 years ago

I am a github markdown user, with sphinx and pandoc these days -- forgot most of docbook :cry:

tomschr commented 8 years ago

Actually, to be precise and make it a little bit more platform and distribution neutral, you should replace the first step (definition) with this command:

DB=$(xmlcatalog /etc/xml/catalog http://docbook.sourceforge.net/release/xsl/current)

Of course, this does only work if you have working XML catalogs and the above URI resolves correctly.

jnweiger commented 8 years ago

xmlcatalog /etc/xml/catalog http://docbook.sourceforge.net/release/xsl/current

No entry for SYSTEM http://docbook.sourceforge.net/release/xsl/current No entry for URI http://docbook.sourceforge.net/release/xsl/current

Attached the contents of /etc/xml/catalog on Ubuntu 14.04 cat.zip

tomschr commented 8 years ago

@jnweiger Yes, this can happen if the system doesn't have good catalog support. :cry:

The catalog file in the above ZIP file contains this line:

<delegateSystem systemIdStartString="http://docbook.sourceforge.net/release/xsl/"
        catalog="file:///etc/xml/docbook-xsl.xml"/>

Actually, this would delegate the URI to the /etc/xml/docbook-xsl.xml file. I guess, the entry is missing or they don't have the "current" part (which is only a link to the latest version).

Unfortunately, I can't look into this, I don't have an Ubuntu system ATM.