====== Page Navigation ======
[[doku>plugin:pagenav|Page Navigation Plugin]]
===== Syntax and Usage =====

The simplest usage is this:

  [<>]

It will include a navigation bar to browse through all pages in a namespace, displaying all buttons as shown above.

To control which buttons are shown, you can place a number inside the angle brackets:

  [<2>]

The following numbers are recognized:

^ number ^ shown buttons |
| 2      | previous, next |
| 4      | first, last    |
| 6      | first, previous, next, last |
| 8      | start |
| 10     | previous, start, next |
| 12     | first, start, last |

If you want to restrict browsing on pages matching a certain regular expression you can give the expression separated by a space inside the square brackets. E.g. to browse only pages starting with ''a'' you could use this:

  [<> ^a.*]

===== Notes =====

The navigation is cached with the page. When new pages are added to the namespace, the navigation might be wrong until the cache expires. Read [[:caching]] on how to update the cache manually.

You can now use this plugin inside a sidebar (for templates that have one). To make it work in a sidebar you have to disable caching for that sidebar completely using the %%~~NOCACHE~~%% macro in the sidebar page. You should also make sure the sidebar is set up to be hidden through the [[config:hidepages]] option.

Using this plugin together with [[:namespace templates]] might be useful.