Date: Wed, 29 Aug 2007 09:31:31 +0200
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20070828)
X-Rcs-Id: $Id: Help%2FCalendarPlugin,v 1.2 2007-09-01 13:40:12 rurban Exp $
Content-Type: application/x-phpwiki;
  pagename=Help%2FCalendarPlugin;
  pgsrc_version="2 $Revision: 1.2 $";
  flags="";
  markup=2;
  charset=iso-8859-1
Content-Transfer-Encoding: binary

The [CalendarPlugin | Help:CalendarPlugin]  can be used to generate a monthly calendar in a
wiki page. It's handy for PhpWiki:PersonalWiki~s.

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.

_This feature was inspired by Calendar |http://manila.userland.com/],
and first implemented by PhpWiki:GaryBenson. It was later implemented as a
Help:WikiPlugin by PhpWiki:JeffDairiki._

!!Usage:

<verbatim>
<?plugin Calendar?>
</verbatim>

will get you:
<?plugin Calendar?>

--------

!! Plugin Arguments

!Selection of Month

<strong>year</strong>:

  Specify the year for the calendar.  (Default: current year.)

<strong>month</strong>:

  Specify the month for the calendar.  (Default: current month.)

<strong>month_offset</strong>:

  Added to ''month''. Can be used to include several months worth of
  calendars on a single wiki page.

  <?plugin Calendar month_offset=+1?>

!"Day Page" Names

<strong>date_format</strong>:

   Help:e | php-function:strftime] style format string used to
  generate page names for the "day pages." The default value is
  =%Y-%m-%d=.

<strong>prefix</strong>:

  Prepended to the date (formatted per ''date_format'') to generate
  the "day page" names. The default value is =~ Help:e ]/=.

!Appearance

<strong>month_format</strong>:

   Help:e | php-function:strftime] style format string used to
  generate the title of the calendar. (Default: =%B, %Y=.)

<strong>wday_format</strong>:

   Help:e | php-function:strftime] style format string used to
  generate the day-of-week names at the top of the calendar.

<strong>start_wday</strong>:

  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.

  <?plugin Calendar start_wday=1 ?>

! See also

Help:CalendarListPlugin.

Often used together like this:

<verbatim>
<?plugin Calendar?>
<?plugin CalendarList?>
</verbatim>

-----

! Patch for 1.2

PhpWiki: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 | screenshot ], 
a  Help:h  | http://inauspicious.org/files/phpwiki/phpwiki-1.2.0-calendar.patch] (on 1.2.0), and
 Help:r .php | http://inauspicious.org/files/phpwiki/calendar.php]
(which renders a view of the year.)

----

PhpWikiDocumentation Help:WikiPlugin