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@13 | 54 | Recommended Software
|
paul@13 | 55 | --------------------
|
paul@13 | 56 |
|
paul@14 | 57 | The Xapian search software is highly recommended, if not technically
|
paul@14 | 58 | essential, for the acceptable performance of the CategoryMenu macro since the
|
paul@14 | 59 | macro makes use of search routines in MoinMoin that can dominate the time
|
paul@14 | 60 | spent processing requests.
|
paul@14 | 61 |
|
paul@14 | 62 | See the following page for information on Xapian and MoinMoin:
|
paul@14 | 63 |
|
paul@13 | 64 | http://moinmo.in/HelpOnXapian
|
paul@13 | 65 |
|
paul@11 | 66 | Troubleshooting
|
paul@11 | 67 | ---------------
|
paul@11 | 68 |
|
paul@11 | 69 | See here for a bug related to category recognition:
|
paul@11 | 70 |
|
paul@11 | 71 | http://moinmo.in/MoinMoinBugs/1.7TemplatesNotAppearing
|
paul@11 | 72 |
|
paul@11 | 73 | This affects installations where migrations between versions have occurred,
|
paul@11 | 74 | yet the Wiki configuration retains old regular expression details.
|
paul@11 | 75 |
|
paul@6 | 76 | Contact, Copyright and Licence Information
|
paul@6 | 77 | ------------------------------------------
|
paul@6 | 78 |
|
paul@14 | 79 | See the following Web page for more information about this work:
|
paul@14 | 80 |
|
paul@14 | 81 | http://moinmo.in/MacroMarket/CategoryMenu
|
paul@14 | 82 |
|
paul@14 | 83 | The author can be contacted at the following e-mail address:
|
paul@6 | 84 |
|
paul@6 | 85 | paul@boddie.org.uk
|
paul@6 | 86 |
|
paul@6 | 87 | Copyright and licence information can be found in the docs directory - see
|
paul@6 | 88 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@6 | 89 |
|
paul@14 | 90 | New in CategoryMenu 0.2 (Changes since CategoryMenu 0.1)
|
paul@14 | 91 | --------------------------------------------------------
|
paul@14 | 92 |
|
paul@14 | 93 | * Improved category and page discovery, preventing needless inspection of
|
paul@14 | 94 | all categories, and using the category search method when searching for
|
paul@14 | 95 | categories.
|
paul@14 | 96 | * Removed unnecessary page name sorting.
|
paul@14 | 97 | * Fixed and improved the scripts.
|
paul@14 | 98 | * Added MoinMoin 1.8.x compatibility.
|
paul@14 | 99 | * Made displayed page names prettier.
|
paul@14 | 100 | * Added recommended software and troubleshooting documentation.
|
paul@14 | 101 |
|
paul@6 | 102 | Release Procedures
|
paul@6 | 103 | ------------------
|
paul@6 | 104 |
|
paul@6 | 105 | Update the CategoryMenu.py __version__ attribute.
|
paul@6 | 106 | Change the version number and package filename/directory in the documentation.
|
paul@6 | 107 | Update the release notes (see above).
|
paul@6 | 108 | Tag, export.
|
paul@6 | 109 | Archive, upload.
|
paul@14 | 110 | Update the MacroMarket (see above for the URL).
|