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