wiki:TracWikiToPdfPlugin

Version 32 (modified by Nickolas Grigoriadis, 8 years ago) (diff)

--

Trac WikiToPDF

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

Ticket Summary Status Owner Type Priority Severity
#3337 0 bytes PDFs on 0.11 reopened Diorgenes Felipe Grzesiuk defect normal critical
#3465 'NoneType' object has no attribute 'endswith' reopened Diorgenes Felipe Grzesiuk defect normal normal
#3779 No PDF Export - Problem with template_path - probable reason found new Diorgenes Felipe Grzesiuk defect normal normal
#4043 Linked images in PDF don't work properly new Diorgenes Felipe Grzesiuk defect high major
#4283 If code block is larger than page left alignment is more readable than a centered one. new Diorgenes Felipe Grzesiuk enhancement normal normal
#4304 Trac crashes when trying to export pages containing attachments new Diorgenes Felipe Grzesiuk defect normal normal
#4316 take all pages with a certain tag new Diorgenes Felipe Grzesiuk enhancement normal normal
#4616 Simplify the creation of multi-page documents assigned Nickolas Grigoriadis enhancement high normal
#4689 Please add support for the ScreenshotsPlugin new Diorgenes Felipe Grzesiuk enhancement normal normal
#4690 page breaks: paragraph/headings handling etc. assigned Nickolas Grigoriadis enhancement normal normal
#4915 Language-specific cover pages new Diorgenes Felipe Grzesiuk enhancement normal normal
#5163 htmldoc needs --jpeg to create usable size pdfs new Diorgenes Felipe Grzesiuk defect normal normal
#5311 PDF not exporting images inserted using HTML markup new Diorgenes Felipe Grzesiuk defect normal normal
#5442 Image Download don't work if linked to source instead of wiki new Diorgenes Felipe Grzesiuk defect normal normal
#5453 Image filenames cannot contain whitespace new Ryan J Ollos defect high normal
#5490 Create a PDF from a Report and Ticket(s) new Diorgenes Felipe Grzesiuk enhancement normal normal
#5854 format=raw stripped by wikitopdf.py breaking source: URLs in wiki Image links new Diorgenes Felipe Grzesiuk defect normal normal
#5855 set width="100%" height="100%" on images new Diorgenes Felipe Grzesiuk defect normal normal
#5856 Image() URLs fail due to lack of ATTACHMENT_VIEW permissions, crashes WikiToPDF new Diorgenes Felipe Grzesiuk defect highest critical
#5864 Pages without titles (such as =TitleName=) cause the generation of a 0 byte PDF in multi-page PDFs new Diorgenes Felipe Grzesiuk defect normal normal
#5915 Cells (e.g. in tables) get messed up new Diorgenes Felipe Grzesiuk defect normal normal
#6588 Option to append wiki page source, date/time, and revision info new Diorgenes Felipe Grzesiuk enhancement normal normal
#6705 Support fetching images from https with certificate file new Diorgenes Felipe Grzesiuk enhancement normal normal
#9174 Option to put PageTitle at top of pdf for wikitopdf single page new Diorgenes Felipe Grzesiuk defect normal normal
#11859 [PATCH] Fix plugin for Trac >= v1.0 new enhancement normal blocker

If you have any issues, create a new ticket.

Recent Changes

16787 by rjollos on 2017-09-06 21:37:20
TracWikiToPdfPlugin 3.0.0dev: Use subprocess for better error handling

Fixes #13266.

16786 by rjollos on 2017-09-06 20:56:21
TracWikiToPdfPlugin 3.0.0dev: Add charset option for wikitopdf

Fixes #5883.

16785 by rjollos on 2017-09-06 20:42:45
TracWikiToPdfPlugin 3.0.0dev: Fix inclusion of images

The base_dir configuration parameter has been eliminated
and images should be included without any special configuration.

Fixes #10103.

(more)

Author/Contributors

Author: Diorgenes Felipe Grzesiuk

Contributors:

  • Edney Matias da Silva (edney@…)
  • Holger Lehmann (holger.lehmann@…)
  • Jcole (jcole@…)

Attachments (2)

Download all attachments as: .zip