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