Differences

This shows you the differences between two versions of the page.

--- plugin:simplenavi [2017-02-10 08:11] – [Syntax and Usage] 119.151.109.10
+++ plugin:simplenavi [2024-01-07 14:45] (current) – Aleksandr
@@ Line 6: / Line 6: @@
 email      : dokuwiki@cosmocode.de
 type       : syntax
-lastupdate : 2016-07-18
+lastupdate : 2023-11-13
-compatible : 2009-12-25+, 2013-12-08 "Binky", 2014-05-05 "Ponder Stibbons", 2014-09-29 "Hrun", 2015-08-10 "Detritus", 2016-06-26 "Elenor Of Tsort"
+compatible : !Frusterick Manners, !Greebo, !Hogfather, Igor, Jack Jackrum
 depends    :
 conflicts  :
@@ Line 19: / Line 19: @@
 ----
-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 that has one (tested on [[template:arctic|Arctic Template]]). It looks similar to the [[:index|Page Index]] but [[:namespaces]] link directly to their respective start pages, and start pages it self are hidden from the index.
+This plugin creates a tree of links based on the wiki's namespace structure and is intended to be used in the [[faq:sidebar]] of any template. It looks similar to the [[:index|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 [[:ACL]], [[config:hidepages]]((config, not to be confused with the [[plugin:hidepages]] plugin)) and [[config:useheading]] settings.
+The plugin honors [[:ACLs]] and [[config:hidepages]] settings.
 ===== Download and Installation =====
-[[http://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
-Download and install the plugin using the [[plugin:plugin|Plugin Manager]] using the URL given above. Refer to [[:Plugins]] on how to install plugins manually.
+[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Syntax and Usage =====
-Use the following code to embed the navigation in your sidebar page:
+Use the following code to embed the navigation in your [[faq:sidebar|sidebar]] page:
   {{simplenavi>}}
-You can optionally give a namespace at which the navigation tree should start (useful for building different navigations for different language namespaces)
+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>some:namespace}}
+  {{simplenavi>ns1:ns2}}
+Example:
-===== Configuration =====
+  {{simplenavi>animals:insects}}
-Use DokuWiki configuration manager to change the sort order of the entries in the list:
+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.
+===== Configuration =====
-If [[config:useheading]] is set in global configuration, the list shows the title of the [[config:startpage|startpages]] of the namespaces found, instead of the namespace-names itself.
+Use the DokuWiki [[config|configuration manager]] to change the behaviour of the plugin.
-Using the plugins sort-order configuration item, one can choose if they are not ordered (="naturally") or ordered by namespaces names (="ascii").
+  * ''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 [[config:useheading]] option.
 ===== Development =====