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