]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/orphans.mdwn
reformat
[git.ikiwiki.info.git] / doc / plugins / orphans.mdwn
index 66c10c0c24102c2306a2e17b383e74881230f3dd..798a5c8c281f03e4a0290415cb2674faa0dc0763 100644 (file)
@@ -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
-to check for orphans, default is search them all.
+This plugin generates a list of possibly orphaned pages -- pages that no
+other page links to.
 
-Note that it takes [[backlinks]] into account, but does not count inlining a
+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.
 
-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/* and !sandbox/* and !wikiicons/* and !plugins/*"]]
+"""]]