syntax

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

diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
index 95efe3115e7bf5f9df097a150c6b7274bdb185c5..e403c2d189249f8bd6069ab06d594cab3a177253 100644 (file)
--- a/doc/plugins/orphans.mdwn
+++ b/doc/plugins/orphans.mdwn
@@ -1,14 +1,15 @@
-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 provides the [[ikiwiki/directive/orphans]]
+[[ikiwiki/directive]], which 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
-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:
 
-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 ]]
+[[!orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and
+!recentchanges and !examples/* and !tips/* and !sandbox/* and !templates/* and
+!forum/* and !*.js and
+!wikiicons/* and !plugins/*"]]
+"""]]