Date: Mon, 16 Aug 2008 10:30:24 +0000
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
X-Rcs-Id: $Id: Help%2FCalendarPlugin,v 1.8 2008-08-17 08:00:03 vargenau Exp $
Content-Type: application/x-phpwiki;
  pagename=Help%2FCalendarPlugin;
  flags=PAGE_LOCKED;
  markup=2;
  charset=iso-8859-1
Content-Transfer-Encoding: binary

The *Calendar* plugin can be used to generate a monthly calendar in a
wiki page. It's handy for [personal wikis|PhpWiki:PersonalWiki].

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.

!!! Usage

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

will get you:
<?plugin Calendar ?>

!!! 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.

!! "Day Page" Names

<strong>date_format</strong>:

  [Strftime|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 =~[pagename]/=.

!! Appearance

<strong>month_format</strong>:

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

<strong>wday_format</strong>:

  [Strftime| 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.

!!! Examples

<verbatim>
<?plugin Calendar month_offset=+1 ?>
</verbatim>

will get you:
<?plugin Calendar month_offset=+1 ?>

<verbatim>
<?plugin Calendar start_wday=0 ?>
</verbatim>

will get you:
<?plugin Calendar start_wday=0 ?>

!!! See Also

Help:CalendarListPlugin.

Often used together like this:

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

!!! Authors

This feature was inspired by [Calendar|http://manila.userland.com/],
and first implemented by [Gary Benson|PhpWiki:GaryBenson]. It was later implemented as a
[plugin|Help:WikiPlugin] by [Jeff Dairiki|PhpWiki:JeffDairiki].

----
[PhpWikiDocumentation] [CategoryWikiPlugin]