wiki:TracWikiToPdfPlugin

Version 16 (modified by diorgenes, 6 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 bellow) 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.

WikiToPdf also adds support to some wiki formatting that didn't work with CombineWikiPlugin neither PageToPdfPlugin:

 - Tables (||Table||)
 - Images ([[Image(wiki:Page:image.png, 100%)]])
 - 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.10/docs/example-documentation.pdf?format=raw

Single page:

http://trac-hacks.org/browser/tracwikitopdfplugin/0.10/docs/example-howto.pdf?format=raw

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

# titlefile is Html file used to get a cover.
titlefile = /path/to/cover.html

[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 = Sumary
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

Download the zipped source from here.

Source

You can check out TracWikiToPdfPlugin from here using Subversion, or browse the source with Trac.

Bugs/Feature Requests

Existing bugs and feature requests for TracWikiToPdfPlugin are here.

Ticket Summary Owner Type Status Priority Severity
#3218 save selection somehow (like saving reports/queries is possible) diorgenes enhancement closed normal normal
#3278 Doesn't work with 0.11rc2 diorgenes defect closed normal blocker
#3337 0 bytes PDFs on 0.11 diorgenes defect reopened normal critical
#3366 Issues with egg in 0.11 branch and creating egg diorgenes defect closed normal normal
#3404 Images broken for single page PDF's diorgenes defect closed normal major
#3405 colors from tables and code sections not maintained diorgenes enhancement closed normal normal
#3427 Intra-wiki links treated as local OS links by Acrobat Reader diorgenes defect closed normal normal
#3429 Disable border on images diorgenes enhancement closed low trivial
#3465 'NoneType' object has no attribute 'endswith' diorgenes defect reopened normal normal
#3481 Some cleaning and fixing diorgenes defect closed normal normal
#3493 Support for downloading dynamic images through the webserver grigi enhancement closed normal normal
#3590 Error: Macro Image(foo.png) failed diorgenes defect closed normal major
#3599 UnicodeDecodeError: 'ascii' codec can't decode byte 0xe9 in position 219: ordinal not in range(128) diorgenes defect closed normal normal
#3779 No PDF Export - Problem with template_path - probable reason found diorgenes defect new normal normal
#3908 character from non latin symbols show like ??????? bakalovs@… defect closed normal normal
#4043 Linked images in PDF don't work properly diorgenes defect new high major
#4198 incorrect or missing output for code snippets & formulas diorgenes defect closed normal major
#4283 If code block is larger than page left alignment is more readable than a centered one. diorgenes enhancement new normal normal
#4304 Trac crashes when trying to export pages containing attachments diorgenes defect new normal normal
#4316 take all pages with a certain tag diorgenes enhancement new normal normal
#4345 optionally skip toc macro when not inline diorgenes enhancement closed normal normal
#4543 Admin reports error diorgenes defect closed normal normal
#4616 Simplify the creation of multi-page documents grigi enhancement assigned high normal
#4634 runnable Egg for Python 2.5 diorgenes defect closed normal normal
#4689 Please add support for the ScreenshotsPlugin diorgenes enhancement new normal normal
#4690 page breaks: paragraph/headings handling etc. grigi enhancement assigned normal normal
#4696 Cover page issues diorgenes defect closed normal normal
#4747 Missing PS and HTML export diorgenes enhancement closed normal normal
#4834 Getting Write access to TracWikiToPdfPlugin diorgenes task closed normal normal
#4915 Language-specific cover pages diorgenes enhancement new normal normal
#4977 Admin can't add pages to PDF book on IE8 diorgenes defect closed normal normal
#5163 htmldoc needs --jpeg to create usable size pdfs diorgenes defect new normal normal
#5201 Missing __init___.py diorgenes defect closed normal normal
#5311 PDF not exporting images inserted using HTML markup diorgenes defect new normal normal
#5442 Image Download don't work if linked to source instead of wiki diorgenes defect new normal normal
#5453 Image filenames cannot contain whitespace rjollos defect new high normal
#5490 Create a PDF from a Report and Ticket(s) diorgenes enhancement new normal normal
#5854 format=raw stripped by wikitopdf.py breaking source: URLs in wiki Image links diorgenes defect new normal normal
#5855 set width="100%" height="100%" on images diorgenes defect new normal normal
#5856 Image() URLs fail due to lack of ATTACHMENT_VIEW permissions, crashes WikiToPDF diorgenes defect new highest critical
#5864 Pages without titles (such as =TitleName=) cause the generation of a 0 byte PDF in multi-page PDFs diorgenes defect new normal normal
#5883 UTF-8 wiki pages don't work diorgenes defect new high critical
#5915 Cells (e.g. in tables) get messed up diorgenes defect new normal normal
#6182 unable to export static image in pdf (dynamic image works) diorgenes defect closed normal normal
#6243 Switch from ClearSilver to Genshi jun66j5 task closed high blocker
#6588 Option to append wiki page source, date/time, and revision info diorgenes enhancement new normal normal
#6604 Include version info for HTMLDOC in System Information on About page rjollos enhancement new high normal
#6705 Support fetching images from https with certificate file diorgenes enhancement new normal normal
#6966 PDF creation does not work if image macro has no absolute links in it diorgenes defect closed normal normal
#7028 System-wide installation doesn't work rjollos defect closed high normal
#7072 Migration to trac 0.12? rjollos enhancement closed normal normal
#7081 encoding problem diorgenes defect closed normal normal
#7199 Get a "You're using a plugin which requires the Clearsilver template engine and Clearsilver is not installed." when using WikiToPdf diorgenes defect closed normal normal
#9174 Option to put PageTitle at top of pdf for wikitopdf single page diorgenes defect new normal normal
#10102 Question concerning "base_dir" parameter diorgenes enhancement closed normal major
#10103 Question concerning "base_dir" parameter diorgenes enhancement new normal major
#10491 error on trac 1.0 diorgenes defect closed normal normal
#10783 Images not include in PDF diorgenes defect new high blocker
#10836 "AttributeError: hdf" when trying to access wikitopdf admin panel diorgenes defect closed normal blocker
#11359 Plugin works on ClearSilver, Trac now uses Genshi diorgenes enhancement closed normal normal
#11859 [PATCH] Fix plugin for Trac >= v1.0 diorgenes enhancement new normal 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@…)

Attachments (2)

Download all attachments as: .zip