ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / prettydate.mdwn
1 [[!template id=plugin name=prettydate author="[[Joey]]"]]
2 [[!tag type/date]]
3 [[!tag type/chrome]]
4
5 Enabling this plugin changes the dates displayed on pages in the wiki to
6 a format that is nice and easy to read. Examples: "late Wednesday evening, 
7 February 14th, 2007", "at midnight, March 15th, 2007"
8
9 The names given to each of the hours in the day can be customised by
10 setting the `timetable` configuration variable in ikiwiki's setup file.
11 The default value of this configuration value can be seen near the top of
12 `prettydate.pm`. Note that an hour can be left blank, to make it display the
13 same as the hour before. Midnight, noon, and teatime are all hardcoded,
14 since they do not occupy the whole hour.
15
16 The format used for the date can be customised using the `prettydateformat`
17 configuration variable in the setup file. `%X` will be expanded to the
18 prettified time value. The default prettydateformat is `"%X, %B %o, %Y"`.
19
20 This plugin uses the [[!cpan TimeDate]] perl module.