Document the 'generated' keyword argument

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

diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
index 0c2ea69da42c1271e4ef3c241a53147dc678ad28..136ce42a7def2ba09237204ce15cc8a31f959ecd 100644 (file)
--- a/doc/plugins/orphans.mdwn
+++ b/doc/plugins/orphans.mdwn
@@ -1,16 +1,20 @@
-This plugin generates a list of possibly 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.
+
+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.
 
 
 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 ]]
+[[!if test="enabled(orphans)" then="""
+Here's a list of orphaned pages on this wiki:

 
 

-[[tag type/meta]]
+[[!orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and
+!recentchanges and !examples/* and !tips/* and !sandbox/* and !templates/* and
+!wikiicons/* and !plugins/*"]]
+"""]]