= Trac WikiToPDF = == Description == !WikiToPdf was developed based on the work of [wiki:coderanger] and [wiki: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 [wiki: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 [wiki: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#). '''NEW''': Patch #4616 supports the definition of a document on a wiki page - there is no need any more to enter a title and select all pages each time you want to create a PDF. And better even - any user can do it. The patch is for the Trac 0.10 version of the plugin: just replace the wikitopdf.py with the patched one in #4616 (mvlcek). !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)]] - 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.11/docs/example-documentation.pdf?format=raw [[Image(wiki:TracWikiToPdfPlugin:wikitopdf-admin.png)]] '''Single page:''' http://trac-hacks.org/browser/tracwikitopdfplugin/0.11/docs/example-howto.pdf?format=raw [[Image(wiki:TracWikiToPdfPlugin:wikitopdf-page.png)]] == Example == Configurations WikiToPDF in file ''trac.ini'', more information about HTMLDOC (http://www.htmldoc.org/htmldoc.html#CMDREF) {{{ [components] wikitopdf.* = enabled [wikitopdf] # base_dir is the Apache DocumentRoot, It is need to get PDF files with images. base_dir = /path/to/DocumentRoot # path to folder used to get a cover files. (key corrected from pathtocover to titlefile) titlefile = /path/to/cover # this are parameters functionality PDF links link = http://servername/trac-project folder_name = trac-project [wikitopdf-admin] # HTMLDOC options. See the link above. size = A4 right = 1.5cm left = 1.5cm top = 1.5cm bottom = 1.5cm no-links = None toctitle = Summary numbered = None linkstyle = plain header = l footer = .r1 logoimage = /path/to/header-logo.png [wikitopdf-page] # HTMLDOC options. See the link above. 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 }}} == Download and Source == Download the [download:tracwikitopdfplugin zipped source], check out [/svn/tracwikitopdfplugin using Subversion], or [source:tracwikitopdfplugin browse the source] with Trac. == Bugs/Feature Requests == Existing bugs and feature requests for TracWikiToPdfPlugin are [report:9?COMPONENT=TracWikiToPdfPlugin here]. [[TicketQuery(component=TracWikiToPdfPlugin, table)]] If you have any issues, create a [http://trac-hacks.org/newticket?component=TracWikiToPdfPlugin&owner=diorgenes new ticket]. == Recent Changes == [[ChangeLog(tracwikitopdfplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:diorgenes Diorgenes Felipe Grzesiuk] [[BR]][[BR]] '''Contributors:''' * Edney Matias da Silva (edney@prognus.com.br) * Holger Lehmann (holger.lehmann@catworkx.de) * Jcole (jcole@carinatek.com)