a doc file for the event page

diff --git a/doc/Home.md b/doc/Home.md
index d944dfb658ac6f6c5d43433db1f1276c2511b8a8..78d52599fccda4f1d8331fbd51bbef28ad565d08 100644 (file)
--- a/doc/Home.md
+++ b/doc/Home.md
@@ -11,6 +11,7 @@ Friendica Documentation and Resources
        * [Comment, sort and delete posts](help/Text_comment)
        * [Profiles](help/Profiles)
        * [Accesskey reference](help/Accesskeys
+    * [Events](help/events)
 * You and other users
        * [Connectors](help/Connectors)
        * [Making Friends](help/Making-Friends)

diff --git a/doc/de/Home.md b/doc/de/Home.md
index ee5fba64b9e0acc5a35e7a7811f8971ab6d24aa7..b9438a891f25e22533fc34c80bf2a1d65cd082b5 100644 (file)
--- a/doc/de/Home.md
+++ b/doc/de/Home.md
@@ -11,6 +11,7 @@ Friendica - Dokumentation und Ressourcen
        * [Beiträge kommentieren, einordnen und löschen](help/Text_comment)
        * [Profile](help/Profiles)
        * [Referenz der Accesskeys](help/Accesskeys)
+    * [Veranstaltungen](help/events) (EN)
 * Du und andere Nutzer
        * [Konnektoren (Connectors)](help/Connectors)
        * [Freunde finden](help/Making-Friends)

diff --git a/doc/events.md b/doc/events.md
new file mode 100644 (file)
index 0000000..a991c79
--- /dev/null
+++ b/doc/events.md
@@ -0,0 +1,58 @@
+# Events
+
+* [Home](help)
+
+A special form of postings are events.
+The events you and your contacts share can be found at [/events](/events) on your node.
+To get there go to your wall and follow the tab "events"
+Depending on the theme you are using, there might be an additional link from the navigation menu to this page.
+
+## Event Overview
+
+The overview page shows the calendar of the current month, plus eventually some days in the beginning and the end.
+Listed are all events for this month you created, or your contacts have shared with you.
+This includes birthday reminders for contacts who share their birthday with you.
+
+From the controls, you can switch between month/week/day view.
+Flip through the view forwards and backwards.
+And return to *today*.
+
+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.
+
+## Create a new Event
+
+Following one of the methods mentioned above you reach a form to enter the event data.
+Fields marked with a *** have to be filled.
+
+* **Event Starts**: enter the date/time of the start of the event here
+* **Event Finishes**: enter the finishing date/time for the event here
+
+When you click in one of these fields a pop-up will be opened that allows you to pick the day and the time.
+If you double clicked on the day box in the calendarium these fields will be pre-filled for you.
+The finishing date/time has to be after the beginning date/time of the event.
+But you don't have to specify it.
+If the event is open-end or the finishing date/time does not matter, just select the box below the two first fields.
+
+* **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
+
+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.
+And similar events.
+
+* **Title**: a title for the event
+* **Description**: a longer description for the event
+* **Location**: the location the event will took place
+
+These three fields describe your events.
+In the descirption and location field you can use BBCode to format the text.
+
+* **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.
+
+When you *Share* the event it will be posted to your wall with the access permissions you've selected.
+But before you do, you can also *preview* the event in a pop-up box.
+
+### Addons
+
+#### OpenStreetMap
+
+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.
+Should OSM find anything matching, a map for the location will be embedded automatically at the end of the events view.
\ No newline at end of file