* Add a prettydate plugin that formats dates in a more readable fashion.

[www/ikiwiki.git] / doc / plugins / prettydate.mdwn

diff --git a/doc/plugins/prettydate.mdwn b/doc/plugins/prettydate.mdwn
new file mode 100644 (file)
index 0000000..59fa96d
--- /dev/null
+++ b/doc/plugins/prettydate.mdwn
@@ -0,0 +1,18 @@
+[[template id=plugin name=prettydate author="[[Joey]]"]]
+[[tag type/format]]
+
+Enabling this plugin changes the dates displayed on pages in the wiki to
+a format that is nice and easy to read.
+
+The names given to each of the hours in the day can be customised by
+setting the `timetable` configuration variable in ikiwiki's setup file.
+The default value of this configuration value can be seen near the top of
+`prettydate.pm`. Note that hours can be left blank, to make it display the
+same as the hour before. Midnight, noon, and teatime are all hardcoded,
+since they do not occupy the whole hour.
+
+The format used for the date can be customised using the `prettydateformat`
+configuration variable in the setup file. `%X` will be expanded to the
+prettified time value. The default prettydateformat is `"%X %B %o, %Y"`.
+
+This plugin uses the [[cpan TimeDate]] perl module.