summaryrefslogtreecommitdiff
path: root/doc/plugins/orphans.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/orphans.mdwn')
-rw-r--r--doc/plugins/orphans.mdwn14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
new file mode 100644
index 000000000..ad16faad5
--- /dev/null
+++ b/doc/plugins/orphans.mdwn
@@ -0,0 +1,14 @@
+This plugin generates a list of orhpaned pages -- pages that no other page
+links to.
+
+The optional parameter "pages" can be a [[GlobList]] specifying the pages
+to check for orphans, default is search them all.
+
+Note that it takes backlinks into account, but does not count inlining a
+page as linking to it, so will generally count many blog-type pages as
+orphans.
+
+This plugin is included in ikiwiki, but is not enabled by default.
+If it is turned on, here's a list of orphaned pages on this wiki:
+
+[[orphans ]]