pgsrc/Help%2FCalendarListPlugin

   1 Date: Fri, 10 Sep 2010 13:46:13 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC1)
   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 {| class="bordered"
  38 |-
  39 ! Argument
  40 ! Description
  41 ! Default value
  42 |-
  43 | **year**
  44 | Specify the year for the calendar.
  45 | Current year
  46 |-
  47 | **month**
  48 | Specify the month for the calendar.
  49 | Current month
  50 |-
  51 | **prefix**
  52 | Prefix
  53 | Current page
  54 |-
  55 | **date_format**
  56 | Date format
  57 | %Y-%m-%d
  58 |-
  59 | **order**
  60 | Report sequence: "normal" or "reverse".  "reverse" displays newest dates first.
  61 | PLUGIN_CALENDARLIST_ORDER
  62 |-
  63 | **month_offset**
  64 | Month offset
  65 | 0
  66 |}
  67
  68 === Support ranges: next or last N days/events ===
  69
  70 {| class="bordered"
  71 |-
  72 ! Argument
  73 ! Description
  74 ! Default value
  75 |-
  76 | **next_n_days**
  77 | next_n_days=60: Display entries for the next 60 days / 2 months.
  78 | PLUGIN_CALENDARLIST_NEXT_N_DAYS (empty)
  79 |-
  80 | **next_n**
  81 | next_n=20: Display only the next 20 entries. Ignored if next_n_days is defined.
  82 | PLUGIN_CALENDARLIST_NEXT_N (empty)
  83 |-
  84 | **last_n_days**
  85 | last_n_days=60: Display entries for the last 60 days / 2 months.
  86 | PLUGIN_CALENDARLIST_LAST_N_DAYS (empty)
  87 |-
  88 | **last_n**
  89 | last_n=20: Display only the last 20 entries. Ignored if last_n_days is defined.
  90 | PLUGIN_CALENDARLIST_LAST_N (empty)
  91 |-
  92 | **month_format**
  93 | How to display the Month.
  94 | %B %Y
  95 |-
  96 | **wday_format**
  97 | How to display the weekday, if supported by your strftime() function.
  98 | %a
  99 |-
 100 | **start_wday**
 101 | Start the week at Sunday or Monday
 102 | 1 for Monday
 103 |}
 104
 105 == Config Options ==
 106
 107 * PLUGIN_CALENDARLIST_ORDER       = normal
 108 * PLUGIN_CALENDARLIST_NEXT_N_DAYS = ''
 109 * PLUGIN_CALENDARLIST_NEXT_N      = ''
 110 * PLUGIN_CALENDARLIST_LAST_N_DAYS = ''
 111 * PLUGIN_CALENDARLIST_LAST_N      = ''
 112
 113 == Author ==
 114
 115 Derived from [[Help:CalendarPlugin|Calendar]] plugin by [[mailto:martin@safelogic.se|Martin Norbäck]].
 116
 117 <noinclude>
 118 ----
 119 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
 120 </noinclude>