====== nsindex Plugin ======

---- plugin ----
description: List pages/subnamespaces in current namespace in several ways
author     : Oliver Geisen
email      : oliver@rehkopf-geisen.de
type       : syntax
lastupdate : 2017-07-28
compatible : Frusterick Manners
depends    : 
conflicts  : 
similar    : nspages
tags       : index

downloadurl: https://github.com/igittigitt/dokuwiki-plugin-nsindex/archive/master.zip
bugtracker : https://github.com/igittigitt/dokuwiki-plugin-nsindex/issues
sourcerepo : https://github.com/igittigitt/dokuwiki-plugin-nsindex/

----

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Notes =====

  - The plugin honors ACL settings, so it will list only pages/namespaces where the current user is allowed to access
  - If [[config:useheading]] is set, the resulting list shows pages titles instead of their names
  - Pages using this plugin are not cached at all. This is set internally by the plugin, so there is **no need to add caching-pragma** like ''~~NOCACHE~~''.


===== Examples/Usage =====

The easiest is to use all defaults and just write ''%%{{nsindex}}%%'' inside a page, where the list had to be shown.

=== A ===

  * Activity
  * Alibaba
  * All-In
  * Alpha

=== B ===

  * Backed beans
  * Bold

===== Syntax =====

Without any options, the plugin lists all pages and subnamespaces (only first level) found in the current namespace, ordered and grouped alphabetically. Namespace-index pages (usually named ''start'') are omitted by default.

  {{nsindex}}


To show contents of other namespace than the current one, just add it after the keyword:

  {{nsindex NAMESPACE}}

To change appearance of the list, there are some options:

  {{nsindex OPTION...}}

^ Option ^ Meaning ^
^ ''nopages'' | List subnamespaces in current namespace only |
^ ''nons'' | List pages in current namespace only |
^ ''nogroup'' | Do not add alpha grouping-headers to list |
^ ''notemplate'' | Skip pages named ''template, _template, __template'' |

===== Configuration and Settings =====

This plugin does not have any configuration settings.

=== Change Log ===

{{rss>https://github.com/igittigitt/dokuwiki-plugin-nsindex/commits/master.atom date}}

=== ToDo/Wish List ===


===== Discussion =====

[[plugin:nsindex:discussion]]