aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/pagestats.mdwn13
-rw-r--r--doc/tags.mdwn3
-rw-r--r--doc/todo/plugin.mdwn2
3 files changed, 17 insertions, 1 deletions
diff --git a/doc/plugins/pagestats.mdwn b/doc/plugins/pagestats.mdwn
new file mode 100644
index 000000000..41c853b16
--- /dev/null
+++ b/doc/plugins/pagestats.mdwn
@@ -0,0 +1,13 @@
+This plugin can generate stats about how pages link to each other. It can
+produce either a del.icio.us style cloud, or a table counting the number of
+links to each page.
+
+Here's how to use it to create a [[tag]] cloud:
+
+ \[[pagestats pages="tags/*"]]
+
+And here's how to create a table of all the pages on the wiki:
+
+ \[[pagestats style="table"]]
+
+This plugin is included in ikiwiki, but is not enabled by default.
diff --git a/doc/tags.mdwn b/doc/tags.mdwn
index 36753a5b4..8d3a85cef 100644
--- a/doc/tags.mdwn
+++ b/doc/tags.mdwn
@@ -17,3 +17,6 @@ One way to use these tags is to create a [[blog]] of pages that have a
particular set of tags. Or just look at the [[BackLinks]] to a tag page to
see all the pages that are tagged with it. [[Plugins]] can be written to do
anything else with tags that you might desire.
+
+Once you have tags, you can use the [[plugins/pagestats]] plugin to
+generate tag clouds.
diff --git a/doc/todo/plugin.mdwn b/doc/todo/plugin.mdwn
index 7f427ec96..0f37d6190 100644
--- a/doc/todo/plugin.mdwn
+++ b/doc/todo/plugin.mdwn
@@ -6,7 +6,7 @@ Suggestions of ideas for plugins:
* a [[link_map]]
* [[sigs]] ?
* [[pageindexes]]
-* Wiki stats, such as total number of links, most linked to pages
+* Wiki stats, such as total number of links, most linked to pages (done)
* Support [[RecentChanges]] as a regular page containing a plugin that
updates each time there is a change, and statically builds the recent