doc/events.md

   1 # Events
   2
   3 * [Home](help)
   4
   5 A special form of postings are events.
   6 The events you and your contacts share can be found at [/events](/events) on your node.
   7 To get there go to your wall and follow the tab "events"
   8 Depending on the theme you are using, there might be an additional link from the navigation menu to this page.
   9
  10 ## Event Overview
  11
  12 The overview page shows the calendar of the current month, plus eventually some days in the beginning and the end.
  13 Listed are all events for this month you created, or your contacts have shared with you.
  14 This includes birthday reminders for contacts who share their birthday with you.
  15
  16 From the controls, you can switch between month/week/day view.
  17 Flip through the view forwards and backwards.
  18 And return to *today*.
  19
  20 To create a new event, you can either follow the link "Create New Event" or make a double click on the desired box in the calendarium for when the event should take place.
  21
  22 With a click on an existing event a pop-up box will be opened which shows you the event.
  23 From there you can edit the event or view the event at the source link, if you are the one who created the event.
  24
  25 ## Create a new Event
  26
  27 Following one of the methods mentioned above you reach a form to enter the event data.
  28 Fields marked with a *** have to be filled.
  29
  30 * **Event Starts**: enter the date/time of the start of the event here
  31 * **Event Finishes**: enter the finishing date/time for the event here
  32
  33 When you click in one of these fields a pop-up will be opened that allows you to pick the day and the time.
  34 If you double clicked on the day box in the calendarium these fields will be pre-filled for you.
  35 The finishing date/time has to be after the beginning date/time of the event.
  36 But you don't have to specify it.
  37 If the event is open-end or the finishing date/time does not matter, just select the box below the two first fields.
  38
  39 * **Adjust for viewer timezone**: If you check this box, the beginning and finisching times will automatically converted to the local time according to the timezone setting
  40
  41 This might prevent too early birthday wishes, or the panic attac that you have forgotten the birthday from your buddy at the other end of the world.
  42 And similar events.
  43
  44 * **Title**: a title for the event
  45 * **Description**: a longer description for the event
  46 * **Location**: the location the event will took place
  47
  48 These three fields describe your events.
  49 In the descirption and location field you can use BBCode to format the text.
  50
  51 * **Share this event**: when this box is checked the ACL will be shown to let you select with whom you wish to share the event. This works just like the controls of any other posting.
  52
  53 When you *Share* the event it will be posted to your wall with the access permissions you've selected.
  54 But before you do, you can also *preview* the event in a pop-up box.
  55
  56 ### Interaction with Events
  57
  58 When you publish an event, you can choose who shall receive it, as with a regular new posting.
  59 The recipients will see the posting about the event in their network-stream.
  60 Additionally it will be added to their calendar and thus be shown in their events overview page.
  61
  62 Recipients of the event-posting can comment or dis-/like the event, as with a regular posting, but also announce that they will attend, not attend or may-be attend the event with a single click.
  63
  64 ### Addons
  65
  66 #### OpenStreetMap
  67
  68 If this addon is activated on you friendica node, the content of the location field will be mathced with the identification service of OSM when you submit the event.
  69 Should OSM find anything matching, a map for the location will be embedded automatically at the end of the events view.
  70
  71 #### Calendar Export
  72
  73 If this addon is activated the public events you have created will be published in ical or csv file. The URL of the published file is ``example.com/cal/nickname/export/format`` (where format is either ical of csv).