====== Display Orphans Plugin ======

---- plugin ----
description: The Display Orphans Plugin can display tables of orphaned, wanted, and linked pages.
author     : jeckel 
email      : jeckelmail@gmail.com 
type       : syntax
lastupdate : 2021-02-05
compatible : Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, !Igor
depends    : 
conflicts  : 
similar    : orphanswanted, orphanmedia, multiorphan, unusedmedias
tags       : display, links, listing, maintenance, missing, orphan, pages, search

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

screenshot_img : 
----

===== Installation =====

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

===== Usage =====

| :!: **ATTENTION** :!: |
| **The following elements automatically disable cacheing of their containing page, similar to including the ''%%~~NOCACHE~~%%'' directive.** |

The plugin offers three block elements that expand into tables listing appropriate pages and other information.

^ Element ^ Description ^
| ''%%<<display orphaned>>%%'' | Displays a table of orphaned pages, ie pages that exist but aren't linked to. |
| ''%%<<display wanted>>%%'' | Displays a table of wanted pages, ie pages that do not exist but are linked to. |
| ''%%<<display linked>>%%'' | Displays a table of linked pages, ie pages that do exist and are linked to. |

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

The plugin provides several settings that can be modified through the [[https://www.dokuwiki.org/config:manager|Configuration Manager]].

^ Setting ^ Default ^ Description ^
| ''show_table_header'' | yes | Specifies whether generated tables should include a header. |
| ''sort_table_ascending'' | yes | Specifies whether generated tables should sort in ascending order; otherwise sort in descending order. |
| ''ignore_orphaned_pages'' | empty | Space-separated list of pages to ignore when generating tables of orphaned pages. |
| ''ignore_orphaned_namespaces'' | empty | Space-separated list of namespaces to ignore when generating tables of orphaned pages. |
| ''ignore_wanted_pages'' | empty | Space-separated list of pages to ignore when generating tables of wanted pages. |
| ''ignore_wanted_namespaces'' | empty | Space-separated list of namespaces to ignore when generating tables of wanted pages. |
| ''ignore_linked_pages'' | empty | Space-separated list of pages to ignore when generating tables of linked pages. |
| ''ignore_linked_namespaces'' | empty | Space-separated list of namespaces to ignore when generating tables of linked pages. |

===== 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/displayorphans/issues|Issue Tracker]].

  * There are currently no know bugs.

===== Discussion =====

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