1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Thu May 05 20:11:07 2016 +0200
1.3 @@ -0,0 +1,115 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The TimeChanges extension for MoinMoin provides a way of monitoring editing
1.8 +activities on a wiki and thus preventing automated spam edits.
1.9 +
1.10 +After installation, some wiki configuration is required to make sure that the
1.11 +timing mechanism functions correctly. See the "Configuration" section below
1.12 +for more information.
1.13 +
1.14 +See pages/HelpOnTimeChanges for the documentation for this software and how to
1.15 +use it.
1.16 +
1.17 +Installation
1.18 +------------
1.19 +
1.20 +To install the software, consider using the moinsetup tool. See the
1.21 +"Recommended Software" section below for more information.
1.22 +
1.23 +With moinsetup and a suitable configuration file, the installation is done as
1.24 +follows with $TCDIR referring to the TimeChanges distribution directory
1.25 +containing this README.txt file:
1.26 +
1.27 + python moinsetup.py -f moinsetup.cfg -m install_event_handlers $TCDIR/events
1.28 +
1.29 +This command installs the event handler in the wiki's plugin/events directory.
1.30 +
1.31 +Useful Pages
1.32 +------------
1.33 +
1.34 +The pages directory contains documentation using a syntax appropriate for use
1.35 +with MoinMoin 1.6 or later. These pages can be created through the wiki and
1.36 +their contents copied in from each of the files. An easier installation method
1.37 +is to issue the following commands:
1.38 +
1.39 + python moinsetup.py -f moinsetup.cfg -m make_page_package $TCDIR/pages pages.zip
1.40 + python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
1.41 +
1.42 +You may need to switch user in order to have sufficient privileges to copy the
1.43 +page package into the wiki. For example:
1.44 +
1.45 + sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
1.46 +
1.47 +Configuration
1.48 +-------------
1.49 +
1.50 +Once the event handler has been installed, all page saving operations will be
1.51 +affected by its operation. With no further configuration, it may be the case
1.52 +that only superusers will be able to save changes to wiki pages without
1.53 +experiencing timing restrictions.
1.54 +
1.55 +The configuration settings used by TimeChanges are as follows:
1.56 +
1.57 + log_events_format
1.58 + -----------------
1.59 +
1.60 + This must be set to 2, which sets the "extended format" containing the
1.61 + username associated with each event. Without any username information, no
1.62 + timing measurements can be made for a user. By default, this setting is set
1.63 + to 1, which does not permit timing measurements and will therefore not
1.64 + support this extension.
1.65 +
1.66 + editing_delay
1.67 + -------------
1.68 +
1.69 + The duration in seconds of a delay that a user must observe after viewing a
1.70 + page before attempting to save it. By default, this setting will be 10
1.71 + seconds (this value being given in the event handler). Note that this should
1.72 + not affect previewing, only the act of finally saving an edited page.
1.73 +
1.74 +Recommended Software
1.75 +--------------------
1.76 +
1.77 +See the "Dependencies" section below for essential software.
1.78 +
1.79 +The moinsetup tool is recommended for installation since it aims to support
1.80 +all versions of MoinMoin that are supported for use with this software.
1.81 +
1.82 +See the following page for information on moinsetup:
1.83 +
1.84 +http://moinmo.in/ScriptMarket/moinsetup
1.85 +
1.86 +Contact, Copyright and Licence Information
1.87 +------------------------------------------
1.88 +
1.89 +See the following Web page for more information about this work:
1.90 +
1.91 +http://hgweb.boddie.org.uk/TimeChanges
1.92 +
1.93 +The author can be contacted at the following e-mail address:
1.94 +
1.95 +paul@boddie.org.uk
1.96 +
1.97 +Copyright and licence information can be found in the docs directory - see
1.98 +docs/COPYING.txt and docs/LICENCE.txt for more information.
1.99 +
1.100 +Dependencies
1.101 +------------
1.102 +
1.103 +TimeChanges has the following basic dependencies:
1.104 +
1.105 +Packages Release Information
1.106 +-------- -------------------
1.107 +
1.108 +MoinSupport Tested with 0.4.2
1.109 + Source: http://hgweb.boddie.org.uk/MoinSupport
1.110 +
1.111 +Release Procedures
1.112 +------------------
1.113 +
1.114 +Change the version number and package filename/directory in the documentation.
1.115 +Update the PKG-INFO file.
1.116 +Update the release notes (see above).
1.117 +Tag, export.
1.118 +Archive, upload.