| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| hilfe:calendar_plugin [2009/01/19 21:25] – vehtoh (admin) | hilfe:calendar_plugin [2012/05/25 16:28] (aktuell) – gelöscht vehtoh |
|---|
| |
| ~~NOTOC~~ | |
| ====== Calendar Plugin ====== | |
| ===== eins ===== | |
| |
| <gcal pages=(:vehtoh:termine:vehtoh_privat, :vehtoh:termine:geburtstage) mode=ahmet_month> | |
| |
| ===== zwei ===== | |
| |
| <gcal pages=(:calendar:*) mode=week> | |
| ===== Parameter===== | |
| |
| ==== New Parameters ==== | |
| |
| mode=ahmet_month | |
| |
| Prints a monthly calendar table, each row showing a week, and each column showing certain day of the week. | |
| ahmet_backward_hard=<number> | |
| ahmet_backward_soft=<number> | |
| ahmet_forward_hard=<number> | |
| ahmet_forward_soft=<number> | |
| |
| The ahmet_backward and ahmet_forward parameters determine how many days backward and forward from the current day the calendar should show. When _soft parameters are used, the original dates are changed only when the extended date is in a more future date. For example, if today is Dec25th and you set ahmet_forward_soft=3, the calendar will show up to the end of the month (31st), but if you set ahmet_forward_soft=10, then the calendar will show up to Jan4th. | |
| ahmet_firstdayofweek=<number> | |
| |
| Specify which day of week to start in the first column of the monthly view (0:sunday,..., 6:saturday). The default option $conf[’gCal_ahmet_firstdayofweek’]=1; is set in the gcalendar/inc/conf.php file. | |
| |
| ---- | |
| Syntax | |
| |
| Include a calendar to your wiki page by using the following command-syntax: | |
| |
| <gcal <parameter-1>=<value-1> <parameter-1>=<value-1> ... > | |
| |
| Description of the parameters | |
| mode=<string> | |
| |
| <string> could be month, week or day. month is default. | |
| pages=(<item-1>,<item-2>,...) | |
| |
| A comma-separated list of wiki-pages or namespaces or groups. These are the source of the date data that will be used to populated the calendar. A group is a list of wiki-pages/namespaces enclosed by round-parenthesis delimited by a pipe-symbol '|'. You can also add a name to a group. See examples below. You can use @USER@ and @ID@ as a macro for current-user and current-page. If the user is not logged in, @USER@ is expanded to the literal 'guest´. | |
| |
| Starting with release 2006-11-10 you can address a single section of a wikipage by using a ”#”. | |
| |
| :!: Attention: :!: You can select any internal wiki-pages you like to. But the pages and namespaces must not include spaces, because spaces are used to separate the parameters. | |
| year=<number> | |
| |
| The year to display. Optional. Default is actual year. | |
| month=<number> | |
| |
| The month to display. Optional. Default is actual month. | |
| day=<number> | |
| |
| The day to display. Optional. Default is actual day. | |
| offset=<number> | |
| |
| Offset relative to given month, week or day. offset=1 means next month (when mode=month). A negative offset shifts backwards (e.g. -2 would be the day before yesterday) | |
| days=<number> | |
| |
| Only applies to week- or day-mode. Overrides the default number of days to display (7=week-mode, 1=day-mode). You can set it to 5 to omit the week-end (Sat/Sun). Or set it to 10 to see a little more than one week. | |
| pagelinks=<string> | |
| |
| <string> can be show, hide or auto. auto is default. Specify if you like to display the links from the calendar-entries to the origin-pages. | |
| pagelinks= … description | |
| show shows the links to the origin page after each date-entry | |
| hide suppress the links to the origin-pages | |
| auto default. Only shows the links if more than one page is the origin of a column | |
| debug | |
| |
| If this option is set, the complete gcal-command printed above the calendar in red color. For debugging and documentation purposes. | |
| notoc | |
| |
| Disables the automatic table-of-contents (TOC). | |
| cache | |
| |
| Enables page-caching. Must be set in the last gcal-command of a page. | |
| nested | |
| |
| With this option set, namespaces are scanned recursively. I.e. with 'pages=(:calendar:*)' and option 'nested' the calendar shows up all events of the namespace ':calendar' and the events of all its subnamespaces. | |
| dayshift=<number> | |
| |
| Positive or negative number of days to move the yellow today-marker. | |
| lang=<string> | |
| |
| Specify the 2-digit language-code to switch the plugin to a different language than the current main language of your wiki. | |
| compact | |
| |
| Smaller representation of dates with no events to save space. See dropempty. | |
| dropempty | |
| |
| Works in conjunction with compact. Drops dates with no events. | |
| noheader, nohead, nofoot, nonav | |
| |
| * | |
| “nonav” removes navigation part of the calendar | |
| * | |
| “nohead” removes the columnheaders | |
| * | |
| “nofoot” removes the columnfooters | |
| * | |
| “noheader” removes all of the above mentioned parts | |
| |
| ==== Examples ==== | |
| |
| Example 1 | |
| |
| <gcal pages=(:calendar:maike,:calendar:frank,:calendar:annette,:calendar:family_events)> | |
| <gcal pages=(:calendar:maike,:calendar:frank,:calendar:annette,:calendar:family_events) offset=1> | |
| |
| Displays current and next month of the calendar build up by the data in the :calendar:xxxx pages. | |
| Example 2 | |
| |
| <gcal pages=(:calendar:frank,:calendar:*)> | |
| |
| Display current month in 3 columns. “day”, “Franks dates” and all dates in all pages of namespace ”:calendar”. | |
| Example 3 | |
| |
| <gcal pages=(:calendar:frank#sports)> | |
| |
| ==== Dates can be in the form ==== | |
| |
| |
| MM/DD/YYYY i.e. American-style | |
| |
| or | |
| |
| DD.MM.YYYY i.e. German-style | |
| |
| or | |
| |
| YY-MM-DD i.e. ISO-style | |
| |
| If YYYY is omitted, the year of the displayed month is taken. You can define date-ranges by using a dash ”-”. | |
| This only picks the section named “sports” from franks page. | |
| |
| |