Changes between Version 9 and Version 10 of PageToDocIntegration


Ignore:
Timestamp:
Feb 18, 2010, 10:17:14 AM (5 years ago)
Author:
markm
Comment:

Various improvements to the installation instructions

Legend:

Unmodified
Added
Removed
Modified
  • PageToDocIntegration

    v9 v10  
    1111
    1212The plugin works as follows:
    13  * Cleanup and validation using [http://tidy.sourceforge.net/ HTML Tidy].
     13 * Ask's Trac to generate the HTML
     14 * Cleanup and validation using HTML Tidy.
    1415 * Transformation using a XSLT stylesheet
    1516 * Offering a zip file with wiki page and images for downloading.
    1617
    17 Installation:
    18  * Install [http://tidy.sourceforge.net/ HTML Tidy].
    19  * Make sure xsltproc is available. If not, install from [http://xmlsoft.org/XSLT/xsltproc2.html]
     18== Installation: ==
     19=== Dependencies ===
     20 * '''HTML Tidy''' Install [http://tidy.sourceforge.net/ HTML Tidy] (Windows: www.paehl.com/open_source/?download=tidy.zip).
     21 * '''XSLTProc''' Make sure xsltproc is available. If not, install from [http://xmlsoft.org/XSLT/xsltproc2.html] (Windows: www.zlatkovic.com/pub/libxml/)
    2022  * From the linked page Click Downloads and download iconv, libxslt, libxml2, zlib
    21   * 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)
    22   * test that it has been installed correctly by running xsltproc (if it cannot be found - make sure it is on the path)
     23  * Test that it has been installed correctly by running xsltproc (it should output a help page)
     24  * On windows - the binaries for all the XSLTProc tools either need to be in one directory (if this directory is not on the search path then please specify the `xsltprocpath` configuration setting)
     25
     26=== PageToDocIntegration Plugin ===
     27 * Use easy_install.py !PageToDocIntegration
     28 * or
     29  * Download or checkout the source
     30  * Compile the plugin setup.py bdist_egg
     31  * Copy the .egg file into your Trac Environment plugins directory
    2332 * Save the [source:/pagetodocintegration/html_filtered.xslt XSLT stylesheet] onto your disk.
    2433 * Create the following section in your trac.ini (modify path):
    2534{{{
    2635[pagetodoc]
    27 xsltfile = /path/to/your/xsltfile
     36xsltfile = /path/to/your/xsltfile.xslt
    2837}}}
    2938 * Install plugin.
     
    3443}}}
    3544
    36 The plugin is in a alpha state. There are a couple of things to be enhanced. Please try and give feedback.
     45The plugin is in a alpha state. There are a couple of things to be enhanced. Please enter feedback and bugs (good idea to email me also - see my email address at the bottom of this page).
    3746
    3847=== Configuration ===
    3948Configuration 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).
    4049
    41 || `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 ||
    42 || `tidypath` || ''(Optional)'' Path to tidy. If left empty then the executable search path is used. [[BR]]Added in [5406] hoping it helps to resolve issues like #4396 ||
    43 || `xsltprocpath` || ''(Optional)'' Path to xlstproc. If left empty then the executable search path is used. [[BR]]Added in [5406] hoping it helps to resolve issues like #4396 ||
     50|| `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 ||
     51|| `tidypath` || ''(Optional)'' Path to tidy executable. If left empty then the executable search path is used. [[BR]]Added in [5406] hoping it helps to resolve issues like #4396 ||
     52|| `xsltprocpath` || ''(Optional)'' Path to xlstproc executable. If left empty then the executable search path is used. [[BR]]Added in [5406] hoping it helps to resolve issues like #4396 ||
    4453|| `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.[[BR]]Added in [5401] hoping it fixes #3507||
    4554|| `img_max_x` || ''(Optional)'' max image width? Used to calculate if image needs to be resized. Default is 0 ||
     
    4958{{{
    5059[pagetodoc]
    51 xsltfile = /path/to/your/xsltfile
     60xsltfile = /path/to/your/xsltfile.xslt
    5261replace_host = man-wwl-sw, localhost
    53 xsltprocpath = path/to/xsltproc
    54 tidypath = /path/to/tidy
     62xsltprocpath = path/to/xsltproc.exe
     63tidypath = /path/to/tidy.exe
    5564img_max_x = 500
    5665img_max_y = 200
     
    6069== Bugs/Feature Requests ==
    6170
    62 Existing bugs and feature requests for PageToDocIntegration are
     71Existing bugs and feature requests for !PageToDocIntegration are
    6372[report:9?COMPONENT=PageToDocIntegration here].
    6473
    6574If you have any issues, create a
    66 [http://trac-hacks.org/newticket?component=PageToDocIntegration&owner=lei new ticket].
     75[http://trac-hacks.org/newticket?component=PageToDocIntegration&owner=markm new ticket].
    6776
    6877== Download ==
     
    7281== Source ==
    7382
    74 You can check out PageToDocIntegration from [http://trac-hacks.org/svn/pagetodocintegration here] using Subversion, or [source:pagetodocintegration browse the source] with Trac.
     83You can check out !PageToDocIntegration from [http://trac-hacks.org/svn/pagetodocintegration here] using Subversion, or [source:pagetodocintegration browse the source] with Trac.
    7584
    7685== Example ==