1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Mon Apr 02 18:24:50 2012 +0200
1.3 @@ -0,0 +1,119 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The ImprovedTableParser extension for MoinMoin provides an alternative way of
1.8 +describing tables in Wiki pages together with additional features for the
1.9 +presentation of tabular data.
1.10 +
1.11 +Installation
1.12 +------------
1.13 +
1.14 +To install the support library and MoinMoin-related scripts, consider using
1.15 +the moinsetup tool. See the "Recommended Software" section below for more
1.16 +information.
1.17 +
1.18 +With moinsetup and a suitable configuration file, the installation is done as
1.19 +follows with $ITDIR referring to the ImprovedTableParser distribution
1.20 +directory containing this README.txt file:
1.21 +
1.22 + python moinsetup.py -f moinsetup.cfg -m install_extension_package $ITDIR
1.23 + python moinsetup.py -f moinsetup.cfg -m install_parsers $ITDIR/parsers
1.24 + python moinsetup.py -f moinsetup.cfg -m install_theme_resources $ITDIR
1.25 + python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet screen.css improvedtableparser.css
1.26 + python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet print.css improvedtableparser.css
1.27 +
1.28 +The first command above uses the setup.py script provided as follows:
1.29 +
1.30 + python setup.py install --prefix=path-to-moin-prefix
1.31 +
1.32 +The second command installs the parser.
1.33 +
1.34 +The third command installs the theme resources in the available theme
1.35 +directories.
1.36 +
1.37 +The remaining commands activate the styles provided by ImprovedTableParser by
1.38 +editing the screen.css and print.css files which are typically provided by
1.39 +themes. These commands add imports of the following form to the theme
1.40 +stylesheets:
1.41 +
1.42 + @import "improvedtableparser.css";
1.43 +
1.44 +Useful Pages
1.45 +------------
1.46 +
1.47 +The pages directory contains a help page using a syntax appropriate for use
1.48 +with MoinMoin 1.6 or later. This page can be created through the Wiki and its
1.49 +contents copied in from the file provided. An easier installation method is to
1.50 +issue the following commands:
1.51 +
1.52 + python moinsetup.py -f moinsetup.cfg -m make_page_package $ITDIR/pages pages.zip
1.53 + python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
1.54 +
1.55 +You may need to switch user in order to have sufficient privileges to copy the
1.56 +page package into the Wiki. For example:
1.57 +
1.58 + sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
1.59 +
1.60 +Using the Parser
1.61 +----------------
1.62 +
1.63 +To create a table using the alternative syntax supported by this extension,
1.64 +create a section in a Wiki page using a special declaration indicating that
1.65 +the section describes a table:
1.66 +
1.67 + {{{#!table
1.68 + '''Heading #1''' || '''Heading #2'''
1.69 + ==
1.70 + Cell #1 || Cell #2
1.71 + }}}
1.72 +
1.73 +See pages/HelpOnImprovedTableParser for more detailed information.
1.74 +
1.75 +Recommended Software
1.76 +--------------------
1.77 +
1.78 +See the "Dependencies" section below for essential software.
1.79 +
1.80 +The moinsetup tool is recommended for installation since it aims to support
1.81 +all versions of MoinMoin that are supported for use with this software.
1.82 +
1.83 +See the following page for information on moinsetup:
1.84 +
1.85 +http://moinmo.in/ScriptMarket/moinsetup
1.86 +
1.87 +Contact, Copyright and Licence Information
1.88 +------------------------------------------
1.89 +
1.90 +See the following Web pages for more information about this work:
1.91 +
1.92 +http://moinmo.in/ParserMarket/ImprovedTableParser
1.93 +
1.94 +The author can be contacted at the following e-mail address:
1.95 +
1.96 +paul@boddie.org.uk
1.97 +
1.98 +Copyright and licence information can be found in the docs directory - see
1.99 +docs/COPYING.txt and docs/LICENCE.txt for more information.
1.100 +
1.101 +Dependencies
1.102 +------------
1.103 +
1.104 +ImprovedTableParser has the following basic dependencies:
1.105 +
1.106 +Packages Release Information
1.107 +-------- -------------------
1.108 +
1.109 +MoinSupport Tested with 0.1
1.110 + Source: http://hgweb.boddie.org.uk/MoinSupport
1.111 +
1.112 +Release Procedures
1.113 +------------------
1.114 +
1.115 +Update the ImprovedTableParser.py __version__ attribute and the setup.py
1.116 +version details.
1.117 +Change the version number and package filename/directory in the documentation.
1.118 +Update the setup.py and PKG-INFO files.
1.119 +Update the release notes (see above).
1.120 +Tag, export.
1.121 +Archive, upload.
1.122 +Update the ParserMarket (see above for the URL).