web commit by PaulWise

[ikiwiki.git] / doc / plugins / orphans.mdwn

diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
index ec61c815b95ba83c2b0bdd98b4d8cb3c84dce212..895fd18f65cccf6576b33e332bf587e56f256753 100644 (file)
--- a/doc/plugins/orphans.mdwn
+++ b/doc/plugins/orphans.mdwn
@@ -1,14 +1,19 @@
-This plugin generates a list of orphaned pages -- pages that no other page
-links to.
+[[template id=plugin name=orphans author="[[Joey]]"]]
+[[tag type/meta]]
 
-The optional parameter "pages" can be a [[GlobList]] specifying the pages
+This plugin generates a list of possibly orphaned pages -- pages that no
+other page links to.
+
+The optional parameter "pages" can be a [[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.
 
-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:
+[[if test="enabled(orphans)" then="""
+Here's a list of orphaned pages on this wiki:
 
-[[orphans ]]
+[[orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and
+!examples/* and !tips/*"]]
+"""]]