Changes between Version 43 and Version 44 of TracWikiPrintPlugin


Ignore:
Timestamp:
Dec 15, 2015, 3:15:25 PM (8 years ago)
Author:
figaro
Comment:

Removal of superfluous trac tag, further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracWikiPrintPlugin

    v43 v44  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = !WikiPrint Trac Plugin
     3= Make Trac wiki pages printable
    44
    55== Description
    66
    7 This plugin allows you to make wiki pages easily printable, exporting to '''PDF''' (book or article format) or printable '''HTML''' format (page contents without Trac headers/footers). PDF export is based on pure Python libraries, such as [http://www.xhtml2pdf.com/ xhtml2pdf], instead of depending on external applications.
     7This plugin allows you to make Trac wiki pages easily printable, exporting to '''PDF''' (book or article format) or printable '''HTML''' format (page contents without Trac headers/footers). PDF export is based on pure Python libraries, such as [http://www.xhtml2pdf.com/ xhtml2pdf], instead of depending on external applications.
    88
    99Key features:
     
    5252   * `yum install python-imaging python-reportlab python-html5lib python-pygments pyPdf`
    5353
    54 To install plugin:
     54To install the plugin:
    5555
    5656 * `easy_install https://trac-hacks.org/svn/tracwikiprintplugin/0.11`
     
    8080}}}
    8181
    82 If you're using '''Apache with authentication''', add something like this to your Apache .conf file, so '''local''' resources can be downloaded when creating pdfs (where `your.ip.address` is replaced with the output of `hostname -i`):
     82If you're using '''Apache with authentication''', add something like this to your Apache .conf file, so '''local''' resources can be downloaded when creating pdfs, where `your.ip.address` is to be replaced with the output of `hostname -i`:
    8383
    8484{{{#!apache
     
    128128=== Customizing front page, header, footer, contents
    129129
    130  * '''frontpage_url''': A path or URL to a file with HTML. '''It doesn't have to be a well formed xhtml document, so don't include begin/end tags, body, etc., see the default one''', that will be used as the front page when exporting to ''PDF Book''. Some special tags can be used to insert the title, version, date, etc. See ''Tag Replacement''
     130 * '''frontpage_url''': A path or URL to a file with HTML. '''It doesn't have to be a well formed xhtml document, so don't include begin/end tags, body, etc., see the default one''', that will be used as the front page when exporting to ''PDF Book''. Some special tags can be used to insert the title, version, date, etc. See ''Tag Replacement''.
    131131 * '''extracontent_url''': A path or URL to a file with HTML that will be inserted at the beginning of the document before passing it to to ''xhtml2pdf''. This should be used to define the contents of the '''header''' and '''footer'''. See xhtml2html documentation, and the default article CSS contents and default extra contents for an example.
    132132
    133133=== Authentication
    134134
    135 When using cookie based authentication (like AccountManager), the ''xhtml2pdf'' library is given a temporary cookie to authenticate the user, so the conversion process will have the same permissions as the user downloading the .pdf, but '''you must make sure that the project URL is accessible locally from the Trac server itself'''.
     135When using cookie based authentication, like AccountManager, the ''xhtml2pdf'' library is given a temporary cookie to authenticate the user, so the conversion process will have the same permissions as the user downloading the .pdf, but '''you must make sure that the project URL is accessible locally from the Trac server itself'''.
    136136
    137137Optionally, if HTTP Basic or Digest authentication is used, Wikiprint can be configured to log in using '''httpauth_user''' and '''httpauth_password''' options.
     
    139139Not available in administrative interface yet:
    140140
    141  * '''rebase_links''': When generating PDF or printable HTML, change the base URL to the base URL specified with this option. Useful for changing local references (something like "http://localhost:8080") to a global address (like http://mycompany.com/trac).
     141 * '''rebase_links''': When generating PDF or printable HTML, change the base URL to the base URL specified with this option. Useful for changing local references (something like `http://localhost:8080`) to a global address (like `http://mycompany.com/trac`).
    142142 * '''omit_links''': Remove internal wiki links from generated PDFs.
    143143 * '''omit_macros''': A comma separated list of macro names that will be omitted when converting the wiki document to the selected output (PDF or printable HTML).