paul@6 | 1 | Introduction
|
paul@6 | 2 | ------------
|
paul@6 | 3 |
|
paul@6 | 4 | The CategoryMenu macro for MoinMoin provides support for navigation menus,
|
paul@8 | 5 | placed in the page content itself, showing the categories present in a Wiki
|
paul@8 | 6 | along with the pages belonging to the selected categories. Categories can be
|
paul@8 | 7 | explicitly selected using macro arguments or implicitly selected using the
|
paul@8 | 8 | category membership of the page on which the macro is used.
|
paul@6 | 9 |
|
paul@6 | 10 | Installation
|
paul@6 | 11 | ------------
|
paul@6 | 12 |
|
paul@6 | 13 | To install the macro in a Wiki, consider using the instmacros script provided:
|
paul@6 | 14 |
|
paul@6 | 15 | ./instmacros path-to-wiki
|
paul@6 | 16 |
|
paul@6 | 17 | On non-UNIX platforms, it is necessary to manually copy the contents of the
|
paul@6 | 18 | macros directory in this distribution into the macros directory of your Wiki.
|
paul@6 | 19 |
|
paul@6 | 20 | It should now be possible to edit pages and use the macro as follows. For
|
paul@6 | 21 | MoinMoin 1.5:
|
paul@6 | 22 |
|
paul@6 | 23 | [[CategoryMenu()]]
|
paul@6 | 24 |
|
paul@6 | 25 | For MoinMoin 1.6 and above:
|
paul@6 | 26 |
|
paul@6 | 27 | <<CategoryMenu()>>
|
paul@6 | 28 |
|
paul@6 | 29 | As arguments to the macro, you can indicate a comma-separated list of selected
|
paul@6 | 30 | (or opened) categories in the menu. For example:
|
paul@6 | 31 |
|
paul@6 | 32 | <<CategoryMenu(Homepage)>>
|
paul@6 | 33 |
|
paul@6 | 34 | Although this should display the menu as a hierarchical list, you may wish to
|
paul@6 | 35 | change the appearance of the menu to something more visually attractive; to do
|
paul@6 | 36 | so, consider using the insttheme script provided:
|
paul@6 | 37 |
|
paul@6 | 38 | ./insttheme path-to-wiki theme-name
|
paul@6 | 39 |
|
paul@6 | 40 | Again, on non-UNIX platforms, it is necessary to manually copy the files. In
|
paul@6 | 41 | this case, just copy the contents of the css directory into the css directory
|
paul@6 | 42 | of themes which will support styling of category menus.
|
paul@6 | 43 |
|
paul@8 | 44 | To activate the styles provided by the stylesheet in the css directory, you
|
paul@8 | 45 | will need to edit the screen.css file in each affected theme's css directory,
|
paul@8 | 46 | adding the following before any style rules:
|
paul@8 | 47 |
|
paul@8 | 48 | /* Category menus... */
|
paul@8 | 49 |
|
paul@8 | 50 | @import "category.css";
|
paul@8 | 51 |
|
paul@8 | 52 | This ensures that the styles are made available to the browser.
|
paul@8 | 53 |
|
paul@11 | 54 | Troubleshooting
|
paul@11 | 55 | ---------------
|
paul@11 | 56 |
|
paul@11 | 57 | See here for a bug related to category recognition:
|
paul@11 | 58 |
|
paul@11 | 59 | http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
|
paul@11 | 60 |
|
paul@11 | 61 | This affects installations where migrations between versions have occurred,
|
paul@11 | 62 | yet the Wiki configuration retains old regular expression details.
|
paul@11 | 63 |
|
paul@6 | 64 | Contact, Copyright and Licence Information
|
paul@6 | 65 | ------------------------------------------
|
paul@6 | 66 |
|
paul@6 | 67 | No Web page has yet been made available for this work, but the author can be
|
paul@6 | 68 | contacted at the following e-mail address:
|
paul@6 | 69 |
|
paul@6 | 70 | paul@boddie.org.uk
|
paul@6 | 71 |
|
paul@6 | 72 | Copyright and licence information can be found in the docs directory - see
|
paul@6 | 73 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@6 | 74 |
|
paul@6 | 75 | Release Procedures
|
paul@6 | 76 | ------------------
|
paul@6 | 77 |
|
paul@6 | 78 | Update the CategoryMenu.py __version__ attribute.
|
paul@6 | 79 | Change the version number and package filename/directory in the documentation.
|
paul@6 | 80 | Update the release notes (see above).
|
paul@6 | 81 | Tag, export.
|
paul@6 | 82 | Archive, upload.
|
paul@6 | 83 | Update the MacroMarket (http://moinmo.in/MacroMarket).
|