paul@3 | 1 | Introduction
|
paul@3 | 2 | ------------
|
paul@3 | 3 |
|
paul@3 | 4 | SubpageComments is a distribution of extensions permitting the display and
|
paul@3 | 5 | contribution of comments on pages, where each comment is stored in a separate
|
paul@3 | 6 | subpage of the affected page.
|
paul@3 | 7 |
|
paul@3 | 8 | Installation
|
paul@3 | 9 | ------------
|
paul@3 | 10 |
|
paul@3 | 11 | To install the support library and MoinMoin-related scripts, consider using
|
paul@3 | 12 | the moinsetup tool. See the "Recommended Software" section below for more
|
paul@3 | 13 | information.
|
paul@3 | 14 |
|
paul@3 | 15 | With moinsetup and a suitable configuration file, the installation is done as
|
paul@3 | 16 | follows with $SCDIR referring to the SubpageComments distribution directory
|
paul@3 | 17 | containing this README.txt file:
|
paul@3 | 18 |
|
paul@5 | 19 | python moinsetup.py -m install_extension_package $SCDIR
|
paul@3 | 20 | python moinsetup.py -m install_actions $SCDIR/actions
|
paul@3 | 21 | python moinsetup.py -m install_macros $SCDIR/macros
|
paul@3 | 22 | python moinsetup.py -m install_theme_resources $SCDIR
|
paul@3 | 23 | python moinsetup.py -m edit_theme_stylesheet screen.css includecomments.css
|
paul@3 | 24 | python moinsetup.py -m edit_theme_stylesheet print.css includecomments.css
|
paul@3 | 25 |
|
paul@5 | 26 | The first command runs the setup.py script and installs the library for the
|
paul@5 | 27 | extension.
|
paul@3 | 28 |
|
paul@5 | 29 | The second command installs the PostComment action.
|
paul@3 | 30 |
|
paul@5 | 31 | The third command installs the IncludeComments macro.
|
paul@5 | 32 |
|
paul@5 | 33 | The fourth command installs the theme resources in the available theme
|
paul@3 | 34 | directories.
|
paul@3 | 35 |
|
paul@3 | 36 | The remaining commands activate the styles provided by SubpageComments by
|
paul@3 | 37 | editing the screen.css and print.css files which are typically provided by
|
paul@3 | 38 | themes. These commands add imports of the following form to the theme
|
paul@3 | 39 | stylesheets:
|
paul@3 | 40 |
|
paul@3 | 41 | @import "includecomments.css";
|
paul@3 | 42 |
|
paul@3 | 43 | Recommended Software
|
paul@3 | 44 | --------------------
|
paul@3 | 45 |
|
paul@3 | 46 | See the "Dependencies" section below for essential software.
|
paul@3 | 47 |
|
paul@3 | 48 | The moinsetup tool is recommended for installation since it aims to support
|
paul@3 | 49 | all versions of MoinMoin that are supported for use with this software.
|
paul@3 | 50 |
|
paul@3 | 51 | See the following page for information on moinsetup:
|
paul@3 | 52 |
|
paul@3 | 53 | http://moinmo.in/ScriptMarket/moinsetup
|
paul@3 | 54 |
|
paul@3 | 55 | Contact, Copyright and Licence Information
|
paul@3 | 56 | ------------------------------------------
|
paul@3 | 57 |
|
paul@3 | 58 | See the following Web pages for more information about this work:
|
paul@3 | 59 |
|
paul@3 | 60 | http://moinmo.in/ActionMarket/SubpageComments
|
paul@4 | 61 | http://moinmo.in/MacroMarket/SubpageComments
|
paul@3 | 62 |
|
paul@3 | 63 | The author can be contacted at the following e-mail address:
|
paul@3 | 64 |
|
paul@3 | 65 | paul@boddie.org.uk
|
paul@3 | 66 |
|
paul@3 | 67 | Copyright and licence information can be found in the docs directory - see
|
paul@3 | 68 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@3 | 69 |
|
paul@3 | 70 | Dependencies
|
paul@3 | 71 | ------------
|
paul@3 | 72 |
|
paul@3 | 73 | SubpageComments has the following basic dependencies:
|
paul@3 | 74 |
|
paul@3 | 75 | Packages Release Information
|
paul@3 | 76 | -------- -------------------
|
paul@3 | 77 |
|
paul@3 | 78 | MoinSupport Tested with 0.4.1
|
paul@3 | 79 | Source: http://hgweb.boddie.org.uk/MoinSupport
|
paul@3 | 80 |
|
paul@3 | 81 | Release Procedures
|
paul@3 | 82 | ------------------
|
paul@3 | 83 |
|
paul@3 | 84 | Update the __version__ attribute in the action and macro.
|
paul@3 | 85 | Change the version number and package filename/directory in the documentation.
|
paul@3 | 86 | Update the release notes (see above).
|
paul@3 | 87 | Tag, export.
|
paul@3 | 88 | Archive, upload.
|
paul@4 | 89 | Update the ActionMarket and MacroMarket (see above for the URLs).
|