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