web commit by tuomov: Explanation etc.

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

diff --git a/doc/plugins/prettydate.mdwn b/doc/plugins/prettydate.mdwn
index 59fa96d6ace0513a422edc05f30c7fe6f0f4c27e..49feaa8e63ec764a87d8fc3a39ee0cf604aafb68 100644 (file)
--- a/doc/plugins/prettydate.mdwn
+++ b/doc/plugins/prettydate.mdwn
@@ -2,17 +2,18 @@
 [[tag type/format]]
 
 Enabling this plugin changes the dates displayed on pages in the wiki to
 [[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.
+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
 
 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
+`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
 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"`.
+prettified time value. The default prettydateformat is `"%X, %B %o, %Y"`.

 
 This plugin uses the [[cpan TimeDate]] perl module.
 
 This plugin uses the [[cpan TimeDate]] perl module.