pgsrc/Help%2FCalendarListPlugin

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