Diff: Help/CalendarPlugin

Note: You are viewing an old revision of this page. View the current version.

Differences between version 3 and previous revision of Help/CalendarPlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 3 Last edited on 26 January 2012 15:51 by harold Revert
Older page: version 2 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,100 +1,89 @@
-The **Calendar** [[ Help:WikiPlugin |plugin]] can be used to generate a monthly calendar in a  
-wiki page. It's handy for [[ PhpWiki:PersonalWiki|personal wikis]] . 
+The Help:n | Help: can be used to generate a monthly calendar in a  
+wiki page. It's handy for PhpWiki:PersonalWiki~s . 
  
 Individual dates in the calendar link to specially named wiki pages. 
 The names for the "day pages" are by default formed by appending the 
 date to the pagename on which the calendar appears. 
  
-== Usage ==  
+_This feature was inspired by Help:a |http://manila.userland.com/],  
+and first implemented by PhpWiki:GaryBenson. It was later implemented as a  
+Help:WikiPlugin by PhpWiki:JeffDairiki._  
  
-{{{  
-<<Calendar> >  
-}}}  
+!!Usage:  
+  
+<verbatim>  
+ <?plugin Calendar? >  
+</verbatim>  
  
 will get you: 
-<< Calendar> > 
+<?plugin Calendar? > 
  
-== Arguments ==  
+--------  
  
-{| class="bordered"  
-|-  
- ! Argument  
- ! Description  
-! Default value  
-|-  
-| colspan="3" align="center" | **Selection of Month**  
-|-  
-| **year**  
-| Specify the year for the calendar.  
-| Current year  
-|-  
-| **month**  
-| Specify the month for the calendar.  
-| Current month  
-|-  
-| **month_offset**  
-| Added to //month//. Can be used to include several months worth of calendars on a single wiki page.  
-| 0  
-|-  
-| colspan="3" align="center" | **"Day Page" Names**  
-|-  
-| **date_format**  
-| [[php-function:strftime|strftime]] style format string used to generate page names for the "day pages."  
-| The default value is =%Y-%m-%d=.  
-|-  
-| **prefix**  
-| Prepended to the date (formatted per //date_format//) to generate the "day page" names.  
-| The default value is =~[pagename]/=.  
-|-  
-| colspan="3" align="center" | **Appearance**  
-|-  
-| **month_format**  
-| [[php-function:strftime|strftime]] style format string used to generate the title of the calendar.  
-| (Default: =%B %Y=.)  
-|-  
-| **wday_format**  
-| [[php-function:strftime|strftime]] style format string used to generate the day-of-week names at the top of the calendar.  
-|  
-|-  
-| **start_wday**  
-| What day of the week does the calendar start on. This should be specified as an integer in the range zero (Sunday) through six (Saturday), inclusive.  
-|  
-|}  
+!! Plugin Arguments  
  
-== Examples ==  
+!Selection of Month  
  
-{{{  
- <<Calendar month_offset=+1 >>  
-}}}  
+<strong >year</strong >:  
  
-will get you :  
-<<Calendar month_offset=+1>>  
+ Specify the year for the calendar. (Default : current year.)  
  
-{{{  
- <<Calendar start_wday=0 >>  
-}}}  
+<strong >month</strong >:  
  
-will get you :  
-<<Calendar start_wday=0>>  
+ Specify the month for the calendar. (Default : current month.)  
  
-== See Also ==  
+<strong>month_offset</strong>:  
  
-* [[Help:CalendarListPlugin]]  
+ Added to ''month''. Can be used to include several months worth of  
+ calendars on a single wiki page.  
  
-Often used together like this:  
+ <?plugin Calendar month_offset=+1?>  
  
-{{{  
-<<Calendar>>  
-<<CalendarList>>  
-}}}  
+!"Day Page" Names  
  
-== Authors ==  
+<strong>date_format</strong>:  
  
-This feature was inspired by [[http ://manila .userland .com /|Calendar] ],  
-and first implemented by Gary Benson . It was later implemented as a  
-[[ Help:WikiPlugin |plugin ]] by [[ Help:Jeff Dairiki |Jeff Dairiki] ]. 
+ Help :e | php-function:strftime] style format string used to  
+ generate page names for the "day pages." The default value is  
+ =%Y-%m-%d=.  
+  
+<strong>prefix< /strong>:  
+  
+ Prepended to the date (formatted per ''date_format'') to generate  
+ the "day page" names. The default value is =~ Help:e ] /= .  
+  
+!Appearance  
+  
+<strong>month_format</strong>:  
+  
+ Help:e | php-function:strftime] style format string used to  
+ generate the title of the calendar . (Default: =%B, %Y=.)  
+  
+<strong>wday_format< /strong>:  
+  
+ Help:e | php-function:strftime ] style format string used to  
+ generate the day-of-week names at the top of the calendar.  
+  
+<strong>start_wday</strong>:  
+  
+ What day of the week does the calendar start on. This should be  
+ specified as an integer in the range zero (Sunday) through six  
+ (Saturday) , inclusive.  
+  
+ <?plugin Calendar start_wday=1 ?>  
+  
+-----  
+  
+! Patch for 1.2  
+  
+PhpWiki:GaryBenson wrote the first calendar implementation for PhpWiki 1 .2.  
+(Since 1.2 doesn't support plugins, it uses a =###CALENDAR###= token  
+ as a trigger.)  
+Gary provides a screenshot at [ http://inauspicious.org/files/screenshots/calender.png | screenshot ],  
+a Help:h | http://inauspicious.org/files/phpwiki/phpwiki-1.2.0-calendar.patch ] (on 1.2.0), and  
+ Help:r .php | http://inauspicious.org/files/phpwiki/calendar.php ]  
+(which renders a view of the year .)  
  
-<noinclude>  
 ---- 
-[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
-</noinclude>  
+  
+PhpWikiDocumentation  

version 3

The Help:n | Help: can be used to generate a monthly calendar in a wiki page. It's handy for PhpWiki:PersonalWikis.

Individual dates in the calendar link to specially named wiki pages. The names for the "day pages" are by default formed by appending the date to the pagename on which the calendar appears.

_This feature was inspired by Help:a |http://manila.userland.com/], and first implemented by PhpWiki:GaryBenson. It was later implemented as a Help:WikiPlugin by PhpWiki:JeffDairiki._

Usage:

<?plugin Calendar?>

will get you:

< May 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   31 

Plugin Arguments

Selection of Month

year
Specify the year for the calendar. (Default: current year.)
month
Specify the month for the calendar. (Default: current month.)
month_offset

Added to month. Can be used to include several months worth of calendars on a single wiki page.

< June 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 

"Day Page" Names

date_format
Help:e | php-function:strftime] style format string used to

generate page names for the "day pages." The default value is %Y-%m-%d.

prefix
Prepended to the date (formatted per date_format) to generate the "day page" names. The default value is Help:e ]/.

Appearance

month_format
Help:e | php-function:strftime] style format string used to

generate the title of the calendar. (Default: %B, %Y.)

wday_format
Help:e | php-function:strftime] style format string used to

generate the day-of-week names at the top of the calendar.

start_wday

What day of the week does the calendar start on. This should be specified as an integer in the range zero (Sunday) through six (Saturday), inclusive.

< May 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   31 

Patch for 1.2

PhpWiki:GaryBenson wrote the first calendar implementation for PhpWiki 1.2. (Since 1.2 doesn't support plugins, it uses a #CALENDAR# token as a trigger.) Gary provides a screenshot at screenshot, a Help:h | http://inauspicious.org/files/phpwiki/phpwiki-1.2.0-calendar.patch] (on 1.2.0), and

Help:r .php | http://inauspicious.org/files/phpwiki/calendar.php]

(which renders a view of the year.)

PhpWikiDocumentation