wiki:TracWikiToPdfPlugin

Version 32 (modified by grigi, 5 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 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 defect normal critical
#3465 'NoneType' object has no attribute 'endswith' reopened diorgenes defect normal normal
#3779 No PDF Export - Problem with template_path - probable reason found new diorgenes defect normal normal
#4043 Linked images in PDF don't work properly new diorgenes defect high major
#4283 If code block is larger than page left alignment is more readable than a centered one. new diorgenes enhancement normal normal
#4304 Trac crashes when trying to export pages containing attachments new diorgenes defect normal normal
#4316 take all pages with a certain tag new diorgenes enhancement normal normal
#4616 Simplify the creation of multi-page documents assigned grigi enhancement high normal
#4689 Please add support for the ScreenshotsPlugin new diorgenes enhancement normal normal
#4690 page breaks: paragraph/headings handling etc. assigned grigi enhancement normal normal
#4915 Language-specific cover pages new diorgenes enhancement normal normal
#5163 htmldoc needs --jpeg to create usable size pdfs new diorgenes defect normal normal
#5311 PDF not exporting images inserted using HTML markup new diorgenes defect normal normal
#5442 Image Download don't work if linked to source instead of wiki new diorgenes defect normal normal
#5453 Image filenames cannot contain whitespace new rjollos defect high normal
#5490 Create a PDF from a Report and Ticket(s) new diorgenes enhancement normal normal
#5854 format=raw stripped by wikitopdf.py breaking source: URLs in wiki Image links new diorgenes defect normal normal
#5855 set width="100%" height="100%" on images new diorgenes defect normal normal
#5856 Image() URLs fail due to lack of ATTACHMENT_VIEW permissions, crashes WikiToPDF new diorgenes defect highest critical
#5864 Pages without titles (such as =TitleName=) cause the generation of a 0 byte PDF in multi-page PDFs new diorgenes defect normal normal
#5883 UTF-8 wiki pages don't work new diorgenes defect high critical
#5915 Cells (e.g. in tables) get messed up new diorgenes defect normal normal
#6588 Option to append wiki page source, date/time, and revision info new diorgenes enhancement normal normal
#6604 Include version info for HTMLDOC in System Information on About page new rjollos enhancement high normal
#6705 Support fetching images from https with certificate file new diorgenes enhancement normal normal
#9174 Option to put PageTitle at top of pdf for wikitopdf single page new diorgenes defect normal normal
#10103 Question concerning "base_dir" parameter new diorgenes enhancement normal major
#10783 Images not include in PDF new diorgenes defect high blocker

If you have any issues, create a new ticket.

Recent Changes

[13441] by jun66j5 on 2013-11-22 14:36:42
TracWikiToPdfPlugin: ported to genshi template from clearsilver (fixed #6243)
[11777] by rjollos on 2012-07-25 09:46:39
Added setup.cfg.
[11507] by rjollos on 2012-04-20 06:07:48

Refs #4043, #6243:

  • Removed some needed imports in [11469].
  • When wiki page is created from the Admin panel, the page variables in not passed as a argument in the request. We'll have to find some other way to get it.

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