]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/orphans.mdwn
patch plugin documentation to refer to directive pages
[ikiwiki.git] / doc / plugins / orphans.mdwn
index 895fd18f65cccf6576b33e332bf587e56f256753..e50ee25d0613123d6a2a4449c14512063d56886c 100644 (file)
@@ -1,19 +1,6 @@
-[[template id=plugin name=orphans author="[[Joey]]"]]
-[[tag type/meta]]
+[[!template id=plugin name=orphans author="[[Joey]]"]]
+[[!tag type/meta]]
 
-This plugin generates a list of possibly orphaned pages -- pages that no
+This plugin implements the [[ikiwiki/directive/orphans]] [[ikiwiki/directive]].
+The directive 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.
-
-[[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
-!examples/* and !tips/*"]]
-"""]]