]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/CalendarPlugin
added list of existing plugins. fixed typos
[SourceForge/phpwiki.git] / pgsrc / CalendarPlugin
1 Mime-Version: 1.0 (Produced by PhpWiki 1.3.2-jeffs-hacks+carsten's-binary-hack)
2 X-RCS_ID: $Id: CalendarPlugin,v 1.2 2002-01-13 00:02:56 carstenklapp Exp $
3 Content-Type: application/x-phpwiki;
4   pagename=CalendarPlugin;
5   flags="";
6   lastmodified=1010879912;
7 Content-Transfer-Encoding: binary
8
9 The CalendarPlugin can be used to generate a monthly calendar in a wiki page. It's handy for [PersonalWiki]s.
10
11 Individual dates in the calendar link to specially named wiki pages. The names for the "day pages" are by default formed by appending the date to the pagename on which the calendar appears.
12
13 ''This feature was inspired by [Manila|http://manila.userland.com/], and first implemented by GaryBenson. It was later implemented as a WikiPlugin by JeffDairiki.''
14
15 !!Usage:
16  <?plugin Calendar?>
17
18 wil get you:
19 <?plugin Calendar?>
20
21 --------
22
23 !! Plugin Arguments
24
25 !Selection of Month
26
27 ;__year__: Specify the year for the calendar.  (Default: current year.)
28 ;__month__: Specify the month for the calendar.  (Default: current month.)
29 ;__month_offset__: Added to ''month''.  Can be used to include several months worth of calendars on a single wiki page.
30 <?plugin Calendar month_offset=+1?>
31
32 !"Day Page" Names
33
34 ;__date_format__:[Strftime| php-function:strftime] style format string used to generate page names for the "day pages."  The default value is '%Y-%m-%d'.
35 ;__prefix__: Prepended to the date (formatted per ''date_format'') to generate the "day page" names.  The default value is '[[pagename]:'.
36
37 !Appearance
38
39 ;__month_format__: [Strftime| php-function:strftime] style format string used to generate the title of the calendar.  (Default: '%B, %Y'.)
40 ;__wday_format__: [Strftime| php-function:strftime] style format string used to generate the day-of-week names at the top of the calendar.
41 ;__start_wday__: What day of the week does the calendar start on.  This should be specified as an integer in the range zero (Sunday) through six (Saturday), inclusive.
42
43 <?plugin Calendar start_wday=1 ?>
44 -----
45
46 ! Patch for 1.2
47
48 GaryBenson wrote the first calendar implementation for PhpWiki 1.2.  (Since 1.2 doesn't support plugins, it uses a ###CALENDAR### token as a trigger.)  Gary provides a screenshot at http://inauspicious.org/files/screenshots/calender.png, a [patch |http://inauspicious.org/files/phpwiki/phpwiki-1.2.0-calendar.patch] (on 1.2.0), and [calendar.php |http://inauspicious.org/files/phpwiki/calendar.php] (which renders a view of the year.)
49 ----
50 PhpWikiDocumentation