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