Changes between Version 15 and Version 16 of OdtExportPlugin


Ignore:
Timestamp:
Nov 7, 2015, 12:46:15 PM (7 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • OdtExportPlugin

    v15 v16  
    55== Description
    66
    7 This plugins can convert a wiki page to an [http://en.wikipedia.org/wiki/Opendocument OpenDocument] Text file (ODT).
     7This plugin can convert a wiki page to an [http://en.wikipedia.org/wiki/Opendocument OpenDocument] Text file (ODT).
    88
    99The file can be opened with any compatible office suite, such as !OpenOffice, KOffice, IBM Symphony, etc. Currently, it has only been tested with !OpenOffice.
     
    1717
    1818If you have any issues, create a
    19 [http://trac-hacks.org/newticket?component=OdtExportPlugin&owner=abompard new ticket].
     19[/newticket?component=OdtExportPlugin new ticket].
    2020
    2121[[TicketQuery(component=OdtExportPlugin&group=type,format=progress)]]
     
    2323== Download
    2424
    25 {{{
    26 #!html
     25{{{#!html
    2726<a href="http://flattr.com/thing/47978/Trac-ODT-export-plugin" target="_blank"
    2827   style="display:block;float:right;border:none;padding:0"><img
     
    3130}}}
    3231
    33 Download the zipped source from [download:odtexportplugin here].
     32Download the zipped source from [export:odtexportplugin here].
    3433
    3534== Source
    3635
    37 You can check out OdtExportPlugin from [http://trac-hacks.org/svn/odtexportplugin here] using Subversion, or [source:odtexportplugin browse the source] with Trac.
     36You can check out OdtExportPlugin from [/svn/odtexportplugin here] using Subversion, or [source:odtexportplugin browse the source] with Trac.
    3837
    3938== Installation
    4039
    41 This plugin was tested with Trac version 0.11. Please ensure the following python modules are installed before installing this plugin:
     40This plugin was tested with Trac version 0.11. Please ensure the following Python modules are installed before installing this plugin:
    4241
    4342 * [pypi:uTidylib python-uTidyLib]
     
    4544 * [pypi:PIL python-PIL], also known as python-imaging
    4645
    47 Refer to the [trac:TracPlugins Trac plugin documentation] for details on how to build and install plugins and macros. You will probably have to enable the plugin by editing the `components` section of your `trac.ini`:
    48 {{{
    49 #!ini
     46Refer to the [trac:TracPlugins Trac plugin documentation] for details on how to build and install plugins and macros. You will probably have to enable the plugin by editing the `components` section of your `trac.ini` file:
     47{{{#!ini
    5048[components]
    5149odtexport.* = enabled
     
    5654== Configuration
    5755
    58 In `trac.ini`, you can set a few options :
    59  * '''get_remote_images''' (boolean, defaults to `true`) : whether the plugin should download the remote images
     56In `trac.ini` you can set a few options :
     57 * '''get_remote_images''' (boolean, defaults to `true`) : whether the plugin should download the remote images.
    6058 * '''replace_keyword''' (string, defaults to `TRAC-ODT-INSERT`) : the string in the ODT template file to replace with the wiki page content. This keyword ''must'' be unstyled and alone on its own line. If not present, the wiki content will be appended to the template.
    6159 * '''cut_start_keyword''' (string, defaults to `TRAC-ODT-CUT-START`) and '''cut_stop_keyword''' (string, defaults to `TRAC-ODT-CUT-STOP`) : the text between these strings in the ODT template will be removed. See note below for the reason for these tags.
     
    6664
    6765Those options must be placed under a `[odtexport]` section in the `trac.ini` file:
    68 {{{
    69 #!ini
     66{{{#!ini
    7067[odtexport]
    7168get_remote_images = False
     
    8178The default template is named `wikipage.odt`. You can use a custom template by creating a file with this name and putting it in the `templates` directory of your Trac instance. This template will be used by default for all the pages.
    8279
    83 You can also create other ODT files to be used as templates, and put them in the same directory. Then, you can use a special macro in the wiki page to choose the template. This macro is `OdtTemplate` and can be used as such: `[[OdtTemplate(my_other_template)]]`. The `.odt` suffix will be appended, don't put it in the macro.
     80You can also create other ODT files to be used as templates, and put them in the same directory. Then you can use a special macro in the wiki page to choose the template. This macro is `OdtTemplate` and can be used as such: `[[OdtTemplate(my_other_template)]]`. The `.odt` suffix will be appended, don't put it in the macro.
    8481
    85 Finally, you can simply attach the template to the page, and use the `OdtTemplate` macro to select it.
     82Finally, you can attach the template to the page, and use the `OdtTemplate` macro to select it.
    8683
    8784The order of preference when looking for the template file is: