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