1 Introduction
2 ------------
3
4 The CategoryMenu macro for MoinMoin provides support for navigation menus,
5 placed in the page content itself, showing the categories available in a Wiki,
6 along with the pages in the selected category.
7
8 Installation
9 ------------
10
11 To install the macro in a Wiki, consider using the instmacros script provided:
12
13 ./instmacros path-to-wiki
14
15 On non-UNIX platforms, it is necessary to manually copy the contents of the
16 macros directory in this distribution into the macros directory of your Wiki.
17
18 It should now be possible to edit pages and use the macro as follows. For
19 MoinMoin 1.5:
20
21 [[CategoryMenu()]]
22
23 For MoinMoin 1.6 and above:
24
25 <<CategoryMenu()>>
26
27 As arguments to the macro, you can indicate a comma-separated list of selected
28 (or opened) categories in the menu. For example:
29
30 <<CategoryMenu(Homepage)>>
31
32 Although this should display the menu as a hierarchical list, you may wish to
33 change the appearance of the menu to something more visually attractive; to do
34 so, consider using the insttheme script provided:
35
36 ./insttheme path-to-wiki theme-name
37
38 Again, on non-UNIX platforms, it is necessary to manually copy the files. In
39 this case, just copy the contents of the css directory into the css directory
40 of themes which will support styling of category menus.
41
42 Contact, Copyright and Licence Information
43 ------------------------------------------
44
45 No Web page has yet been made available for this work, but the author can be
46 contacted at the following e-mail address:
47
48 paul@boddie.org.uk
49
50 Copyright and licence information can be found in the docs directory - see
51 docs/COPYING.txt and docs/LICENCE.txt for more information.
52
53 Release Procedures
54 ------------------
55
56 Update the CategoryMenu.py __version__ attribute.
57 Change the version number and package filename/directory in the documentation.
58 Update the release notes (see above).
59 Tag, export.
60 Archive, upload.
61 Update the MacroMarket (http://moinmo.in/MacroMarket).