Diff: Help/CalendarListPlugin

Differences between current version and predecessor to the previous major change of Help/CalendarListPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,18 +1,107 @@
-The Help:n | Help: is used in conjunction with the CalendarPlugin. It was written for those who use a wiki as a personal information manager. 
+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. 
+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. 
  
-Usage:  
-<verbatim>  
-<?plugin Calendar ?>  
-<?plugin CalendarList ?>  
-</verbatim>  
+== Usage ==  
  
-Example (click any date and edit it, then return to this page):  
-<?plugin Calendar ? > 
+{{{  
+<< Calendar>>  
+<<CalendarList>>  
+}}}  
  
-<?plugin CalendarList ?>  
+== Example ==  
  
------  
+//Click any date and edit it, then return to this page//:  
  
-PhpWikiDocumentation Help:WikiPlugin  
+<<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>  

current version

The CalendarList plugin is used in conjunction with the 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.

Usage

<<Calendar>>
<<CalendarList>>

Example

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

< April 2024 >
Mon Tue Wed Thu Fri Sat Sun
 1   2   3   4   5   6   7 
 8   9   10   11   12   13   14 
 15   16   17   18   19   20   21 
 22   23   24   25   26   27   28 
 29   30 

Arguments

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

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 Calendar plugin by Martin Norbäck.