# HG changeset patch # User Paul Boddie # Date 1383487242 -3600 # Node ID 270203f083f0a9b3ce6d12233a68d08a30b15197 # Parent b529131f65da5e0c0bc73528af760cd20b75a2c9 Added documentation; added version information to the extensions. diff -r b529131f65da -r 270203f083f0 README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Sun Nov 03 15:00:42 2013 +0100 @@ -0,0 +1,84 @@ +Introduction +------------ + +SubpageComments is a distribution of extensions permitting the display and +contribution of comments on pages, where each comment is stored in a separate +subpage of the affected page. + +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 $SCDIR referring to the SubpageComments distribution directory +containing this README.txt file: + +python moinsetup.py -m install_actions $SCDIR/actions +python moinsetup.py -m install_macros $SCDIR/macros +python moinsetup.py -m install_theme_resources $SCDIR +python moinsetup.py -m edit_theme_stylesheet screen.css includecomments.css +python moinsetup.py -m edit_theme_stylesheet print.css includecomments.css + +The first command installs the PostComment action. + +The second command installs the IncludeComments macro. + +The third command installs the theme resources in the available theme +directories. + +The remaining commands activate the styles provided by SubpageComments 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 "includecomments.css"; + +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/ActionMarket/SubpageComments + +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 +------------ + +SubpageComments has the following basic dependencies: + +Packages Release Information +-------- ------------------- + +MoinSupport Tested with 0.4.1 + Source: http://hgweb.boddie.org.uk/MoinSupport + +Release Procedures +------------------ + +Update the __version__ attribute in the action and macro. +Change the version number and package filename/directory in the documentation. +Update the release notes (see above). +Tag, export. +Archive, upload. +Update the ActionMarket (see above for the URL). diff -r b529131f65da -r 270203f083f0 actions/PostComment.py --- a/actions/PostComment.py Sun Nov 03 14:53:39 2013 +0100 +++ b/actions/PostComment.py Sun Nov 03 15:00:42 2013 +0100 @@ -12,6 +12,8 @@ from MoinMoin.wikiutil import escape from MoinSupport import getPagesForSearch, getPagesFromResults, ActionSupport +__version__ = "0.1" + Dependencies = ['pages'] class SpecialPermissions(Permissions): diff -r b529131f65da -r 270203f083f0 macros/IncludeComments.py --- a/macros/IncludeComments.py Sun Nov 03 14:53:39 2013 +0100 +++ b/macros/IncludeComments.py Sun Nov 03 15:00:42 2013 +0100 @@ -24,6 +24,8 @@ except ImportError: from StringIO import StringIO +__version__ = "0.1" + Dependencies = ['pages'] # Macro functions.