pgsrc/Help%2FCalendarPlugin

   1 Date: Sat, 24 Jan 2009 20:18:24 +0100
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FCalendarPlugin;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 The *Calendar* [[Help:WikiPlugin|plugin]] can be used to generate a monthly calendar in a
  12 wiki page. It's handy for [personal wikis|PhpWiki:PersonalWiki].
  13
  14 Individual dates in the calendar link to specially named wiki pages.
  15 The names for the "day pages" are by default formed by appending the
  16 date to the pagename on which the calendar appears.
  17
  18 == Usage
  19
  20 <verbatim>
  21 <?plugin Calendar ?>
  22 </verbatim>
  23
  24 will get you:
  25 <?plugin Calendar ?>
  26
  27 == Arguments
  28
  29 === Selection of Month
  30
  31 <strong>year</strong>:
  32
  33   Specify the year for the calendar.  (Default: current year.)
  34
  35 <strong>month</strong>:
  36
  37   Specify the month for the calendar.  (Default: current month.)
  38
  39 <strong>month_offset</strong>:
  40
  41   Added to ''month''. Can be used to include several months worth of
  42   calendars on a single wiki page.
  43
  44 === "Day Page" Names
  45
  46 <strong>date_format</strong>:
  47
  48   [Strftime|php-function:strftime] style format string used to
  49   generate page names for the "day pages." The default value is
  50   =%Y-%m-%d=.
  51
  52 <strong>prefix</strong>:
  53
  54   Prepended to the date (formatted per ''date_format'') to generate
  55   the "day page" names. The default value is =~[pagename]/=.
  56
  57 === Appearance
  58
  59 <strong>month_format</strong>:
  60
  61   [Strftime| php-function:strftime] style format string used to
  62   generate the title of the calendar. (Default: =%B %Y=.)
  63
  64 <strong>wday_format</strong>:
  65
  66   [Strftime| php-function:strftime] style format string used to
  67   generate the day-of-week names at the top of the calendar.
  68
  69 <strong>start_wday</strong>:
  70
  71   What day of the week does the calendar start on. This should be
  72   specified as an integer in the range zero (Sunday) through six
  73   (Saturday), inclusive.
  74
  75 == Examples
  76
  77 <verbatim>
  78 <?plugin Calendar month_offset=+1 ?>
  79 </verbatim>
  80
  81 will get you:
  82 <?plugin Calendar month_offset=+1 ?>
  83
  84 <verbatim>
  85 <?plugin Calendar start_wday=0 ?>
  86 </verbatim>
  87
  88 will get you:
  89 <?plugin Calendar start_wday=0 ?>
  90
  91 == See Also
  92
  93 Help:CalendarListPlugin.
  94
  95 Often used together like this:
  96
  97 <verbatim>
  98 <?plugin Calendar ?>
  99 <?plugin CalendarList ?>
 100 </verbatim>
 101
 102 == Authors
 103
 104 This feature was inspired by [Calendar|http://manila.userland.com/],
 105 and first implemented by [Gary Benson|PhpWiki:GaryBenson]. It was later implemented as a
 106 [[Help:WikiPlugin|plugin]] by [Jeff Dairiki|PhpWiki:JeffDairiki].
 107
 108 ----
 109 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]