Differences

This shows you the differences between two versions of the page.

--- plugin:schedule [2016-05-26 16:04] – created 193.50.241.68
+++ plugin:schedule [2021-03-31 11:29] (current) – felix
@@ Line 1: / Line 1: @@
-====== schedule Plugin ======
+====== Schedule Plugin ======
 ---- plugin ----
@@ Line 6: / Line 6: @@
 email      : dokuplugin@merciol.fr
 type       : syntax
-lastupdate : 2016-05-26
+lastupdate : 2021-03-31
-compatible : Detritus
+compatible : Greebo, Frusterick Manners, Hogfather
-depends    :
+depends    : ol3, inseecity
 conflicts  :
 similar    :
@@ Line 19: / Line 19: @@
 screenshot_img : http://admin.parlenet.org/_media/plugins/schedule/schedule-sample.png
 ----
@@ Line 27: / Line 28: @@
   * [[geophp]]
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Examples/Usage =====
-//[Most people learn by example, so this goes first]//
+See the plugin in action [[https://fsl56.org/agenda/debut|here]] (fr.) or [[https://le-pantin-emancipe.fr/commande/accueil|here]] (fr.) and some documentation [[http://admin.parlenet.org/plugins/schedule/debut|here]]
-See the plugin in action [[http://chantiersdespoir.parlenet.local/agenda/|here]].
+Different block are connected. Some popup appears according selection. The maps are interactive...
+On a dedicated schedule page:
 <code>
 {{schedule>agenda prop >!}}
+</code>
+On a sidebar:
+<code>
+{{schedule>agenda table >!}}
+</code>
+On a event page
+<code>
+<schedule>
+| 47.6177 | -2.7357 | Centre Culturel Grain de Sel \\ 5 ter, rue des écoles \\ 56 860
+</schedule>
 </code>
 ===== Syntax =====
-TODO
+Schedule by lines:
+{{ http://admin.parlenet.org/_media/plugins/schedule/schedule-long-sample.png?100&direct}}
+<code>
+{{schedule>nameSpace [help] [id="id"] [(<|=|>)(!|+-delta|jj/mm/aa|jj/mm/aaaa)] [#maxLine] [prop|form|ctrl] [(member|what|audience|noMember|noWhat|noAudience)="x1,x2,..."] }}
+</code>
+  * **nameSpace** -- name of the schedule. Multiple schedules could be manage in a site \\ (by default the nameSpace of the page where the syntax appears)
+  * **help** -- give a help
+  * **id** -- to permit many schedule table (with different parameters) on a same page
+  * **<|=|>** -- filer before, after or same as the indicated date
+  * **!** -- today
+  * **+-delta** -- some days after or before today
+  * **jj/mm/aa|jj/mm/aaaa** -- specific date
+  * **#maxLine** -- maximum events
+  * **ctrl** -- add remove command per event for connected users
+  * **form** -- ctrl + form to add event for connected users
+  * **prop** -- form + form to add event for anybody \\ messages are send to administrators when new proposal since last acknowledgement.
+  * **member|what|audience** -- filter according initiator, event or public
+  * **noMember|noWhat|noAudience** -- exclude some initiator, event or public
+A compact representation (table + map):
+{{ http://admin.parlenet.org/_media/plugins/schedule/schedule-table-sample.png?100&direct}}
+<code>
+{{schedule>nameSpace table [(<|=|>)(!|+-delta|jj/mm/aa|jj/mm/aaaa)] }}
+</code>
+  * **nameSpace** -- name of the schedule. Multiple schedules could be manage in a site \\ (by default the nameSpace of the page where the syntax appears)
+  * **<|=|>** -- filer before, after or same as the indicated date
+  * **!** -- today
+  * **+-delta** -- some days after or before today
+  * **jj/mm/aa|jj/mm/aaaa** -- specific date
+On a event page to localize the event:
+{{ http://admin.parlenet.org/_media/plugins/schedule/schedule-event-sample.png?100&direct}}
+<code>
+<schedule>
+inseeCode | lat | long | name ~br~ street ~br zipCode ~end~
+...
+</schedule>
+</code>
+One line per plot.
+  * **inseeCode** -- code give by the French public structure (unique number per city)
+  * **lat** and **long** -- gps coordinates
+  * complete address ends by zip code of the city (not unique for cities in France)
+  * **~br~** add new line
+  * **~end~** turn around ckgedit side effect
+The user may not have to use this syntax. This part of code is automatically generated with the "wizard" button associated to each new event.
+Management:
+<code>
+{{schedule admin }}
+</code>
+Capability to move events form on schedule to an other (archive operations).
 ===== Configuration and Settings =====
-TODO
+  * **scheduleGroup** -- user group who can fill the event form without captcha
+  * **adminGroup** -- admin group who can remove or archive schedules
+  * **dataDir** -- directory for xml database for events
+  * **groupsDir** -- nameSpace where members group (sub organization) could be found
+  * **noSchedule** -- not a member (ignore this directories as a sub organization)
+  * **sharedDir** -- share nameSpace for common events of different organizations
+  * **scheduleSubDir** -- root of events pages (contains a directory by organization)
+  * **scheduleWhat** -- 3 kinds of events (A => red | B => orange | C => green)
+  * **scheduleAudience** -- different kind of audience
+  * **iconName** -- icon name looking for in organization directory (square icon is better)
+  * **iconWidth** -- icon size
+  * **repeatPosition** -- repeated events are grouped or separated
+  * **bubblePosition** -- popup of compact representation are shown on left or right
+===== Questions =====
+I am trying to set-up this plug-in and I am confused with the dataDir, groupsDir and scheduleSubDir.
+  * Are they directories or wiki namespace ?
+  * What should be their actual content ? wiki page or something else ?
+An example will help. Thanks
+--- [[user>bruno.genere|Bruno Généré]] //2019-09-27 17:45//