1# Display Orphans Dokuwiki Plugin
2
3[![MIT License](https://svgshare.com/i/TRb.svg)](https://opensource.org/licenses/MIT)
4[![DokuWiki Plugin](https://svgshare.com/i/TSa.svg)](https://www.dokuwiki.org/dokuwiki)
5[![Plugin Home](https://svgshare.com/i/TRw.svg)](https://www.dokuwiki.org/plugin:displayorphans)
6[![Gitlab Repo](https://svgshare.com/i/TRR.svg)](https://gitlab.com/JayJeckel/displayorphans)
7[![Gitlab Issues](https://svgshare.com/i/TSw.svg)](https://gitlab.com/JayJeckel/displayorphans/issues)
8[![Gitlab Download](https://svgshare.com/i/TT5.svg)](https://gitlab.com/JayJeckel/displayorphans/repository/archive.zip?ref=master)
9
10The Display Orphans Plugin can display tables of orphaned, wanted, and linked pages.
11
12## Installation
13
14Search and install the plugin using the [Extension Manager](https://www.dokuwiki.org/plugin:extension) or install directly using the latest [download url](https://gitlab.com/JayJeckel/displayorphans/repository/archive.zip?ref=master), otherwise refer to [Plugins](https://www.dokuwiki.org/plugins) on how to install plugins manually.
15
16## Usage
17
18| :warning: **ATTENTION** :warning: |
19|-|
20| **The following elements automatically disable cacheing of their containing page, similar to including the `~~NOCACHE~~` directive.** |
21
22The plugin offers three block elements that expand into tables listing appropriate pages and other information.
23
24| Element | Description |
25|:-|:-|
26| `<<display orphaned>>` | Displays a table of orphaned pages, ie pages that exist but aren't linked to. |
27| `<<display wanted>>` | Displays a table of wanted pages, ie pages that do not exist but are linked to. |
28| `<<display linked>>` | Displays a table of linked pages, ie pages that do exist and are linked to. |
29
30## Configuration Settings
31
32The plugin provides several settings that can be modified through the [Configuration Manager](https://www.dokuwiki.org/config:manager).
33
34| Option | Default | Description |
35|:-|:-|:-|
36| `show_table_header` | yes | Specifies whether generated tables should include a header. |
37| `sort_table_ascending` | yes | Specifies whether generated tables should sort in ascending order; otherwise sort in descending order. |
38| `ignore_orphaned_pages` | empty | Space-separated list of pages to ignore when generating tables of orphaned pages. |
39| `ignore_orphaned_namespaces` | empty | Space-separated list of namespaces to ignore when generating tables of orphaned pages. |
40| `ignore_wanted_pages` | empty | Space-separated list of pages to ignore when generating tables of wanted pages. |
41| `ignore_wanted_namespaces` | empty | Space-separated list of namespaces to ignore when generating tables of wanted pages. |
42| `ignore_linked_pages` | empty | Space-separated list of pages to ignore when generating tables of linked pages. |
43| `ignore_linked_namespaces` | empty | Space-separated list of namespaces to ignore when generating tables of linked pages. |
44
45## Security
46
47The plugin has no abnormal security concerns related to the provided functionality.
48