|
|
| (3 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| − | __FORCETOC__
| + | #REDIRECT [[Calendar]] |
| − | ==Installation==
| |
| − | This is a calendaring application based on DPL functionality. It is very flexible because it is based on templates which you can modify and adapt to your needs.
| |
| − | | |
| − | ==Architecture==
| |
| − | | |
| − | {{#wgraph: svg| thumb=90 |
| |
| − | node Current_events {type cal}
| |
| − | | |
| − | node 2007-09-28-Event_A {}
| |
| − | node YYYY-10-04-Event_B {}
| |
| − | node 2007-10-19-Event_C {}
| |
| − | | |
| − | node Event {type tpl}
| |
| − | node CatEvent {type category label Events}
| |
| − | node CatHoliday {type category label Holiday}
| |
| − | edge Event CatEvent {type cat}
| |
| − | node Event_template {type editsample}
| |
| − | node Event_intro {type editintro}
| |
| − | edge Event_intro Event_template {kind rightnear type editintro}
| |
| − | edge 2007-09-28-Event_A Event {type incl}
| |
| − | edge YYYY-10-04-Event_B Event {type incl}
| |
| − | edge YYYY-10-04-Event_B CatHoliday {type catgeory}
| |
| − | edge 2007-10-19-Event_C Event {type incl}
| |
| − | edge Event_template 2007-09-28-Event_A {type edit}
| |
| − | edge Event_template YYYY-10-04-Event_B {type edit}
| |
| − | edge Event_template 2007-10-19-Event_C {type edit}
| |
| − | edge Event_template Event {type incl}
| |
| − | | |
| − | edge Current_events Calendar_month {type incl}
| |
| − | | |
| − | node Calendar_month {type tpl}
| |
| − | node CalendarSingle {type tpl}
| |
| − | node Calendar_link {type tpl}
| |
| − | edge Calendar_month 2007-09-28-Event_A {type dpl}
| |
| − | edge Calendar_month YYYY-10-04-Event_B {type dpl}
| |
| − | edge Calendar_month 2007-10-19-Event_C {type dpl}
| |
| − | edge Calendar_month CalendarSingle {type incl}
| |
| − | edge CalendarSingle Calendar_link {type incl}
| |
| − | edge CalendarSingle Current_events {type link label 'next month<br>prev. month' }
| |
| − | | |
| − | node Calendar/MonthStartMon {type tpl}
| |
| − | node Calendar/MonthStartTue {type tpl}
| |
| − | | |
| − | edge CalendarSingle Calendar/MonthStartMon {type incl}
| |
| − | edge CalendarSingle Calendar/MonthStartTue {type incl}
| |
| − | | |
| − | nodetype tpl {color yellow }
| |
| − | nodetype category {color lightgreen}
| |
| − | nodetype cal {color lightblue }
| |
| − | nodetype editsample {color lightcyan }
| |
| − | nodetype editintro {color lightcyan }
| |
| − | nodetype * {color #ffdddd bordercolor darkgray}
| |
| − | | |
| − | edgetype incl {color darkgray}
| |
| − | edgetype link {color blue}
| |
| − | edgetype cat {color darkgreen}
| |
| − | edgetype dpl {color red thickness 4 label 'DPL query'}
| |
| − | edgetype edit {linestyle dotted color blue}
| |
| − | | |
| − | node.fontname helvR10
| |
| − | }}
| |
| − | * Templates are in yellow.
| |
| − | * The pages describing an event are in red. Their names must start with the date of the event (format: YYYY-MM-DD) or with 'YYYY-' plus month and day (for recurring yearly events).
| |
| − | * We use two edit helpers (in cyan) when event pages are created.
| |
| − | * The entry page for the calendar (''Current events'') is in blue.
| |
| − | * Categories are in green.
| |
| − | | |
| − | The design is as follows:
| |
| − | # The user calls the entry page("Current events"). Be careful if you change its name: The name of this page must be passed as an argument (named 'basepage') to the template 'Calendar month'.
| |
| − | # The basepage can be called by the user without any arguments. Then it uses a date function to calculate the current month. It can also be called from another calendar page - in which case the desired year & month are passed as parameters via the [[Call extension]].
| |
| − | # Template 'Calendar month' ...
| |
| − | #* shows the calendar box. The calendar box contains thet titles of the event pages (the first part of the titles´names which contain the resp. date is suppressed). Below the calendar there is an optional event list which shows either all events of the current month or all events regardless of month.
| |
| − | #* expects a 'purpose' parameter. If this parameter is set it acts as a filter, i.e. only events will be shown which belong to a category with the name of the 'purpose'. This allow syou to have several calendars in parallel
| |
| − | #* uses a DPL query to find all articles in category 'Event' which belong to the selected year/month
| |
| − | #* shows the selected articles in a list, together with some selected chapters (like Participants ..) and with their categories
| |
| − | #* offers an edit box to create a new event (using the edit template "Event template")
| |
| − | | |
| − | | |
| − | == Steps needed to install the DPL calendar ==
| |
| − | | |
| − | === Install extensions ===
| |
| − | | |
| − | You need
| |
| − | Download the following extensions:
| |
| − | #[http://meta.wikimedia.org/wiki/ParserFunctions parserfunctions] from MW
| |
| − | # Variables extensions from MW
| |
| − | # StringFunctions extension from MW
| |
| − | #[[Download|DPL extension]] from this site.
| |
| − | # Call extension from this site (part of the above download).
| |
| − | # Inputbox extension: you must take the version from this site (see [[download]])
| |
| − | | |
| − | ===Download the following templates, and create them into your wiki===
| |
| − | | |
| − | Copy / paste the following list of arfticles to [[Special:export]] and import the XML text into your wiki:
| |
| − | | |
| − | <small>
| |
| − | [[Current events]]
| |
| − | [[Template:Calendar month]]
| |
| − | [[Template:CalendarSingle]]
| |
| − | [[Template:Calendar link]]
| |
| − | [[Template:Calendar/MonthStartMon]]
| |
| − | [[Template:Calendar/MonthStartTue]]
| |
| − | [[Template:Calendar/MonthStartWed]]
| |
| − | [[Template:Calendar/MonthStartThu]]
| |
| − | [[Template:Calendar/MonthStartFri]]
| |
| − | [[Template:Calendar/MonthStartSat]]
| |
| − | [[Template:Calendar/MonthStartSun]]
| |
| − | [[Template:!]]
| |
| − | [[Template:(!]]
| |
| − | [[Template:!)]]
| |
| − | [[Event template]]
| |
| − | [[Event intro]]
| |
| − | [[Template:Event]]
| |
| − | [[Template:Create Event]]
| |
| − | </small>
| |
| − | | |
| − | === Using the calendar ===
| |
| − | | |
| − | Create new documents which describe events.
| |
| − | * Follow the naming convention: The name must start with the date, followed by some short text dewscriobing the event
| |
| − | *: Example: "2007-10-31 some important event"
| |
| − | * Note that your document must belong to category 'Events'. This will normally automatically be the case by including the template "Event" in the first line of your evebt description.
| |
| − | * You can add your document to other categories as well; these will show up in the event table below the calendar
| |
| − | * You can defíne yearly recurring events by using 'YYYY' instead of the exact year.
| |
| − | *: Example: "YYYY-12-24 Christmas Evening"
| |
| − | | |
| − | === Customizing ===
| |
| − | | |
| − | To customize the list of events that are displayed below each calendar, take a close look in the DPL manual at the [[include]] parameter and the [[format]] parameter. In our example in template [[Template:calendar month]], we have:
| |
| − | <pre>
| |
| − | #Summary,#Participants,#Location
| |
| − | </pre>
| |
| − | which means to take the content of ''Summary'', ''Participants'' and ''Location'' sections.
| |
| − | | |
| − | You could modify the name of sections, the number of sections or even take the parameters of a template inside the event page. Again, see the DPL manual.
| |
| − | | |
| − | ==Demo==
| |
| − | Now we are going to include ''Current events'' which will give us the actual calendar right here. ''Current events'' understands the following parameters:
| |
| − | * year - defaults to the current year
| |
| − | * month - defaults to the current month
| |
| − | * purpose - empty or a string which will be used as a category filter. Only events belonging to that category will be shown. You can even specify a group of purposes by using the broken pipe (¦) character as a separator.
| |
| − | * namespace - empty or a namespace string. Only event defined in articles in that namespace will be shown; new events will be created in an article which belongs to that namespace
| |
| − | * show - empty or the name of a chpater in the event articles; the contents of that chapter will be included below the title of the article. The chapter can also contain an image.
| |
| − | * eventList = {no|current|all}, defaults to 'current'; produces a tabular report of the selected events
| |
| − | * width = empty or a width specification for the table, e.g. '500px' or '100%'; default is to make the calendar as small as possible
| |
| − | * noadd = empty or '1'; when set to '1' the calendar will not offer a link to create an event page
| |
| − | * nolink = empty or '1'; when set to '1' the calendar will not contain a link to the event page. Instead the day number will link to the event list. Using this option with "eventList=no" does not make sense. If nolinks is set to '1', noadd is implicitly set to '1'.
| |
| − | | |
| − | | |
| − | {{:Current events}}
| |
| − | [[Category:Test]]
| |
