ImprovedTableParser

Changeset

25:91fed74cf3bf
2012-04-02 Paul Boddie raw files shortlog changelog graph Added documentation and packaging support data. rel-0-1
PKG-INFO (file) README.txt (file)
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/PKG-INFO	Mon Apr 02 18:24:50 2012 +0200
     1.3 @@ -0,0 +1,21 @@
     1.4 +Metadata-Version: 1.1
     1.5 +Name: ImprovedTableParser
     1.6 +Version: 0.1
     1.7 +Author: Paul Boddie
     1.8 +Author-email: paul at boddie org uk
     1.9 +Maintainer: Paul Boddie
    1.10 +Maintainer-email: paul at boddie org uk
    1.11 +Home-page: http://moinmo.in/ParserMarket/ImprovedTableParser
    1.12 +Download-url: http://moinmo.in/ParserMarket/ImprovedTableParser?action=AttachFile&do=view&target=ImprovedTableParser-0.1.tar.bz2
    1.13 +Summary: Support an alternative table syntax for MoinMoin, together with improved presentation functionality
    1.14 +License: GPL (version 2 or later)
    1.15 +Description: The ImprovedTableParser extension for MoinMoin provides an alternative way of
    1.16 +        describing tables in Wiki pages together with additional features for the
    1.17 +        presentation of tabular data.
    1.18 +Keywords: MoinMoin Wiki table
    1.19 +Requires: MoinMoin MoinSupport
    1.20 +Classifier: Development Status :: 3 - Alpha
    1.21 +Classifier: License :: OSI Approved :: GNU General Public License (GPL)
    1.22 +Classifier: Programming Language :: Python
    1.23 +Classifier: Topic :: Internet :: WWW/HTTP
    1.24 +Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/README.txt	Mon Apr 02 18:24:50 2012 +0200
     2.3 @@ -0,0 +1,119 @@
     2.4 +Introduction
     2.5 +------------
     2.6 +
     2.7 +The ImprovedTableParser extension for MoinMoin provides an alternative way of
     2.8 +describing tables in Wiki pages together with additional features for the
     2.9 +presentation of tabular data.
    2.10 +
    2.11 +Installation
    2.12 +------------
    2.13 +
    2.14 +To install the support library and MoinMoin-related scripts, consider using
    2.15 +the moinsetup tool. See the "Recommended Software" section below for more
    2.16 +information.
    2.17 +
    2.18 +With moinsetup and a suitable configuration file, the installation is done as
    2.19 +follows with $ITDIR referring to the ImprovedTableParser distribution
    2.20 +directory containing this README.txt file:
    2.21 +
    2.22 +  python moinsetup.py -f moinsetup.cfg -m install_extension_package $ITDIR
    2.23 +  python moinsetup.py -f moinsetup.cfg -m install_parsers $ITDIR/parsers
    2.24 +  python moinsetup.py -f moinsetup.cfg -m install_theme_resources $ITDIR
    2.25 +  python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet screen.css improvedtableparser.css
    2.26 +  python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet print.css improvedtableparser.css
    2.27 +
    2.28 +The first command above uses the setup.py script provided as follows:
    2.29 +
    2.30 +  python setup.py install --prefix=path-to-moin-prefix
    2.31 +
    2.32 +The second command installs the parser.
    2.33 +
    2.34 +The third command installs the theme resources in the available theme
    2.35 +directories.
    2.36 +
    2.37 +The remaining commands activate the styles provided by ImprovedTableParser by
    2.38 +editing the screen.css and print.css files which are typically provided by
    2.39 +themes. These commands add imports of the following form to the theme
    2.40 +stylesheets:
    2.41 +
    2.42 +  @import "improvedtableparser.css";
    2.43 +
    2.44 +Useful Pages
    2.45 +------------
    2.46 +
    2.47 +The pages directory contains a help page using a syntax appropriate for use
    2.48 +with MoinMoin 1.6 or later. This page can be created through the Wiki and its
    2.49 +contents copied in from the file provided. An easier installation method is to
    2.50 +issue the following commands:
    2.51 +
    2.52 +  python moinsetup.py -f moinsetup.cfg -m make_page_package $ITDIR/pages pages.zip
    2.53 +  python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
    2.54 +
    2.55 +You may need to switch user in order to have sufficient privileges to copy the
    2.56 +page package into the Wiki. For example:
    2.57 +
    2.58 +  sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
    2.59 +
    2.60 +Using the Parser
    2.61 +----------------
    2.62 +
    2.63 +To create a table using the alternative syntax supported by this extension,
    2.64 +create a section in a Wiki page using a special declaration indicating that
    2.65 +the section describes a table:
    2.66 +
    2.67 +  {{{#!table
    2.68 +  '''Heading #1''' || '''Heading #2'''
    2.69 +  ==
    2.70 +  Cell #1 || Cell #2
    2.71 +  }}}
    2.72 +
    2.73 +See pages/HelpOnImprovedTableParser for more detailed information.
    2.74 +
    2.75 +Recommended Software
    2.76 +--------------------
    2.77 +
    2.78 +See the "Dependencies" section below for essential software.
    2.79 +
    2.80 +The moinsetup tool is recommended for installation since it aims to support
    2.81 +all versions of MoinMoin that are supported for use with this software.
    2.82 +
    2.83 +See the following page for information on moinsetup:
    2.84 +
    2.85 +http://moinmo.in/ScriptMarket/moinsetup
    2.86 +
    2.87 +Contact, Copyright and Licence Information
    2.88 +------------------------------------------
    2.89 +
    2.90 +See the following Web pages for more information about this work:
    2.91 +
    2.92 +http://moinmo.in/ParserMarket/ImprovedTableParser
    2.93 +
    2.94 +The author can be contacted at the following e-mail address:
    2.95 +
    2.96 +paul@boddie.org.uk
    2.97 +
    2.98 +Copyright and licence information can be found in the docs directory - see
    2.99 +docs/COPYING.txt and docs/LICENCE.txt for more information.
   2.100 +
   2.101 +Dependencies
   2.102 +------------
   2.103 +
   2.104 +ImprovedTableParser has the following basic dependencies:
   2.105 +
   2.106 +Packages                    Release Information
   2.107 +--------                    -------------------
   2.108 +
   2.109 +MoinSupport                 Tested with 0.1
   2.110 +                            Source: http://hgweb.boddie.org.uk/MoinSupport
   2.111 +
   2.112 +Release Procedures
   2.113 +------------------
   2.114 +
   2.115 +Update the ImprovedTableParser.py __version__ attribute and the setup.py
   2.116 +version details.
   2.117 +Change the version number and package filename/directory in the documentation.
   2.118 +Update the setup.py and PKG-INFO files.
   2.119 +Update the release notes (see above).
   2.120 +Tag, export.
   2.121 +Archive, upload.
   2.122 +Update the ParserMarket (see above for the URL).