pgsrc/Help%2FCalendarListPlugin

   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%2FCalendarListPlugin,v 1.2 2007-09-01 13:39:47 rurban Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FCalendarListPlugin;
   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 ~CalendarList WikiPlugin is used in conjunction with the [CalendarPlugin |
  13 Help:CalendarPlugin]. It was written for those who use a wiki as a [ personal
  14 information manager | PhpWiki:PersonalWiki ].<br>
  15 Derived from Calendar.php by Martin Norbäck <mailto:martin@safelogic.se>
  16
  17 Just click any date in the calendar, edit the for that date, then come back to
  18 this page. The event should be listed below the calendar.
  19
  20 Honors now year + month args as start base - together with Calendar navigation.
  21 The behaviour before 2007 with last/next_n_days was to start now.
  22
  23 Usage:
  24 <verbatim>
  25 <?plugin Calendar ?>
  26 <?plugin CalendarList ?>
  27 </verbatim>
  28
  29 Example (_click any date and edit it, then return to this page_):
  30
  31 <?plugin Calendar ?>
  32
  33 <?plugin CalendarList ?>
  34
  35
  36 !! Plugin Arguments
  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>prefix</strong>:
  47
  48    Default: Current Page
  49
  50 <strong>date_format</strong>:
  51
  52   Default: '%Y-%m-%d'
  53
  54 <strong>order</strong>:
  55
  56   Report sequence: "normal" or "reverse".
  57   "reverse" displays newest dates first.
  58
  59   Default: PLUGIN_CALENDARLIST_ORDER
  60
  61 <strong>month_offset</strong>:
  62
  63    => 0,
  64
  65 ! Support ranges: next or last N days/events
  66
  67 <strong>next_n_days</strong>:
  68
  69   next_n_days=60: Display entries for the next 60 days / 2 months.
  70
  71   Default: PLUGIN_CALENDARLIST_NEXT_N_DAYS (empty)
  72
  73 <strong>next_n</strong>:
  74
  75   next_n=20: Display only the next 20 entries.
  76
  77   Ignored if next_n_days is defined.
  78
  79   Default: PLUGIN_CALENDARLIST_NEXT_N (empty)
  80
  81 <strong>last_n_days</strong>:
  82
  83   last_n_days=60: Display entries for the last 60 days / 2 months.
  84
  85   Default: PLUGIN_CALENDARLIST_LAST_N_DAYS (empty)
  86
  87 <strong>last_n</strong>:
  88
  89   last_n=20: Display only the last 20 entries.
  90
  91   Ignored if last_n_days is defined.
  92
  93   Default: PLUGIN_CALENDARLIST_LAST_N (empty)
  94
  95 <strong>month_format</strong>:
  96
  97   How to display the Month.<br>
  98   Default: '%B, %Y'
  99
 100 <strong>wday_format</strong>:
 101
 102   How to display the weekday, if supported by your strftime() function.<br>
 103   Default: '%a'
 104
 105 <strong>start_wday</strong>:
 106
 107   Start the week at Sunday or Monday<br>
 108   Default: 1 for Monday
 109
 110 !! Config Options
 111
 112 * PLUGIN_CALENDARLIST_ORDER       = normal
 113 * PLUGIN_CALENDARLIST_NEXT_N_DAYS = ''
 114 * PLUGIN_CALENDARLIST_NEXT_N      = ''
 115 * PLUGIN_CALENDARLIST_LAST_N_DAYS = ''
 116 * PLUGIN_CALENDARLIST_LAST_N      = ''
 117
 118 -----
 119
 120 PhpWikiDocumentation Help:WikiPlugin