aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/prettydate.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/prettydate.mdwn')
-rw-r--r--doc/plugins/prettydate.mdwn20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/plugins/prettydate.mdwn b/doc/plugins/prettydate.mdwn
new file mode 100644
index 000000000..149b7c29c
--- /dev/null
+++ b/doc/plugins/prettydate.mdwn
@@ -0,0 +1,20 @@
+[[!template id=plugin name=prettydate author="[[Joey]]"]]
+[[!tag type/date]]
+[[!tag type/chrome]]
+
+Enabling this plugin changes the dates displayed on pages in the wiki to
+a format that is nice and easy to read. Examples: "late Wednesday evening,
+February 14th, 2007", "at midnight, March 15th, 2007"
+
+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 an hour 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.