simplenavi Plugin

这是本文档旧的修订版！

—- plugin —- description: Create a simple navigation tree based on namespaces author : Andreas Gohr email : dokuwiki@cosmocode.de type : syntax lastupdate : 2023-11-13 compatible : !Frusterick Manners, !Greebo, !Hogfather, Igor, Jack Jackrum depends : conflicts : similar : navi, indexmenu tags : navigation, menu

downloadurl: https://github.com/cosmocode/simplenavi/zipball/master bugtracker : https://github.com/cosmocode/simplenavi/issues sourcerepo : https://github.com/cosmocode/simplenavi/ donationurl:

This plugin creates a tree of links based on the wiki's namespace structure and is intended to be used in the sidebar of any template. It looks similar to the Page Index but with namespaces linking directly to their respective start pages. The tree is opened based on the currently opened page.

The plugin honors ACLs and hidepages settings.

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Use the following code to embed the navigation in your sidebar page:

{{simplenavi>}}

You can optionally give a namespace at which the navigation tree should start (e.g. useful for building different navigations for different language namespaces):

{{simplenavi>ns1:ns2}}

Example:

{{simplenavi>animals:insects}}

Additional options can be given separated by spaces.

{{simplenavi>animals:insects filter}}

The filter option will add a text input field which allows for filtering the top level of the tree.

{{simplenavi>animals:insects home}}

The home option will wrap all found content under the start page of the given name space. Useful when composing menus from different simplenavi calls.

Use the DokuWiki configuration manager to change the behaviour of the plugin.

natsort - Use natural sorting instead of simple string comparisons. There is probably no reason to disable this.
nsfirst - Sort namespaces before pages. When disabled, namespaces are sorted among pages based on their names.
usetitle - When enabled, sorting happens based on page titles instead of page IDs. When enabled, output will also use page titles in the resulting links. Note: this behavior is now independent of the useheading option.