pgsrc/Help%2FCalendarPlugin

   1 Date: Thu, 26 Mar 2009 11:34:32 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FCalendarPlugin;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=UTF-8
   9 Content-Transfer-Encoding: binary
  10
  11 The **Calendar** [[Help:WikiPlugin|plugin]] can be used to generate a monthly calendar in a
  12 wiki page. It's handy for [[PhpWiki:PersonalWiki|personal wikis]].
  13
  14 Individual dates in the calendar link to specially named wiki pages.
  15 The names for the "day pages" are by default formed by appending the
  16 date to the pagename on which the calendar appears.
  17
  18 == Usage
  19
  20 {{{
  21 <<Calendar>>
  22 }}}
  23
  24 will get you:
  25 <<Calendar>>
  26
  27 == Arguments
  28
  29 {| class="bordered"
  30 |-
  31 ! Argument
  32 ! Description
  33 ! Default value
  34 |-
  35 | colspan="3" align="center" | **Selection of Month**
  36 |-
  37 | year
  38 | Specify the year for the calendar.
  39 | Current year
  40 |-
  41 | month
  42 | Specify the month for the calendar.
  43 | Current month
  44 |-
  45 | month_offset
  46 | Added to //month//. Can be used to include several months worth of calendars on a single wiki page.
  47 | 0
  48 |-
  49 | colspan="3" align="center" | **"Day Page" Names**
  50 |-
  51 | date_format
  52 | [[php-function:strftime|strftime]] style format string used to generate page names for the "day pages."
  53 | The default value is =%Y-%m-%d=.
  54 |-
  55 | prefix
  56 | Prepended to the date (formatted per //date_format//) to generate the "day page" names.
  57 | The default value is =~[pagename]/=.
  58 |-
  59 | colspan="3" align="center" | **Appearance**
  60 |-
  61 | month_format
  62 | [[php-function:strftime|strftime]] style format string used to generate the title of the calendar.
  63 | (Default: =%B %Y=.)
  64 |-
  65 | wday_format
  66 | [[php-function:strftime|strftime]] style format string used to generate the day-of-week names at the top of the calendar.
  67 |
  68 |-
  69 | start_wday
  70 | 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.
  71 |
  72 |}
  73
  74 == Examples
  75
  76 {{{
  77 <<Calendar month_offset=+1>>
  78 }}}
  79
  80 will get you:
  81 <<Calendar month_offset=+1>>
  82
  83 {{{
  84 <<Calendar start_wday=0>>
  85 }}}
  86
  87 will get you:
  88 <<Calendar start_wday=0>>
  89
  90 == See Also
  91
  92 * Help:CalendarListPlugin
  93
  94 Often used together like this:
  95
  96 {{{
  97 <<Calendar>>
  98 <<CalendarList>>
  99 }}}
 100
 101 == Authors
 102
 103 This feature was inspired by [Calendar|http://manila.userland.com/],
 104 and first implemented by [Gary Benson|PhpWiki:GaryBenson]. It was later implemented as a
 105 [[Help:WikiPlugin|plugin]] by [Jeff Dairiki|PhpWiki:JeffDairiki].
 106
 107 <noinclude>
 108 ----
 109 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
 110 </noinclude>