pgsrc/Help%2FCalendarListPlugin

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