wiki:TracWikiToPdfPlugin

Version 11 (modified by anonymous, 16 years ago) (diff)

--

Trac WikiToPDF

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 licence page, for example.

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 bellow) 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.

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

 - Tables (||Table||)
 - Images ([[Image(wiki:Page:image.png, 100%)]])
 - Code blocks ({{{ code }}})

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.10/docs/example-documentation.pdf?format=raw

Single page:

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

Bugs/Feature Requests

Existing bugs and feature requests for TracWikiToPdfPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from [download:tracwikitopdfplugin here].

Source

You can check out TracWikiToPdfPlugin from here using Subversion, or browse the source with Trac.

Example

Configurations WikiToPDF in file trac.ini, more information about HTMLDOC (http://www.htmldoc.org/htmldoc.html#CMDREF)

[wikitopdf]
base_dir = /path/to/DocumentRoot
titlefile = /path/to/cover.html

[wikitopdf-admin]
size = A4
right = 1.5cm
left = 1.5cm
top = 1.5cm
bottom = 1.5cm
no-links = None
toctitle = Sumary
numbered = None
linkstyle = plain
header = l
footer = .r1
logoimage = /path/to/header-logo.png

[wikitopdf-page]
size = A4
right = 1.5cm
left = 1.5cm
top = 1.5cm
bottom = 1.5cm
no-links = None
linkstyle = plain
header = l
footer = .r1
logoimage = /path/to/header-logo.png

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
Contributors:

Attachments (2)

Download all attachments as: .zip