pgsrc/Help%2FCalendarListPlugin

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