wiki:TracWikiToPdfPlugin

Version 42 (modified by Ryan J Ollos, 11 years ago) (diff)

Changed use of PageOutline to TOC.

Create PDFs from wiki pages

Notice: This plugin is unmaintained and available for adoption.

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:

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 [download:tracwikitopdfplugin 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

17423 by rjollos on 2019-07-30 16:41:28
TracWikiToPdfPlugin 3.0.0dev: Improve debug logging

Refs #13568.

17341 by rjollos on 2019-02-19 03:30:48
TracWikiToPdfPlugin 3.0.0dev: Fix failure of r17340 with subpages

Refs #5856.

17340 by rjollos on 2019-02-18 02:02:15
TracWikiToPdfPlugin 3.0.0dev: Fix failure retrieving images

Retrieving images would fail when anonymous lacked
WIKI_VIEW.

Fixes #5856.

(more)

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