[[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 from wiki pages in your Trac project. It optionally comes with a cover and a license page. At the bottom of each wiki page there is a link named '''WikiToPdf''' for the generation of the PDF file. It takes into account the parameters in your `trac.ini` file and passes them to htmldoc.

'''Combining wiki pages:'''

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

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

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 your `trac.ini` file.

'''Single page:'''

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

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

Please see the following manuals for older versions of this plugin:

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

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!

See also TracWikiPrintPlugin.

== Bugs/Feature Requests

Existing bugs and feature requests for TracWikiToPdfPlugin are 
[report:9?COMPONENT=TracWikiToPdfPlugin here].

If you have any issues, create a 
[/newticket?component=TracWikiToPdfPlugin new ticket].

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

== Download

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

== Source

You can check out TracWikiToPdfPlugin from [/svn/tracwikitopdfplugin here] using Subversion, or [source:tracwikitopdfplugin browse the source] with Trac.

== Installation

To use this plugin you need to install [https://github.com/michaelrsweet/htmldoc Htmldoc], which itself is GPL-licensed.

Further general instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== 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)