Date: Tue, 29 Jul 2014 10:42:12 +0000
Mime-Version: 1.0 (Produced by PhpWiki 1.5.0)
Content-Type: application/x-phpwiki;
  pagename=Help%2FCalendarListPlugin;
  flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
  charset=UTF-8
Content-Transfer-Encoding: binary

The **~CalendarList** [[Help:WikiPlugin|plugin]] is used in conjunction with the [[Help:CalendarPlugin|Calendar]] plugin.
It was written for those who use a wiki as a personal information manager.

Just click any date in the calendar, edit the for that date, then come back to
this page. The event should be listed below the calendar.

Honors now year + month args as start base - together with Calendar navigation.
The behaviour before 2007 with last/next_n_days was to start now.

== Usage ==

{{{
<<Calendar>>
<<CalendarList>>
}}}

== Example ==

//Click any date and edit it, then return to this page//:

<<Calendar>>

<<CalendarList>>

== Arguments ==

{| class="bordered"
|-
! Argument
! Description
! Default value
|-
| **year**
| Specify the year for the calendar.
| Current year
|-
| **month**
| Specify the month for the calendar.
| Current month
|-
| **prefix**
| Prefix
| Current page
|-
| **date_format**
| Date format
| %Y-%m-%d
|-
| **order**
| Report sequence: "normal" or "reverse".  "reverse" displays newest dates first.
| PLUGIN_CALENDARLIST_ORDER
|-
| **month_offset**
| Month offset
| 0
|}

=== Support ranges: next or last N days/events ===

{| class="bordered"
|-
! Argument
! Description
! Default value
|-
| **next_n_days**
| next_n_days=60: Display entries for the next 60 days / 2 months.
| PLUGIN_CALENDARLIST_NEXT_N_DAYS (empty)
|-
| **next_n**
| next_n=20: Display only the next 20 entries. Ignored if next_n_days is defined.
| PLUGIN_CALENDARLIST_NEXT_N (empty)
|-
| **last_n_days**
| last_n_days=60: Display entries for the last 60 days / 2 months.
| PLUGIN_CALENDARLIST_LAST_N_DAYS (empty)
|-
| **last_n**
| last_n=20: Display only the last 20 entries. Ignored if last_n_days is defined.
| PLUGIN_CALENDARLIST_LAST_N (empty)
|-
| **month_format**
| How to display the Month.
| %B %Y
|-
| **wday_format**
| How to display the weekday, if supported by your strftime() function.
| %a
|-
| **start_wday**
| Start the week at Sunday or Monday
| 1 for Monday
|}

== Config Options ==

* PLUGIN_CALENDARLIST_ORDER       = normal
* PLUGIN_CALENDARLIST_NEXT_N_DAYS = ''
* PLUGIN_CALENDARLIST_NEXT_N      = ''
* PLUGIN_CALENDARLIST_LAST_N_DAYS = ''
* PLUGIN_CALENDARLIST_LAST_N      = ''

== Author ==

Derived from [[Help:CalendarPlugin|Calendar]] plugin by [[mailto:martin@safelogic.se|Martin Norbäck]].

<noinclude>
----
[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
</noinclude>
