nspages plugin

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:

• path_to_a_namespace represents the path to the wanted namespace. It can be an absolute (ex: namespace1:subnamespace) or a relative path (ex: .:subnamespace). If no path is specified, the current namespace is selected.
• -option may be one of the following (it is possible to specify several options):

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.

If you have a previous version of DokuWiki, you should use this one: http://guigui.webou.net/gestion_projet/nspages/nspagesV1.zip.¹⁾

• bugfix: -sortId and -sortById have the same effect (2011/08/26 20:10)
• The firstChar displayed is based on the 'sort' index (2011/08/25 22:23)
• Minor modifications (2011/08/25 22:21)
• Option -sortId added (2011/08/19 07:49)
• Option -simpleLine added (2011/08/18 18:22)

• You should put ~~NOCACHE~~ in the pages where you use this plugin, to make sure that if you create or remove a page in the namespace, it will be taken into account. Else, it may take up to 24h to be updated. However, it's up to you: if you seldom create/remove pages, you may want to avoid putting this; to save CPU cycles.
• The CSS sheet should be taken into account in order for this plugin to work correctly; but because of the cache system it may not be the case the first time you use this plugin (even if ~~NOCACHE~~ is specified). The easier way to resolve this is to make sure your cache is invalidated by touching conf/local.php (eg. by resaving your configuration)
• Currently, you may not use a '>' in the -textPages and -textNS options, since it is understood as the end of the <nspages> tag

• I tried nspages, but have some problems with the syntax. I would like to exclude all pages from the NS wiki: and ebook:

<nspages -title -r -subns -nbCol=2 -exclude:[wiki: playground: index] -pregNSOff="/ebook/" -pregPagesOff="/ebook/">''

But it doesn't work ond my DokuWiki Ricewind.

pregNSOff (resp. pregPagesOff) works on the id of the subnamespace (resp. the page), without taking the id of the parent namespaces into account. Therefore, using ”-pregNSOff=”/ebook/”” it expected to exclude this namespace from the “Subnamespace” section, but let the pages in this namespace pass.
I could add another set of options like pregNSWithFullIdOff / pregPagesWithFullIdOff, … to deal with it, but I'll first try to see if I can find a more clever solution. — gturrigturri

Paris 2011/12/31 13:42

Thanks, but how does the exclude works exactly. it doesn' exclude wiki: oder playground: in my case (but the page index). I'm looking for an option to exclude namespaces recursive (btw, happy new year) — Keywan Tonekaboni 01.01.2012 - 15:08

If you're a bit familiar with PHP, here is how it works:

/**
 * Check if the user wants a file to be displayed.
 * Filters consider the "id" and not the "title". Therefore, the treatment is the same for files and for subnamespace.
 * Moreover, filters remain valid even if the title of a page is changed.
 *
 * @param Array $excludedFiles A list of files that shouldn't be displayed
 * @param Array $pregOn RegEx that a file should match to be displayed
 * @param Array $pregOff RegEx that a file shouldn't match to be displayed
 */
  function _wantedFile($excludedFiles, $pregOn, $pregOff, $file){
    $wanted = true;
    $noNSId = noNS($file['id']);
    $wanted &= (! in_array($noNSId, $excludedFiles) );
    foreach ( $pregOn as $preg ){
      $wanted &= preg_match($preg, $noNSId);
    }
    foreach ( $pregOff as $preg ){
      $wanted &= !preg_match($preg, $noNSId);
    }
    return $wanted;
  }

In particular, the “noNS($file['id']);” means that each item is considered without it's namespace. Therefore the page “playground:mytest” will pass even if we put -exclude:playground: . More precisely: there isn't, yet, an option to exclude namespaces recursively. However, it seems a good idea to add one, so I may try to find some time to improve it in 2012 (but I'm afraid it won't be soon). — gturrigturri

Paris 2012/01/01 15:23

• I tried nspages, but I had problems with the -r syntax. I wrote:

” <nspages -subns -r -simpleList>”, and had returned the following message when I tried to save the page: “this namespace doesn't exist: -r”.

• It could be due to an old version of the plugin since it can't reproduce this issue. Could you please try to install the last version and tell me if it fixes your issue? If it doesn't, could you please give me an url where I could observe this bug? — gturrigturri
  
  Paris 2012/01/11 08:33