Changes between Initial Version and Version 1 of TracWikiToPdfPlugin/Doc0.11


Ignore:
Timestamp:
May 7, 2009, 1:59:39 PM (6 years ago)
Author:
grigi
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWikiToPdfPlugin/Doc0.11

    v1 v1  
     1[[TOC(TracWikiToPdfPlugin,TracWikiToPdfPlugin/Doc0.10,TracWikiToPdfPlugin/Doc0.11)]]
     2= 0.11 Manual =
     3
     4For 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#).
     5
     6WikiToPdf also adds support to some wiki formatting that didn't work with CombineWikiPlugin neither PageToPdfPlugin:
     7
     8 - Tables (`||Table||`)
     9 - Images (`[[Image(wiki:Page:image.png)]]`)  Attention - don't use this format `[[Image(image.png)]]`
     10 - Code blocks (`{{{ code }}}`)
     11
     12ATTENTION: 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!
     13
     14== CSS Support ==
     15You can get Syntax highlighting when using the experimental HTMLDoc 1.9. [[BR]]
     16Just a note: htmldoc version htmldoc-1.9.x-!r1586 has broken headers/footers, version htmldoc-1.9.x-!r1563 works fine.
     17You only need the unstable 1.9 version if you want syntax highlighting and/or css support.
     18{{{
     19[wikitopdf]
     20css_file = /var/lib/trac/IS/conf/htmldoc.css
     21}}}
     22
     23== Support for Dynamic images ==
     24If you want TracWikiToPdfPlugin to handle dynamically generated images, or any images dome by another plugin you need to configure in the trac.ini file:
     25{{{
     26[wikitopdf]
     27tmp_dir = /tmp/wikitopdf
     28trac_uri = http://trac.blah.is.co.za
     29}}}
     30More information is available at #3493.
     31
     32== Example ==
     33
     34Configurations WikiToPDF in file trac.ini, more information about HTMLDOC (http://www.htmldoc.org/htmldoc.html#CMDREF)
     35{{{
     36[components]
     37wikitopdf.* = enabled
     38
     39[wikitopdf]
     40# base_dir is the Apache DocumentRoot, It is need to get PDF files with images.
     41base_dir = /path/to/DocumentRoot
     42
     43# path to folder used to get a cover files. (key corrected from pathtocover to titlefile)
     44titlefile = /path/to/cover
     45
     46# this are parameters functionality PDF links
     47link = http://servername/trac-project
     48folder_name = trac-project
     49
     50[wikitopdf-admin]
     51# HTMLDOC options. See the link above.
     52size = A4
     53right = 1.5cm
     54left = 1.5cm
     55top = 1.5cm
     56bottom = 1.5cm
     57no-links = None
     58toctitle = Summary
     59numbered = None
     60linkstyle = plain
     61header = l
     62footer = .r1
     63logoimage = /path/to/header-logo.png
     64# jpeg = 90 # only add when the PDF's generated are too large
     65
     66[wikitopdf-page]
     67# HTMLDOC options. See the link above.
     68size = A4
     69right = 1.5cm
     70left = 1.5cm
     71top = 1.5cm
     72bottom = 1.5cm
     73no-links = None
     74linkstyle = plain
     75header = l
     76footer = .r1
     77logoimage = /path/to/header-logo.png
     78# jpeg = 90 # only add when the PDF's generated are too large
     79}}}