# HG changeset patch # User Paul Boddie # Date 1333383890 -7200 # Node ID 91fed74cf3bf485bfd4381ea8a6afadabcaabd2d # Parent 761bbc3a4c7ea5ef44ab0f7a8ab5d1f43a2b46b2 Added documentation and packaging support data. diff -r 761bbc3a4c7e -r 91fed74cf3bf PKG-INFO --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PKG-INFO Mon Apr 02 18:24:50 2012 +0200 @@ -0,0 +1,21 @@ +Metadata-Version: 1.1 +Name: ImprovedTableParser +Version: 0.1 +Author: Paul Boddie +Author-email: paul at boddie org uk +Maintainer: Paul Boddie +Maintainer-email: paul at boddie org uk +Home-page: http://moinmo.in/ParserMarket/ImprovedTableParser +Download-url: http://moinmo.in/ParserMarket/ImprovedTableParser?action=AttachFile&do=view&target=ImprovedTableParser-0.1.tar.bz2 +Summary: Support an alternative table syntax for MoinMoin, together with improved presentation functionality +License: GPL (version 2 or later) +Description: The ImprovedTableParser extension for MoinMoin provides an alternative way of + describing tables in Wiki pages together with additional features for the + presentation of tabular data. +Keywords: MoinMoin Wiki table +Requires: MoinMoin MoinSupport +Classifier: Development Status :: 3 - Alpha +Classifier: License :: OSI Approved :: GNU General Public License (GPL) +Classifier: Programming Language :: Python +Classifier: Topic :: Internet :: WWW/HTTP +Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content diff -r 761bbc3a4c7e -r 91fed74cf3bf README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Mon Apr 02 18:24:50 2012 +0200 @@ -0,0 +1,119 @@ +Introduction +------------ + +The ImprovedTableParser extension for MoinMoin provides an alternative way of +describing tables in Wiki pages together with additional features for the +presentation of tabular data. + +Installation +------------ + +To install the support library and MoinMoin-related scripts, consider using +the moinsetup tool. See the "Recommended Software" section below for more +information. + +With moinsetup and a suitable configuration file, the installation is done as +follows with $ITDIR referring to the ImprovedTableParser distribution +directory containing this README.txt file: + + python moinsetup.py -f moinsetup.cfg -m install_extension_package $ITDIR + python moinsetup.py -f moinsetup.cfg -m install_parsers $ITDIR/parsers + python moinsetup.py -f moinsetup.cfg -m install_theme_resources $ITDIR + python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet screen.css improvedtableparser.css + python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet print.css improvedtableparser.css + +The first command above uses the setup.py script provided as follows: + + python setup.py install --prefix=path-to-moin-prefix + +The second command installs the parser. + +The third command installs the theme resources in the available theme +directories. + +The remaining commands activate the styles provided by ImprovedTableParser by +editing the screen.css and print.css files which are typically provided by +themes. These commands add imports of the following form to the theme +stylesheets: + + @import "improvedtableparser.css"; + +Useful Pages +------------ + +The pages directory contains a help page using a syntax appropriate for use +with MoinMoin 1.6 or later. This page can be created through the Wiki and its +contents copied in from the file provided. An easier installation method is to +issue the following commands: + + python moinsetup.py -f moinsetup.cfg -m make_page_package $ITDIR/pages pages.zip + python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip + +You may need to switch user in order to have sufficient privileges to copy the +page package into the Wiki. For example: + + sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip + +Using the Parser +---------------- + +To create a table using the alternative syntax supported by this extension, +create a section in a Wiki page using a special declaration indicating that +the section describes a table: + + {{{#!table + '''Heading #1''' || '''Heading #2''' + == + Cell #1 || Cell #2 + }}} + +See pages/HelpOnImprovedTableParser for more detailed information. + +Recommended Software +-------------------- + +See the "Dependencies" section below for essential software. + +The moinsetup tool is recommended for installation since it aims to support +all versions of MoinMoin that are supported for use with this software. + +See the following page for information on moinsetup: + +http://moinmo.in/ScriptMarket/moinsetup + +Contact, Copyright and Licence Information +------------------------------------------ + +See the following Web pages for more information about this work: + +http://moinmo.in/ParserMarket/ImprovedTableParser + +The author can be contacted at the following e-mail address: + +paul@boddie.org.uk + +Copyright and licence information can be found in the docs directory - see +docs/COPYING.txt and docs/LICENCE.txt for more information. + +Dependencies +------------ + +ImprovedTableParser has the following basic dependencies: + +Packages Release Information +-------- ------------------- + +MoinSupport Tested with 0.1 + Source: http://hgweb.boddie.org.uk/MoinSupport + +Release Procedures +------------------ + +Update the ImprovedTableParser.py __version__ attribute and the setup.py +version details. +Change the version number and package filename/directory in the documentation. +Update the setup.py and PKG-INFO files. +Update the release notes (see above). +Tag, export. +Archive, upload. +Update the ParserMarket (see above for the URL).