Differences

This shows you the differences between two versions of the page.

--- plugin:docnavigation [2014-12-29 00:35] – Klap-in
+++ plugin:docnavigation [2023-01-23 00:25] (current) – Klap-in
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: Add navigation links to previous and next page at the top and bottom of wiki page.
+description: Add navigation links to previous and next page at the top and bottom of wiki page
 author     : Gerrit Uitslag
 email      : klapinklapin@gmail.com
 type       : syntax, action
-lastupdate : 2014-12-27
+lastupdate : 2023-01-23
-compatible : Hrun
+compatible : Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor
 depends    :
-conflicts  :
+conflicts  : bloglinks
 similar    : pagenav
-tags       : navigation, listing
+tags       : navigation, listing, browse
 downloadurl: https://github.com/Klap-in/dokuwiki-plugin-docnavigation/archive/master.zip
@@ Line 23: / Line 23: @@
 ===== Installation =====
 Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
@@ Line 32: / Line 31: @@
   <- namespace:previous_page ^ namespace:startpage ^ namespace:next page ->
+or, alternatively, only different syntax (for example needed in combination with [[ckgedit]] plugin)
+  << namespace:previous_page ^ namespace:startpage ^ namespace:next page >>
 And at the start page an auto-generated table of contents can be put using
@@ Line 38: / Line 40: @@
 ===== Syntax =====
-===Page navigation===
+=== Page navigation ===
 Urls are shown with default link names derived from url or [[config:useheading]] setting.
 <code>
@@ Line 52: / Line 56: @@
 {{:plugin:docnavigation_pagenav.png|Page with navigation links}}
-===Table of contents generated from linked pages===
+=== Table of contents generated from linked pages ===
 A Table of Contents of the linked pages can be created with ''<doctoc //optionname=value[, more=..]//>''.
@@ Line 62: / Line 67: @@
 possible options:
 ^Option                                       ^ Description^
-|''start=<pageid>''                           |Pageid of the first page, if left out the page navigation is searched on the current page.|
+|''start=<pageid>''                           |Pageid of the first page with page navigation, 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) |
+|''hidepagelink=<0 or 1>''                      |Hide the page links, but shows default the first two levels of the table of content. With ''includeheadings'' setting the number of levels can be changed. If only ''includeheadings'' is used, the page links are shown, which can result in duplicated titles if level 1 is shown.|
 |''useheading=<0 or 1>''                      |Overrules the 'navigation' case of the [[config:useheading]] setting.|
@@ Line 78: / Line 84: @@
 Please report all your bugs and feature requests at the [[https://github.com/Klap-in/dokuwiki-plugin-docnavigation/issues|issue tracker]].