ImprovedTableParser

README.txt

43:7172d229dea9
2015-02-23 Paul Boddie Updated release and copyright information.
     1 Introduction     2 ------------     3      4 The ImprovedTableParser extension for MoinMoin provides an alternative way of     5 describing tables in Wiki pages together with additional features for the     6 presentation of tabular data.     7      8 Installation     9 ------------    10     11 To install the support library and MoinMoin-related scripts, consider using    12 the moinsetup tool. See the "Recommended Software" section below for more    13 information.    14     15 With moinsetup and a suitable configuration file, the installation is done as    16 follows with $ITDIR referring to the ImprovedTableParser distribution    17 directory containing this README.txt file:    18     19   python moinsetup.py -f moinsetup.cfg -m install_extension_package $ITDIR    20   python moinsetup.py -f moinsetup.cfg -m install_parsers $ITDIR/parsers    21   python moinsetup.py -f moinsetup.cfg -m install_theme_resources $ITDIR    22   python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet screen.css improvedtableparser.css    23   python moinsetup.py -f moinsetup.cfg -m edit_theme_stylesheet print.css improvedtableparser.css    24     25 The first command above uses the setup.py script provided as follows:    26     27   python setup.py install --prefix=path-to-moin-prefix    28     29 The second command installs the parser.    30     31 The third command installs the theme resources in the available theme    32 directories.    33     34 The remaining commands activate the styles provided by ImprovedTableParser by    35 editing the screen.css and print.css files which are typically provided by    36 themes. These commands add imports of the following form to the theme    37 stylesheets:    38     39   @import "improvedtableparser.css";    40     41 Useful Pages    42 ------------    43     44 The pages directory contains a help page using a syntax appropriate for use    45 with MoinMoin 1.6 or later. This page can be created through the Wiki and its    46 contents copied in from the file provided. An easier installation method is to    47 issue the following commands:    48     49   python moinsetup.py -f moinsetup.cfg -m make_page_package $ITDIR/pages pages.zip    50   python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip    51     52 You may need to switch user in order to have sufficient privileges to copy the    53 page package into the Wiki. For example:    54     55   sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip    56     57 Using the Parser    58 ----------------    59     60 To create a table using the alternative syntax supported by this extension,    61 create a section in a Wiki page using a special declaration indicating that    62 the section describes a table:    63     64   {{{#!table    65   '''Heading #1''' || '''Heading #2'''    66   ==    67   Cell #1 || Cell #2    68   }}}    69     70 See pages/HelpOnImprovedTableParser for more detailed information.    71     72 Recommended Software    73 --------------------    74     75 See the "Dependencies" section below for essential software.    76     77 The moinsetup tool is recommended for installation since it aims to support    78 all versions of MoinMoin that are supported for use with this software.    79     80 See the following page for information on moinsetup:    81     82 http://moinmo.in/ScriptMarket/moinsetup    83     84 Contact, Copyright and Licence Information    85 ------------------------------------------    86     87 See the following Web pages for more information about this work:    88     89 http://moinmo.in/ParserMarket/ImprovedTableParser    90     91 The author can be contacted at the following e-mail address:    92     93 paul@boddie.org.uk    94     95 Copyright and licence information can be found in the docs directory - see    96 docs/COPYING.txt and docs/LICENCE.txt for more information.    97     98 Dependencies    99 ------------   100    101 ImprovedTableParser has the following basic dependencies:   102    103 Packages                    Release Information   104 --------                    -------------------   105    106 MoinSupport                 Tested with 0.2   107                             Source: http://hgweb.boddie.org.uk/MoinSupport   108    109 New in ImprovedTableParser 0.2.1 (Changes since ImprovedTableParser 0.2)   110 ------------------------------------------------------------------------   111    112   * Fixed attribute processing to avoid potential interpretation and   113     formatting issues.   114    115 New in ImprovedTableParser 0.2 (Changes since ImprovedTableParser 0.1)   116 ----------------------------------------------------------------------   117    118   * Moved the section argument processing, parsing and formatting functions   119     into the MoinSupport distribution.   120   * Added line continuation syntax for column text.   121   * Added the missing __version__ attribute to the common library module.   122   * Fixed unfinished column spans on the final rows of tables.   123   * Fixed the cell attributes pattern to avoid matching macros.   124   * Added a write parameter to the formatTable function for configurable   125     output, and added formatting according to content type, supporting an   126     extended parser API.   127   * Fixed space handling after row markers, avoiding indentation for text on   128     the same line.   129    130 Release Procedures   131 ------------------   132    133 Update the ImprovedTableParser.py __version__ attribute and the setup.py   134 version details.   135 Change the version number and package filename/directory in the documentation.   136 Update the setup.py and PKG-INFO files.   137 Update the release notes (see above).   138 Tag, export.   139 Archive, upload.   140 Update the ParserMarket (see above for the URL).