Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width20%
Excerpt Include
pluglib:Advanced Macros Plugin
pluglib:Advanced Macros Plugin
nopaneltrue
Column
width60%
Wiki Markup
{deck:id=Calendar|width=907px}
{card:label=Overview}

h4. Calendar Plugin

This plug-in puts a dynamically updated calendar into any page. The calendar stores its data in iCal format and allows incoming and outgoing calendar subscription. The plugin offers day, week and month views. You can have multiple calendars per page. And your items can link to other pages for elaborating details.

h5. This plugin includes the following macros:

* *calendar* \- Creates an editable calendar
* *calendar-events* \- Lists the events of a calendar
{card}
{card:label=Documentation}
{deck:id=calendarm}
{card:label=calendar}

h4. The Code 
{code}
{calendar:id=mycal|title=My Calendar}
{code}

h4. {toggle-cloak:id=cloak} Result
{cloak:id=cloak}
{calendar:id=mycal|defaultView=month|title=My Calendar}
{cloak}

h4.{toggle-cloak:id=cloak1} Parameters
{cloak:id=cloak1}

|| Name | Required? | Default | Description ||
| id | (/) | | The unique identifier that identifies this calendar. Must be unique per page. May only contain numbers and letters of the alphabet. |
| title | (x) | | The human-friendly title for the default sub-calendar. Not necessarily unique. |
| defaultView | (x) | | Allows the default view of the calendar to be specified. May be 'event', 'day', 'week' or 'month' (the default) |
| firstDay | (x) | | Allows the specification of the first day of the week. May be any day of the week. Defaults to Monday. |
{cloak}
{card}

{card:label=How to use the Calendar}
h3. Adding a new Event
{cloak:id=cloak2}
{toggle-cloak:id=cloak2}*1.* To add a new event, hover your mouse over a day on the main calendar display and click the 'add event' icon which appears:
{cloak:id=cloak2}
!cal_add_event.png!
{cloak}
\\
{toggle-cloak:id=3}*2.* Next, a panel asking which calendar you want to add to will appear:
{cloak:id=3}
!cal_select_calendar.png!
{cloak}
\\
{toggle-cloak:id=4}*3.* Select the calendar to wish to add the event to (in this case the calendar is titled 'My Vacaction') and click next. Enter the details for the event:
{cloak:id=4}
!cal_event_details.png!
{cloak}
\\
*4.* Click *'Add'* to finish the job.

h3. Adding a new Calendar
You can add a new calendar, either one allowing events to be added via Confluence, or one which subscribes to an iCal file elsewhere on the Internet.
{toggle-cloak:id=5}*1.* Click the *'Add a calendar link'*. If more than one type of calendar is available, you will have to select the calendar type: 
{cloak:id=5}
!calendar_add1.jpg!
{cloak}
{toggle-cloak:id=6}*2.* Fill in the calendar details. 
{cloak:id=6}
!add_cal.png!
{cloak}
3.Click *'Finish'* to add the new calendar.
{card}
{deck}
{deck}
{roundrect:bgcolor=#828282|width=909px|height=50px|corners=false,false,true,true}
{roundrect}

Column
width20%