Trac WikiToPDF

Description

WikiToPdf was developed based on the work of coderanger and athomas. WikiToPdf combines the functionality of CombineWikiPlugin and PageToPdfPlugin on only one plugin and allows one to setup a template file used to generate the PDF file with a cover and a licence page, for example. See also TracWikiPrintPlugin.

At the end of each wiki page there is a link named WikiToPdf and works like athomas PageToPdfPlugin plugin but takes into account the parameters on trac.ini (see below) and passes them to htmldoc.

Alternatively, it's possible to select one or more wiki pages and generate one single PDF file just like coderanger work with a cover and a licence from a template file. This feature also takes into account the parameters on trac.ini.

For now, only those users with WIKI_ADMIN permission can combine wiki pages on one single file. It's possible to define values to title, subtitle, file version and date that are used on the PDF file (the placeholders in the HTML file must be #TITLE#, #SUBJECT#, #VERSAO# and #DATA#).

WikiToPdf also adds support to some wiki formatting that didn't work with CombineWikiPlugin neither PageToPdfPlugin:

 - Tables (||Table||)
 - Images ([[Image(wiki:Page:image.png)]])  Attention - don't use this format [[Image(image.png)]]
 - Code blocks ({{{ code }}})

ATTENTION: If you want to use a cover file, take care it is encoded in Latin-1 (ISO-8859-1) - otherwise the plugin will fail to use it!

Prerequisites

To use WikitoPdf plugin you need to install Htmldoc (http://www.htmldoc.org).

Screenshots

Combining wiki pages:

http://trac-hacks.org/browser/tracwikitopdfplugin/0.11/docs/example-documentation.pdf?format=raw

Single page:

http://trac-hacks.org/browser/tracwikitopdfplugin/0.11/docs/example-howto.pdf?format=raw

Usage

Download and Source

Download the zipped source, check out using Subversion, or browse the source with Trac.

Bugs/Feature Requests

Existing bugs and feature requests for TracWikiToPdfPlugin are here.

#3337
0 bytes PDFs on 0.11
#3465
'NoneType' object has no attribute 'endswith'
#3779
No PDF Export - Problem with template_path - probable reason found
#4043
Linked images in PDF don't work properly
#4283
If code block is larger than page left alignment is more readable than a centered one.
#4304
Trac crashes when trying to export pages containing attachments
#4316
take all pages with a certain tag
#4616
Simplify the creation of multi-page documents
#4689
Please add support for the ScreenshotsPlugin
#4690
page breaks: paragraph/headings handling etc.
#4915
Language-specific cover pages
#5163
htmldoc needs --jpeg to create usable size pdfs
#5311
PDF not exporting images
#5442
Image Download don't work if linked to source instead of wiki
#5453
Image filenames cannot contain whitespace

If you have any issues, create a new ticket.

Recent Changes

[5674] by grigi on 05/06/09 09:49:24

Added fix from #4977

[5673] by grigi on 05/06/09 09:43:22

Applied #4616 patch to 0.10 version of the plugin - not supported

[5578] by grigi on 04/23/09 15:13:58

Applied patches from #4696 and #4747

[5577] by grigi on 04/23/09 10:32:17

Added patch from #3493

Author/Contributors

Author: Diorgenes Felipe Grzesiuk

Contributors:

  • Edney Matias da Silva (edney@prognus.com.br)
  • Holger Lehmann (holger.lehmann@catworkx.de)
  • Jcole (jcole@carinatek.com)

Attachments