pgsrc/Help%2FCalendarPlugin

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