1 Introduction
2 ------------
3
4 The TimeChanges extension for MoinMoin provides a way of monitoring editing
5 activities on a wiki and thus preventing automated spam edits.
6
7 After installation, some wiki configuration is required to make sure that the
8 timing mechanism functions correctly. See the "Configuration" section below
9 for more information.
10
11 See pages/HelpOnTimeChanges for the documentation for this software and how to
12 use it.
13
14 Installation
15 ------------
16
17 To install the software, consider using the moinsetup tool. See the
18 "Recommended Software" section below for more information.
19
20 With moinsetup and a suitable configuration file, the installation is done as
21 follows with $TCDIR referring to the TimeChanges distribution directory
22 containing this README.txt file:
23
24 python moinsetup.py -f moinsetup.cfg -m install_event_handlers $TCDIR/events
25
26 This command installs the event handler in the wiki's plugin/events directory.
27
28 Useful Pages
29 ------------
30
31 The pages directory contains documentation using a syntax appropriate for use
32 with MoinMoin 1.6 or later. These pages can be created through the wiki and
33 their contents copied in from each of the files. An easier installation method
34 is to issue the following commands:
35
36 python moinsetup.py -f moinsetup.cfg -m make_page_package $TCDIR/pages pages.zip
37 python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
38
39 You may need to switch user in order to have sufficient privileges to copy the
40 page package into the wiki. For example:
41
42 sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
43
44 Configuration
45 -------------
46
47 Once the event handler has been installed, all page saving operations will be
48 affected by its operation. With no further configuration, it may be the case
49 that only superusers will be able to save changes to wiki pages without
50 experiencing timing restrictions.
51
52 The configuration settings used by TimeChanges are as follows:
53
54 log_events_format
55 -----------------
56
57 This must be set to 2, which sets the "extended format" containing the
58 username associated with each event. Without any username information, no
59 timing measurements can be made for a user. By default, this setting is set
60 to 1, which does not permit timing measurements and will therefore not
61 support this extension.
62
63 editing_delay
64 -------------
65
66 The duration in seconds of a delay that a user must observe after viewing a
67 page before attempting to save it. By default, this setting will be 10
68 seconds (this value being given in the event handler). Note that this should
69 not affect previewing, only the act of finally saving an edited page.
70
71 Recommended Software
72 --------------------
73
74 See the "Dependencies" section below for essential software.
75
76 The moinsetup tool is recommended for installation since it aims to support
77 all versions of MoinMoin that are supported for use with this software.
78
79 See the following page for information on moinsetup:
80
81 http://moinmo.in/ScriptMarket/moinsetup
82
83 Contact, Copyright and Licence Information
84 ------------------------------------------
85
86 See the following Web page for more information about this work:
87
88 http://hgweb.boddie.org.uk/TimeChanges
89
90 The author can be contacted at the following e-mail address:
91
92 paul@boddie.org.uk
93
94 Copyright and licence information can be found in the docs directory - see
95 docs/COPYING.txt and docs/LICENCE.txt for more information.
96
97 Dependencies
98 ------------
99
100 TimeChanges has the following basic dependencies:
101
102 Packages Release Information
103 -------- -------------------
104
105 MoinSupport Tested with 0.4.2
106 Source: http://hgweb.boddie.org.uk/MoinSupport
107
108 Release Procedures
109 ------------------
110
111 Change the version number and package filename/directory in the documentation.
112 Update the PKG-INFO file.
113 Update the release notes (see above).
114 Tag, export.
115 Archive, upload.