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

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

diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn
index 05efe28062244a6d67610f905881a939c69c4459..c039a9d1715f5e5d00850cad0bd5c7cef85aaa19 100644 (file)
--- a/doc/plugins/brokenlinks.mdwn
+++ b/doc/plugins/brokenlinks.mdwn
@@ -1,11 +1,9 @@
-This plugin generates a list of broken links on pages in the wiki. This is
-a useful way to find pages that still need to be written, or links that
-are written wrong.
+[[!template id=plugin name=brokenlinks author="[[Joey]]"]]
+[[!tag type/link type/meta]]

 
 

-The optional parameter "pages" can be a [[GlobList]] specifying the pages
-to search for broken links, default is search them all.
+This plugin provides a [[ikiwiki/directive/brokenlinks]] [[ikiwiki/directive]]
+that generates a list of broken links on pages in the wiki.

 
 

-This plugin is included in ikiwiki, but is not enabled by default.
-If it is turned on, here's a list of broken links on this wiki:
+If this plugin is turned on, here's a list of broken links on this wiki:

 
 

-[[brokenlinks ]]
+[[!brokenlinks pages="* and !recentchanges"]]