wiki:PageToDocIntegration

Version 9 (modified by markm, 4 years ago) (diff)

small change to make the note at the top of the page clearer

A Trac plugin for export of wiki pages to MS Word

Hi
Mark here.
As Lucas is moving on - I would like to thank him for this plugin. I have some ideas for change - but for now will restrict myself to trying to fix the issues already logged.
Mark

Description

The aim of the plugin is to transform a wiki page so that it can be imported using the HTML import capability of MS Word. After that, a format template can be applied, and the text might be copied into a document template.

The plugin works as follows:

  • Cleanup and validation using HTML Tidy.
  • Transformation using a XSLT stylesheet
  • Offering a zip file with wiki page and images for downloading.

Installation:

  • Install HTML Tidy.
  • Make sure xsltproc is available. If not, install from http://xmlsoft.org/XSLT/xsltproc2.html
    • From the linked page Click Downloads and download iconv, libxslt, libxml2, zlib
    • On windows - the binaries for all either need to be in one directory or on your path (PageToDocIntegration expects the folder that contains libxslt to be on your path)
    • test that it has been installed correctly by running xsltproc (if it cannot be found - make sure it is on the path)
  • Save the XSLT stylesheet onto your disk.
  • Create the following section in your trac.ini (modify path):
    [pagetodoc]
    xsltfile = /path/to/your/xsltfile
    
  • Install plugin.
    • The same can be done by adding the following line to the [components] section of your trac.ini file e.g.
      [components]
      PageToDoc.* = enabled
      

The plugin is in a alpha state. There are a couple of things to be enhanced. Please try and give feedback.

Configuration

Configuration options are made in trac\environment\path\conf\trac.ini and the parameters are in the [pagetodoc] section (which you will need to add as documented in the installation instructions).

xsltfile (Required) The path to the XSLT file to use for transforming the wiki HTML output. Specify the filepath of html_filtered.xslt shipped with PageToDocIntegration
tidypath (Optional) Path to tidy. If left empty then the executable search path is used.
Added in [5406] hoping it helps to resolve issues like #4396
xsltprocpath (Optional) Path to xlstproc. If left empty then the executable search path is used.
Added in [5406] hoping it helps to resolve issues like #4396
replace_host (Optional) Two strings separated by a comma. A replace operation is performed on the image URL finding the first part and replacing with the 2nd part.
Added in [5401] hoping it fixes #3507
img_max_x (Optional) max image width? Used to calculate if image needs to be resized. Default is 0
img_max_y (Optional) max image height? Used to calculate if image needs to be resized. Default is 0
dpi (Optional) dots per inch? Used to calculate if image needs to be resized. Default is 96
[pagetodoc]
xsltfile = /path/to/your/xsltfile
replace_host = man-wwl-sw, localhost
xsltprocpath = path/to/xsltproc
tidypath = /path/to/tidy
img_max_x = 500
img_max_y = 200
dpi = 96

Bugs/Feature Requests

Existing bugs and feature requests for PageToDocIntegration are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

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

Example

Once installed, a new entry shows up below the Download in other formats section at the end of the page. Click and save to disk. Extract and open with Word.

Recent Changes

[7642] by markm on 2010-02-18 10:38:54
Fixed spelling errors regarding xslt (was xlst)
[7641] by markm on 2010-02-18 10:36:38
Fixes:6522
The order of the parameters to xsltproc were wrong.
[7640] by markm on 2010-02-18 10:35:46
Added maintainer information to setup.py

Author/Contributors

Author: lei
Current Maintainer: markm (mark dot m dot mcmahon at gmail dot com) (please email me if you encounter a bug as I do not check here very frequently)
Contributors: