pgsrc/Help%2FCalendarPlugin

   1 Date: Mon, 26 Jun 2008 14:15:24 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id: Help%2FCalendarPlugin,v 1.5 2008-06-27 20:03:55 vargenau Exp $
   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* plugin can be used to generate a monthly calendar in a
  12 wiki page. It's handy for PhpWiki:PersonalWiki~s.
  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 _This feature was inspired by Calendar |http://manila.userland.com/],
  19 and first implemented by [Gary Benson|PhpWiki:GaryBenson]. It was later implemented as a
  20 [plugin|Help:WikiPlugin] by [Jeff Dairiki|PhpWiki:JeffDairiki]._
  21
  22 !!! Usage
  23
  24 <verbatim>
  25 <?plugin Calendar?>
  26 </verbatim>
  27
  28 will get you:
  29 <?plugin Calendar?>
  30
  31 !!! Arguments
  32
  33 !! Selection of Month
  34
  35 <strong>year</strong>:
  36
  37   Specify the year for the calendar.  (Default: current year.)
  38
  39 <strong>month</strong>:
  40
  41   Specify the month for the calendar.  (Default: current month.)
  42
  43 <strong>month_offset</strong>:
  44
  45   Added to ''month''. Can be used to include several months worth of
  46   calendars on a single wiki page.
  47
  48   <?plugin Calendar month_offset=+1?>
  49
  50 !! "Day Page" Names
  51
  52 <strong>date_format</strong>:
  53
  54    Help:e | php-function:strftime] style format string used to
  55   generate page names for the "day pages." The default value is
  56   =%Y-%m-%d=.
  57
  58 <strong>prefix</strong>:
  59
  60   Prepended to the date (formatted per ''date_format'') to generate
  61   the "day page" names. The default value is =~ Help:e ]/=.
  62
  63 !! Appearance
  64
  65 <strong>month_format</strong>:
  66
  67    Help:e | php-function:strftime] style format string used to
  68   generate the title of the calendar. (Default: =%B, %Y=.)
  69
  70 <strong>wday_format</strong>:
  71
  72    Help:e | php-function:strftime] style format string used to
  73   generate the day-of-week names at the top of the calendar.
  74
  75 <strong>start_wday</strong>:
  76
  77   What day of the week does the calendar start on. This should be
  78   specified as an integer in the range zero (Sunday) through six
  79   (Saturday), inclusive.
  80
  81   <?plugin Calendar start_wday=1 ?>
  82
  83 !!! See Also
  84
  85 Help:CalendarListPlugin.
  86
  87 Often used together like this:
  88
  89 <verbatim>
  90 <?plugin Calendar?>
  91 <?plugin CalendarList?>
  92 </verbatim>
  93
  94 -----
  95
  96 !!! Patch for 1.2
  97
  98 [Gary Benson|PhpWiki:GaryBenson] wrote the first calendar implementation for PhpWiki 1.2.
  99 (Since 1.2 doesn't support plugins, it uses a =###CALENDAR###= token
 100 as a trigger.)
 101 Gary provides a screenshot at [ http://inauspicious.org/files/screenshots/calender.png | screenshot ],
 102 a  Help:h  | http://inauspicious.org/files/phpwiki/phpwiki-1.2.0-calendar.patch] (on 1.2.0), and
 103  Help:r .php | http://inauspicious.org/files/phpwiki/calendar.php]
 104 (which renders a view of the year.)
 105
 106 ----
 107
 108 [PhpWikiDocumentation] [CategoryWikiPlugin]