doc update, add --exclude ikiwiki.cgi to examples

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

diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
index 136ce42a7def2ba09237204ce15cc8a31f959ecd..ea7c4df13f42aba0a83a3b957cd3fcc621d89e69 100644 (file)
--- a/doc/plugins/orphans.mdwn
+++ b/doc/plugins/orphans.mdwn
@@ -1,15 +1,9 @@
 [[!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
-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 provides the [[ikiwiki/directive/orphans]]
+[[ikiwiki/directive]], which generates a list of possibly orphaned pages --
+pages that no other page links to.

 
 [[!if test="enabled(orphans)" then="""
 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: