urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/underlays/basewiki/directive/calendar.mdwn

47 lines
2.0 KiB
Plaintext
Raw Normal View History

add underlay files for listdirectives As was noted, 'listdirectives' didn't include the underlay files that make it really worthwhile. I've just gone through all the plugin documentation, modified it to remove installation information and renamed the files to match the directives rather than the plugins. This can now serve as useful underlay. I've only gone through plugins in the 'plugins' dir. I did not go through the 'contrib' dir.
2008-09-11 23:04:23 +02:00
The `calendar` directive is supplied by the [[!iki plugins/calendar]] plugin.
reorg from will's changes The info about the cron job was lost (!), as was a paragraph about what pages the calendar links to. The CSS docs seems to fit better in the plugin page than the directive page, moved it back.
2008-09-11 23:21:14 +02:00
This plugin requires extra setup. See the plugin documentation for details.
add underlay files for listdirectives As was noted, 'listdirectives' didn't include the underlay files that make it really worthwhile. I've just gone through all the plugin documentation, modified it to remove installation information and renamed the files to match the directives rather than the plugins. This can now serve as useful underlay. I've only gone through plugins in the 'plugins' dir. I did not go through the 'contrib' dir.
2008-09-11 23:04:23 +02:00
This directive displays a calendar, similar to the typical calendars shown on
some blogs.
# examples
\[[!calendar ]]
\[[!calendar type="month" pages="blog/* and !*/Discussion"]]
\[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]]
reorg from will's changes The info about the cron job was lost (!), as was a paragraph about what pages the calendar links to. The CSS docs seems to fit better in the plugin page than the directive page, moved it back.
2008-09-11 23:21:14 +02:00
The calendar is essentially a fancy front end to archives of previous
pages, usually used for blogs. It can produce a calendar for a given month,
or a list of months for a given year.
add underlay files for listdirectives As was noted, 'listdirectives' didn't include the underlay files that make it really worthwhile. I've just gone through all the plugin documentation, modified it to remove installation information and renamed the files to match the directives rather than the plugins. This can now serve as useful underlay. I've only gone through plugins in the 'plugins' dir. I did not go through the 'contrib' dir.
2008-09-11 23:04:23 +02:00
reorg from will's changes The info about the cron job was lost (!), as was a paragraph about what pages the calendar links to. The CSS docs seems to fit better in the plugin page than the directive page, moved it back.
2008-09-11 23:21:14 +02:00
The month format calendar simply links to any page posted on each
day of the month. The year format calendar links to archive pages, with
names like `archives/2007` (for all of 2007) and `archives/2007/01`
(for January, 2007). For this to work, you'll need to create these archive
pages. They typically use [[inline]] to display or list pages created in
the given time frame.
add underlay files for listdirectives As was noted, 'listdirectives' didn't include the underlay files that make it really worthwhile. I've just gone through all the plugin documentation, modified it to remove installation information and renamed the files to match the directives rather than the plugins. This can now serve as useful underlay. I've only gone through plugins in the 'plugins' dir. I did not go through the 'contrib' dir.
2008-09-11 23:04:23 +02:00
## usage
* `type` - Used to specify the type of calendar wanted. Can be one of
"month" or "year". The default is a month view calendar.
* `pages` - Specifies the [[ikiwiki/PageSpec]] of pages to link to from the
month calendar. Defaults to "*".
* `archivebase` - Configures the base of the archives hierarchy. The
default is "archives". Note that this default can also be overridden
for the whole wiki by setting `archivebase` in ikiwiki's setup file.
* `year` - The year for which the calendar is requested. Defaults to the
current year.
* `month` - The numeric month for which the calendar is requested, in the
range 1..12. Used only for the month view calendar, and defaults to the
current month.
* `week_start_day` - A number, in the range 0..6, which represents the day
of the week that the month calendar starts with. 0 is Sunday, 1 is Monday,
and so on. Defaults to 0, which is Sunday.
* `months_per_row` - In the annual calendar, number of months to place in
each row. Defaults to 3.
add robots directive to all directive pages Since they'll be in an underlay, robots shouldn't index them, as with other underlay pages.
2008-09-12 00:30:20 +02:00
[[!meta robots="noindex, follow"]]