move demo back to plugin page
authorJoey Hess <joey@kodama.kitenet.net>
Thu, 11 Sep 2008 21:16:04 +0000 (17:16 -0400)
committerJoey Hess <joey@kodama.kitenet.net>
Thu, 11 Sep 2008 21:17:10 +0000 (17:17 -0400)
We don't want expensive demos in the directives pages. Add an example of
its use instead.

Also, some minor rewording.

doc/plugins/brokenlinks.mdwn
underlays/basewiki/directive/brokenlinks.mdwn

index f2e80d51f6da014e54001c6485e9c4fe42bccbed..c039a9d1715f5e5d00850cad0bd5c7cef85aaa19 100644 (file)
@@ -1,5 +1,9 @@
 [[!template id=plugin name=brokenlinks author="[[Joey]]"]]
 [[!tag type/link type/meta]]
 
-This plugin implements the [[ikiwiki/directive/brokenlinks]] [[ikiwiki/directive]].
-The directive generates a list of broken links on pages in the wiki.
+This plugin provides a [[ikiwiki/directive/brokenlinks]] [[ikiwiki/directive]]
+that generates a list of broken links on pages in the wiki.
+
+If this plugin is turned on, here's a list of broken links on this wiki:
+
+[[!brokenlinks pages="* and !recentchanges"]]
index 3ae8909dc751f002422b8b41eff7708caa63a069..27a333196e9312309019e5bccf5b4d0643835a5c 100644 (file)
@@ -7,6 +7,6 @@ are written wrong.
 The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the
 pages to search for broken links, default is search them all.
 
-If this plugin is turned on, here's a list of broken links on this wiki:
+Example:
 
-[[!brokenlinks pages="* and !recentchanges"]]
+       \[[!brokenlinks pages="* and !recentchanges"]]