[[PageOutline(2-5,Contents,pullout)]]

= Create PDFs from wiki pages

== Description

This plugin allows you to set up a template file to generate a PDF file with a cover and a license page, for example. At the end of each wiki page there is a link named !WikiToPdf and takes into account the parameters in 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. This feature also takes into account the parameters in trac.ini.

For now, only those users with the `WIKI_ADMIN` permission can combine wiki pages on one single file. It is 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:

{{{
 - 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 }}})
}}}

'''Note:''' If you want to use a cover file, it must be encoded in Latin-1 (ISO-8859-1), otherwise the plugin will fail to use it!

This plugin was developed based on the work of [wiki:coderanger] and [wiki:athomas]. It combines the functionality of CombineWikiPlugin and PageToPdfPlugin, both of which are deprecated. See also TracWikiPrintPlugin.

== Bugs/Feature Requests

Existing bugs and feature requests for TracWikiToPdfPlugin are 
[query:status!=closed&component=TracWikiToPdfPlugin&order=priority here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=TracWikiToPdfPlugin&owner=diorgenes new ticket].

[[TicketQuery(component=TracWikiToPdfPlugin&group=type,format=progress)]]

== Download and Source

Download the [download:tracwikitopdfplugin zipped source], check out [/svn/tracwikitopdfplugin using Subversion], or [source:tracwikitopdfplugin browse the source] with Trac.

== Prerequisites

To use !WikitoPdf plugin you need to install [https://www.msweet.org/projects.php?Z1 Htmldoc], which itself is GPL-licensed.

== Screenshots

'''Combining wiki pages:'''

[export:/tracwikitopdfplugin/0.11/docs/example-documentation.pdf]

[[Image(wiki:TracWikiToPdfPlugin:wikitopdf-admin.png,70%)]]

'''Single page:'''

[export:/tracwikitopdfplugin/0.11/docs/example-howto.pdf]

[[Image(wiki:TracWikiToPdfPlugin:wikitopdf-page.png,70%)]]

== Usage

 * [wiki:TracWikiToPdfPlugin/Doc0.10 0.10 Manual]
 * [wiki:TracWikiToPdfPlugin/Doc0.11 0.11 Manual]

== Recent Changes

[[ChangeLog(tracwikitopdfplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:diorgenes Diorgenes Felipe Grzesiuk] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''
 * jun66j5
 * rjollos
 * Edney Matias da Silva (edneymatias@gmail.com)
 * Holger Lehmann (holger.lehmann@catworkx.de)
 * Jcole (jcole@carinatek.com)