1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Sat Nov 01 01:42:32 2008 +0100
1.3 @@ -0,0 +1,61 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The CategoryMenu macro for MoinMoin provides support for navigation menus,
1.8 +placed in the page content itself, showing the categories available in a Wiki,
1.9 +along with the pages in the selected category.
1.10 +
1.11 +Installation
1.12 +------------
1.13 +
1.14 +To install the macro in a Wiki, consider using the instmacros script provided:
1.15 +
1.16 + ./instmacros path-to-wiki
1.17 +
1.18 +On non-UNIX platforms, it is necessary to manually copy the contents of the
1.19 +macros directory in this distribution into the macros directory of your Wiki.
1.20 +
1.21 +It should now be possible to edit pages and use the macro as follows. For
1.22 +MoinMoin 1.5:
1.23 +
1.24 + [[CategoryMenu()]]
1.25 +
1.26 +For MoinMoin 1.6 and above:
1.27 +
1.28 + <<CategoryMenu()>>
1.29 +
1.30 +As arguments to the macro, you can indicate a comma-separated list of selected
1.31 +(or opened) categories in the menu. For example:
1.32 +
1.33 + <<CategoryMenu(Homepage)>>
1.34 +
1.35 +Although this should display the menu as a hierarchical list, you may wish to
1.36 +change the appearance of the menu to something more visually attractive; to do
1.37 +so, consider using the insttheme script provided:
1.38 +
1.39 + ./insttheme path-to-wiki theme-name
1.40 +
1.41 +Again, on non-UNIX platforms, it is necessary to manually copy the files. In
1.42 +this case, just copy the contents of the css directory into the css directory
1.43 +of themes which will support styling of category menus.
1.44 +
1.45 +Contact, Copyright and Licence Information
1.46 +------------------------------------------
1.47 +
1.48 +No Web page has yet been made available for this work, but the author can be
1.49 +contacted at the following e-mail address:
1.50 +
1.51 +paul@boddie.org.uk
1.52 +
1.53 +Copyright and licence information can be found in the docs directory - see
1.54 +docs/COPYING.txt and docs/LICENCE.txt for more information.
1.55 +
1.56 +Release Procedures
1.57 +------------------
1.58 +
1.59 +Update the CategoryMenu.py __version__ attribute.
1.60 +Change the version number and package filename/directory in the documentation.
1.61 +Update the release notes (see above).
1.62 +Tag, export.
1.63 +Archive, upload.
1.64 +Update the MacroMarket (http://moinmo.in/MacroMarket).