X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/ea08b909d88cd60cd004d366f8c669e8933b6584..bb7ef14a2b411f71f3bb7acb55c6d8215b0b0c82:/doc/plugins/orphans.mdwn diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn index ec61c815b..f7a856ef1 100644 --- a/doc/plugins/orphans.mdwn +++ b/doc/plugins/orphans.mdwn @@ -1,14 +1,20 @@ -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. + +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 +!recentchanges and !examples/* and !tips/* and !sandbox/* and !templates/* and +!wikiicons/* and !plugins/*"]] +"""]]