The mechanism used for documentation is asciidoc. You can find more information here: http://www.methods.co.nz/asciidoc/
You can send plain text files which will be translated into pdf an html. The html will be published on the Phatch website, which might include some advertisements. The pdf version will be a present to anyone who donates. If you contribute documentation, you agree with these conditions
1) Install from the repositories
You need to install these packages:
sudo apt-get install asciidoc docbook-xml docbook-xsl source-highlight
2) Install FOP (for pdf)
To generate pdfs you will need FOP, which unfortunately is not available as a package. Also we need an older version, as the current one is not compatible with the Ubuntu packages. Therefore download fop-0.20.5-bin.zip.
Unzip this folder to where you want, for example /opt/fop
. Make a symbolic link so fop.sh is recognized as a command:
sudo ln -s /opt/fop/fop.sh /usr/local/bin/fop.sh
Add this line to fop.sh so that it can find your java version:
JAVA_HOME=/usr/lib/jvm/java-6-sun
3) Source highlighting
Copy the filter (./examples/source-highlight-filter/source-highlight-filter.conf
) to one of the standard AsciiDoc filter locations typically /etc/asciidoc/filters/
or ~/.asciidoc/filters/
. Unfortunately source highlighting only works with the command asciidoc
and not with a2x
.
© copyright 2007 www.stani.be