updated branch; this is ready for review for inclusion in IkIWiki

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

diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
index f7a856ef11e932bc0b654dfa243322c878fcff4d..09ad0a51d695ffc81b627bfde74d3f45348ccc78 100644 (file)
--- a/doc/plugins/orphans.mdwn
+++ b/doc/plugins/orphans.mdwn
@@ -1,20 +1,16 @@
-[[template id=plugin name=orphans author="[[Joey]]"]]
-[[tag type/meta]]
+[[!template id=plugin name=orphans author="[[Joey]]"]]
+[[!tag type/meta]]
+[[!tag type/widget]]

 
 

-This plugin generates a list of possibly orphaned pages -- pages that no
-other page links to.
+This plugin provides the [[ikiwiki/directive/orphans]]
+[[ikiwiki/directive]], which 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="""
+[[!if test="enabled(orphans)" then="""

 Here's a list of orphaned pages on this wiki:
 
 Here's a list of orphaned pages on this wiki:
 

-[[orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and
+[[!orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and

 !recentchanges and !examples/* and !tips/* and !sandbox/* and !templates/* and
 !recentchanges and !examples/* and !tips/* and !sandbox/* and !templates/* and

+!forum/* and !*.js and

 !wikiicons/* and !plugins/*"]]
 """]]
 !wikiicons/* and !plugins/*"]]
 """]]