Changes between Version 2 and Version 3 of TracWikiPrintPlugin


Ignore:
Timestamp:
Apr 2, 2009 11:44:34 AM (5 years ago)
Author:
airadier
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWikiPrintPlugin

    v2 v3  
    1616The style of the resulting PDF or HTML can be fully customized using CSS files. 
    1717 
    18 == Bugs/Feature Requests ==  
    19  
    20 Existing bugs and feature requests for TracWikiPrintPlugin are  
    21 [report:9?COMPONENT=TracWikiPrintPlugin here]. 
    22  
    23 If you have any issues, create a  
    24 [http://trac-hacks.org/newticket?component=TracWikiPrintPlugin&owner=airadier new ticket]. 
    25  
    26 == Download == 
    27  
    28 Download the zipped source from [download:tracwikiprintplugin here]. 
    29  
    30 == Source == 
    31  
    32 You can check out TracWikiPrintPlugin from [http://trac-hacks.org/svn/tracwikiprintplugin here] using Subversion, or [source:tracwikiprintplugin browse the source] with Trac. 
    33  
    34 == Example == 
     18== Usage instructions == 
    3519 
    3620First, install the plugin as usual.  
     
    5842 
    5943Most of these options can be also set from the web administrative interface. 
     44 
     45!WikiPrint works by converting one or some Wiki pages to HTML, adding some CSS styles and replacing special tags, and then passing the output to the xhtml2pdf library, so in order to understand how to customize the output using CSS, and to use some special html tags used by xhtml2pdf, you'll have to check the xhtml2pdf manual. 
    6046 
    6147== Export formats == 
     
    10086=== Customizing styles === 
    10187 
    102 TO-DO 
     88!WikiPrint allows customization of documents by three different options: 
     89 
     90 * css_url: A path or URL to a file with CSS styles that will be applied to the exported output. If left blank, a default CSS is used. If you are creating a custom CSS, use the default CSS as start, and change as needed. Some tweaking is needed in order to make xhtml2pdf/PISA library generate PDF correctly. 
     91 * article_css_url: A path or URL to a file with CSS styles that will be used only when exporting to '''PDF Article''' format. The default one defines the page margins, and creates ''header'' and ''footer'' frames, which contents will be defined in the ''extracontent_url'' file.  
     92 * book_css_url: A path or URL to a file with CSS styles that will be used only when exporting to '''PDF Book''' format. The default one defines the default page with no header or footer, which will be used for the front page, and a ''standard'' templage page, which will be used for successive pages, with header and footer. 
     93 
     94For more information about the styles that affect the PDF output, see the xhtml2pdf manual. 
     95 
     96=== Customizing front page, header, footer, contents === 
     97 
     98 * 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'' 
     99 * 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. 
     100 
     101== Bugs/Feature Requests ==  
     102 
     103Existing bugs and feature requests for TracWikiPrintPlugin are  
     104[report:9?COMPONENT=TracWikiPrintPlugin here]. 
     105 
     106If you have any issues, create a  
     107[http://trac-hacks.org/newticket?component=TracWikiPrintPlugin&owner=airadier new ticket]. 
     108 
     109== Download == 
     110 
     111Download the zipped source from [download:tracwikiprintplugin here]. 
     112 
     113== Source == 
     114 
     115You can check out TracWikiPrintPlugin from [http://trac-hacks.org/svn/tracwikiprintplugin here] using Subversion, or [source:tracwikiprintplugin browse the source] with Trac. 
    103116 
    104117== Recent Changes ==