Learn about DokuWiki
Learn about DokuWiki
Compatible with DokuWiki
This plugin nicely displays a table of content of the pages -and optionally the subnamespaces- of a given (sub)namespace.
Using this plugin is easy: just write
and see the result. (You may also use the button from the toolbar.)
The general syntax is
<nspages path_to_a_namespace -option1 -option2 ...>
|displays the subnamespaces of the selected namespace (and provide links to their main page)|
|do not list the pages of the selected namespace (of course this option is useful only if you use -subns)|
|won't include the page nameOfPage. This option may be use several times in order to exclude several pages|
|won't include the subnamespace subNs. This option may also be used more than once|
|won't include the current page|
|will display the first h1 title found. If a page doesn't contain such a title, the name of the page is used instead|
|some text will be displayed instead of the default text, to introduce the pages list|
|some text will be displayed instead of the default text, to introduce the namespaces list|
|alias of -h1|
|display the list on a single column|
|display the list on a single column, as an ordered list|
|display the list on a single line (incompatible with -simpleList)|
|display the list on a single column, separated only by line breaks (incompatible with the previous flags)|
|Change the number of columns to use (default is 3)|
|Sort the pages according to their id, even if -title is used|
|Less common options|
|Sort the pages in reverse order|
|Sort the pages in natural order|
|The pages will appear among the namespaces|
|recurse : display elements of the subnamespaces. You may use just “-r” to check every subnamespace, or e.g. “-r=3” to have a depth limit to 3 levels|
-exclude:[page1 subNs: page2]
|an easier syntax to exclude several pages/subnamespaces|
-pregPagesOn -pregPagesOff -pregNSOn -pregNSOff
| Enable the use of regex to select the documents that should be displayed. Eg: -pregPagesOn=“/doku/i” will display only pages which contains “doku” in their id.
Several options may be used, and each of them may be used several times.
|Add anchors on each title-letters, to let link directly to them. Anchors will look like, e.g. for the letter A: nspages_myName_A|
|print an actual html title (not just a bold and underlined text)|
|print an actual html title <hn>|
|Use the format “id of the item - title of the item”|
|Display at most n pages or subnamespaces|
ex: <nspages path_to_a_namespace -exclude> or <nspages -subns -nopages> will work.
If you have one of the latest version of DokuWiki (at least 2009-12-25, Lemmings), you may use this archive: http://github.com/gturri/nspages/zipball/master.