====== Display Title Plugin ======

---- plugin ----
description: The Display Title Plugin can display the id or title of the current page or the title of an arbitrary page
author     : jeckel 
email      : jeckelmail@gmail.com 
type       : syntax
lastupdate : 2021-01-27
compatible : Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor
depends    : 
conflicts  : 
similar    : var
tags       : display, page, title, id

downloadurl: https://gitlab.com/JayJeckel/displaytitle/-/archive/master/displaytitle-master.zip
bugtracker : https://gitlab.com/JayJeckel/displaytitle/issues
sourcerepo : https://gitlab.com/JayJeckel/displaytitle/
donationurl: 

screenshot_img : 
----

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]] or install directly using the latest [[https://gitlab.com/JayJeckel/displaytitle/-/archive/master/displaytitle-master.zip|download url]], otherwise refer to [[:Plugins]] on how to install plugins manually.

===== Usage =====

The plugin offers three inline elements that expand into the text of either a page id or page title.

^ Element ^ Replaced By ^
| ''%%<<display id>>%%'' | The id of the current page. |
| ''%%<<display title>>%%'' | The title of the current page. |
| ''%%<<display title ID>>%%'' | The title of the page ''ID'' or current page if ''ID'' is empty. |

^ Argument ^ Required ^ Description ^
| ''ID'' | no | Arbitrary local wiki page id as would be passed to normal local wiki links. |

===== Configuration Settings =====

**usePersistent**: store pagetitle (= title) on persistent metadata storage

DokuWiki has two types of metadata storage for each page. They are called “current” and “persistent”. See developer documentation at: [[devel:metadata]]

The usePersistent option allows you to store your page title into persistent metadata $persistent[‘title’] instead of current one. The title will be kept even if DokuWiki may set current metadata $meta[‘title’] to the first heeading depending on useheading settings.

===== Future Plans =====

  * Fix any bugs that are reported.
  * Update as necessary for future DokuWiki versions.

===== Security =====

The plugin has no abnormal security concerns related to the provided functionality.

===== Bugs =====

Bugs should be reported through the [[https://gitlab.com/JayJeckel/displaytitle/issues|Issue Tracker]].

  * There are currently no know bugs.

===== Discussion =====

Discussion should be kept on the [[plugin:displaytitle:discussion|Plugin's Discussion Page]].