wiki:TracWikiToPdfPlugin

Version 43 (modified by rjollos, 9 months ago) (diff)

Fix attachment link after upgrade to Trac 1.0

Create PDFs from wiki pages

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 license 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)]], although this may be okay following [11471], please report in #4043 whether this works for you now.
 - 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:

tracwikitopdfplugin/0.11/docs/example-documentation.pdf

Single page:

tracwikitopdfplugin/0.11/docs/example-howto.pdf

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.

If you have any issues, create a new ticket.

Recent Changes

[13441] by jun66j5 on 2013-11-22 14:36:42
TracWikiToPdfPlugin: ported to genshi template from clearsilver (fixed #6243)
[11777] by rjollos on 2012-07-25 09:46:39
Added setup.cfg.
[11507] by rjollos on 2012-04-20 06:07:48

Refs #4043, #6243:

  • Removed some needed imports in [11469].
  • When wiki page is created from the Admin panel, the page variables in not passed as a argument in the request. We'll have to find some other way to get it.

Author/Contributors

Author: Diorgenes Felipe Grzesiuk
Maintainer: Diorgenes Felipe Grzesiuk
Contributors:

  • Edney Matias da Silva (edneymatias@gmail.com)
  • Holger Lehmann (holger.lehmann@…)
  • Jcole (jcole@…)

Attachments (2)

Download all attachments as: .zip