Table des matières

Plugin : nspages

---- plugin ----
description: Present a table of contents of the pages of a selected namespace
author     : Guillaume Turri
email      : guillaume.turri@gmail.com
type       : Syntax
lastupdate : 2018-12-03
compatible : 2017-02-19, 2016-06-26a, 2009-12-25, Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, ponder stibbons, Hrun, Detritus, Greebo
depends    : 
conflicts  : 
similar    : catlist, dir, dirlisting, nstoc, pagequery, pagelist, pageindex, pglist
tags       : listing, menu, namespace, navigation

downloadurl: https://github.com/gturri/nspages/zipball/master
bugtracker : https://github.com/gturri/nspages/issues
sourcerepo : https://github.com/gturri/nspages/
donationurl: http://bit.ly/nspages_charityware

I'm looking for a co-maintainer!

If you're a user of this plugin, don't worry: I'm still taking care of it, I will make sure it keeps working with future versions of Dokuwiki. But I have much less time than before to dedicate to it, and as a consequence feature requests tend to pile up.

If you're interested in co-maintaining this plugin, just send me an email (adress available in the commit log).

Description

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 

<nspages>

and see the result. (You may also use the button from the toolbar.)

The general syntax is 

<nspages path_to_a_namespace -option1 -option2 ...>

where:

Common options 
-subns
displays the subnamespaces of the selected namespace (and provide links to their main page) 
-nopages
do not list the pages of the selected namespace (of course this option is useful only if you use -subns) 
-exclude:nameOfPage
won't include the page nameOfPage. This option may be use several times in order to exclude several pages 
-exclude:subNs:
won't include the subnamespace subNs. This option may also be used more than once 
-exclude
won't include the current page 
-h1
will display the first h1 title found. If a page doesn't contain such a title, the name of the page is used instead 
-textPages="some text"
some text will be displayed instead of the default text, to introduce the pages list 
-textNS="some text"
some text will be displayed instead of the default text, to introduce the namespaces list 
-title
 alias of -h1 
-simpleList
 display the list on a single column 
-numberedList
 display the list on a single column, as an ordered list 
-simpleLine
 display the list on a single line (incompatible with -simpleList) 
-simpleLineBreak
 display the list on a single column, separated only by line breaks (incompatible with the previous flags) 
-usePictures
 display the first image of each page 
-nbCol=3
 Change the number of columns to use (default is 3) 
-sortId
 Sort the pages according to their id, even if -title is used
Less common options 
-reverse
 Sort the pages in reverse order 
-naturalOrder
 Sort the pages in natural order 
-sortByDate
 Sort the pages by date of last modification 
-sortByCreationDate
 Sort the pages by date of creation 
-pagesInNs
 The pages will appear among the namespaces 
-r
 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. 
-pregPagesTitleOn
-pregPagesTitleOff
-pregNsTitleOn
-pregNsTitleOff
 Behaves like -pregPagesOn and -pregPagesOff & Co, but filters on the title (instead of the id). 
-anchorName=myName
 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 
-actualTitle
print an actual html title (not just a bold and underlined text) 
-actualTitle=n
print an actual html title <hn> 
-idAndTitle
Use the format “id of the item - title of the item” 
-nbItemsMax=n
Display at most n pages or subnamespaces 
-hideNoPages
Hide page header and “no pages” message if no pages present 
-hideNoSubns
Hide subnamespace header and “no subnamespace” message if no subns present 
-defaultPicture
Specify the picture to display when -usePictures is used and a page doesn't contain any picture. Can be used to point at either a local file (
-defaultPicture="{{:my:picture.png}}"

) or remote one ( 

-defaultPicture="https://some/picture.png"

) 

-showhidden
Include pages that are normally excluded from search with the hidepages config parameter. Useful for creating table of contents for hidden namespaces. 
-dictionaryOrder="<locale>"
Sort according to the locale specified (see the doc). Example of usage: 
-dictionaryOrder="sk_SK"

ex:

cette catégorie n'existe pas : path_to_a_namespace
or

Sous-catégories :

Pas de sous-catégories.

will work.

Installation

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

Some (important) points

Charityware

nspages is a personal open source project started in 2008. I have put hundreds of hours to maintain and enhance it.

It is provided as a charityware. It can be downloaded and installed at no charge. If you found it useful and would like to support its development, you may make a donation to a non-profit charitable organization.

To who

The preference goes to the World Wildlife Fund (WWF) because the are both protecting biodiversity and fighting climate change effectively.

If it isn't possible, any association acting for the environment would do the trick.

How

Forwarding me (address available at the top of the page) the confirmation email you send or receive will ensure your kind gesture will motivate me to continue developing this software.

I can't give money

Making sure you have a positive impact would already be awesome: