DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:docnavigation

DocNavigation Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes

plugin Add navigation links to previous and next page at the top and bottom of wiki page.

Last updated on
2014-12-27
Provides
Syntax, Action
Repository
Source
Conflicts with
bloglinks

Similar to pagenav

Tagged with listing, navigation

Installation

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

Usage

The syntax defines which pages are referred to as previous and next pages. A start page or page with an overview can be provided in between.

<- namespace:previous_page ^ namespace:startpage ^ namespace:next page ->

And at the start page an auto-generated table of contents can be put using

<doctoc start= yournamespace:firstpage>

Syntax

Urls are shown with default link names derived from url or useheading setting.

<-namespace:previous^namespace:startpage^namespace:next->

Urls are shown with the given names.

<-previous|Your previous page^startpage|Overview^other_page|Navigate to next page ->

Example of navigation added by the DocNavigation Plugin. Here the useheading config is enabled such that the page headings are used as link name. Page with navigation links

Table of contents generated from linked pages

A Table of Contents of the linked pages can be created with <doctoc optionname=value[, more=..]>.

<doctoc>
<doctoc start=firstpage, includeheadings=2-3>

possible options:

Option Description
start=<pageid> Pageid of the first page, if left out the page navigation is searched on the current page.
includeheadings=<topheading>-<maxheading>Includes the given heading levels of a page in the table of content. e.g 2-3 Default: 2 (levels are numbered from 1 to 5)
useheading=<0 or 1> Overrules the 'navigation' case of the useheading setting.

Development

Change Log

Bugs and feature requests

Please report all your bugs and feature requests at the issue tracker.

plugin/docnavigation.txt · Last modified: 2016-08-11 23:30 by Klap-in