aboutsummaryrefslogtreecommitdiff
path: root/underlays/basewiki/directive/orphans.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'underlays/basewiki/directive/orphans.mdwn')
-rw-r--r--underlays/basewiki/directive/orphans.mdwn19
1 files changed, 19 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/orphans.mdwn b/underlays/basewiki/directive/orphans.mdwn
new file mode 100644
index 000000000..76c028474
--- /dev/null
+++ b/underlays/basewiki/directive/orphans.mdwn
@@ -0,0 +1,19 @@
+The `orphans` directive is supplied by the [[!iki plugins/orphans]] plugin.
+
+This directive generates a list of possibly orphaned pages -- pages that no
+other page links to.
+
+The optional parameter "pages" can be a [[ikiwiki/PageSpec]] 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.
+
+[[!if test="enabled(orphans)" then="""
+Here's a list of orphaned pages on this wiki:
+
+[[!orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and
+!recentchanges and !examples/* and !tips/* and !sandbox/* and !templates/* and
+!wikiicons/* and !plugins/*"]]
+"""]]