Dotclear

source: plugins/eventdata/README.txt @ 1005

Revision 1005, 17.1 KB checked in by JcDenis, 14 years ago (diff)

eventdata: fix conflict with icsFeed plugin

Line 
1eventdata 0.3.4 (2009/04/09) plugin for Dotclear 2
2
3Préambule:
4==========
5
6! Due to a conflict with an older plugin called "icsFeed",
7! versions of "eventdata" less than 0.3.4 are not compatible with the following versions.
8! A recovery tool will attempt to transfer the dates in database.
9! But all changed themes will be updated manually.
10! The main differences are the changes of names including "Event" to "Eventdata".
11! (css class names, blocks names, values names)
12! Events widgets must replaced.
13! All eventdata settings are losts
14! Sorry for the inconvenience.
15
16I. Licence:
17===========
18
19This file is part of eventdata, a plugin for Dotclear 2.
20Copyright (c) 2009 JC Denis and contributors
21jcdenis@gdwd.com
22Licensed under the GPL version 2.0 license.
23A copy of this license is available at
24http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
25
26Some icons from Silk icon set 1.3 by Mark James at:
27http://www.famfamfam.com/lab/icons/silk/
28under a Creative Commons Attribution 2.5 License at
29http://creativecommons.org/licenses/by/2.5/
30
31
32II. Support:
33============
34
35http://blog.jcdenis.com/?q=dotclear+plugin+eventdata
36http://forum.dotclear.net
37
38
39III. Install:
40=============
41
42Voir la procédure d'installation des plugins Dotclear 2.
43
44
45IV. Onlget "Administration":
46============================
47
48Cette page permet de gèrer l'activation et l'utilisation de l'extension dans son ensemble sur le blog en cours.
49
50IV.1 Générale:
51--------------
52
53"Activer le plugin"
54Active ou désactive complètement l'utilisation du plugin.
55 
56"Icone de l'extension dans le menu Blog"
57Place l'icon de l'extension soit dans la liste "Blog", soit dans la liste "Extensions".
58 
59"Activer la page public"
60Ajoute un page coté publique ou seront affichés les événements.
61
62IV.2 Permissions:
63-----------------
64
65Il est possible de modifier les permissions des utilisateurs pour accèder à certaines parties de ce plugin.
66Les permissions sans rapport avec ce plugin ne sont pas affectées. Les actions possibles dépendent des permissions de l'utilisateur.
67
68"Gestion des événements sur les billets"
69Permet la gestion des dates d'évenement depuis l'onglet "Billets" ou directement sur la page des billets.
70
71"Gestion de la liste des catégories réordonnées"
72Permet la gestion des catégories réordonner ou pas,
73
74"Gestion de la page public"
75Permet la gestion du titre, de la description et du choix du template pour la page publique de la liste des événement.
76
77"Gestion du plugin"
78Permet la gestion complète du plugin,
79
80
81VI. Onglet "Billets":
82=====================
83
84Cette liste affiche les billets auquels sont associées des dates d'événements.
85Un billet peut apparaitre plusieurs fois si plusieurs dates d'événement lui sont associées.
86
87VI.1 Filtres:
88-------------
89
90Les filtres permettent de limiter et de trier la liste des billets affichés selon diffèrents critères.
91
92"Catégorie"
93Filtrer les billets par catégorie.
94
95"État"
96- "en attente": en attente de publication,
97- "programmé": billets mis en ligne aux date et heure indiquées dans le champ "Publié le",
98- "non publié": billets hors ligne,
99- "publié: billets en ligne.
100
101"Sélectionné"
102Aucun, billet marqué comme sélectionné ou non sélectionné.
103
104"Trier par"
105Permet de trier les résultats de filtrage selon la date de publication, la date de début de l'événement,
106la date de fin de l'événement, le titre,la catégorie, l'auteur, l'état de publication ou l'état de sélection.
107
108"Trier"
109Indique l'ordre dans lequel on souhaite effectuer le tri.
110
111"Période"
112- "Non débuté": événements futurs,
113- "Débuté": événements commencés,
114- "Terminé": événements passés,
115- "Non terminé": événements passé ou en cours,
116- "En cours": événements commencés mais pas terminés,
117- "Pas en cours": événements pas commencés ou déjà terminés.
118
119"Billets par page"
120Nombre de billets à afficher par page de résultat.
121
122VI.2 Actions par lot sur les billets:
123-------------------------------------
124
125Il est possible d'effectuer un ensemble d'actions sur plusieurs billets, d'un seul coup.
126Les actions possibles dépendent des permissions de l'utilisateur.
127Ces actions sont principalements les mêmes que sur la page des billets avec en plus la possibilté de supprimer les événements.
128Cette option est également directement présente sur la page des billets.
129
130- "Supprimer les événements": Enlève les dates d'événement, les billets redeviennent des billets "normaux",
131- "Publier": mettre le billet en ligne,
132- "Hors ligne": mettre le billet hors ligne,
133- "Programmer": programmer le billet pour mise en ligne à la date de publication,
134- "En attente: en attente de publication,
135- "Marquer comme selectionné",
136- "Marquer comme non selectionné",
137- "Changer de catégorie: envoie sur la liste des catégories pour changer celle des billets sélectionnés,
138- "Changer l'auteur: permet de changer l'auteur du billet en indiquant l'identifiant de l'utilisateur qui deviendra le nouvel auteur,
139- "Supprimer": supprime le billet (cette opération est irréversible).
140
141
142VII. Onglet Catégories:
143=======================
144
145Cette liste affiche les catégories et permet de modifier l'ordre d'affichage des billets qui y sont associés coté publique.
146Elle permet d'interdire l'affichage d'événements appartenant à cetaines catégories dans les widgets ou la page d'événements.
147
148VII.1 Réordonné:
149----------------
150
151- "Normal": Marqué en rouge: L'ordre des billets suit l'ordre par défaut du thème.
152- "Réordonné": Marqué en vert: Les billets de la catégorie sont réordonnés suivant leurs date de début d'événement et dans l'ordre décroissant.
153
154VII.2 Caché:
155------------
156
157- "Normal": Marqué en vert: La catégorie sera prise en compte partout coté publique.
158- "Réordonné": Marqué en rouge: La catégorie ne sera pas prise en compte dans les widgets (sauf si spécifié),
159   ni sur la page d'événement (sauf si c'est la page de la catégorie réordonné).
160
161VII.3 Actions par lot sur les catégories:
162-----------------------------------------
163
164Il est possible d'effectuer un ensemble d'actions sur plusieurs catégories, d'un seul coup.
165
166- "Marquer comme réordonné": Réordonne l'affichage des billets par événement,
167- "Marquer comme normal": Enlève l'ordre d'affichage des billets par événement.
168
169
170VIII. Onlget "Modèles":
171=======================
172
173Cette page permet de gèrer diffèrents éléments de la page publique "events.html".
174
175VIII.1 Description:
176-------------------
177
178Les deux champs suivants seront remplis par les titre et description d'une catégories lors de la redircetion de celle ci vers la page des événements.
179
180"Titre"
181Titre de la page publique des événements. {{tpl:EventdataPageTitle}}
182 
183"Decription"
184Description de la page publique des événements. {{tpl:EventdataPageDescription}}
185
186
187VIII.2 Thèmes:
188--------------
189
190Des thèmes prédéfinis existent et la disponibilité du modèle dans un thème peut dépendre du super administrateur dans le cas d'un multiblog.
191
192"Aide"
193Des indications sont disponibles pour faciliter le choix du template de la page public.
194- "Thème du blog en cours": Nom du thème utilisé actuellement,
195- "Adaptation existante": Indique si l'extension à un theme adapaté au theme en cours,
196- "Page existante dans le thème du blog": Indique si le thème en cours est modifié pour l'extension,
197- "Thème alternatif": Nom du thème de l'extension utilisé si celui du thème n'existe pas,
198
199"Préfixe du lien"
200Permet de changer le lien vers la page publique.
201
202"Choix du template prédéfini pour la page publique"
203Permet de choisir un thème particulier de l'extentsion si celui du thème en cours n'existe pas.
204
205"Désactiver la liste des dates d'événement d'un billet"
206Par défault certains modèles possèdent l'affichage atomatique de la liste des dates d'événement sur un billet.
207Si vous préférez utiliser le widget (ou rien du tout) il suffit de désactiver cette option.
208
209
210IX. Wigdets:
211============
212
213IX.1 Widget "Liste de événements":
214---------------------------------
215
216Un widget en rapport avec les événements est disponible.
217Il permet de lister les événements à la manière du widget "Derniers Billets" mais avec de multiples critères.
218
219"Titre"
220Titre du widget
221
222"Catégorie"
223Afficher seulement les événement d'une catégorie.
224
225"Tag"
226Si le plugin "Metadata" est installé, cela permet de limiter l'affichage uniquement à certains tags.
227
228"Nombre maximum de billets"
229Limite le nombre de billets affichés
230
231"Trier par"
232Permet de trier les résultats de filtrage selon la date de publication, la date de début de l'événement,
233la date de fin de l'événement, le titre, la catégorie, l'auteur, l'état de publication ou l'état de sélection.
234
235"Trier"
236Indique l'ordre dans lequel on souhaite effectuer le tri.
237
238"Sélectionné"
239Aucun, billet marqué comme sélectionné ou non sélectionné.
240 
241"Période"
242- "vide": tout afficher,
243- "Non débuté": événements futurs,
244- "Débuté": événements commencés,
245- "Terminé": événements passés,
246- "Non terminé": événements passé ou en cours,
247- "En cours": événements commencés mais pas terminés,
248- "Pas en cours": événements pas commencés ou déjà terminés.
249
250"Format des dates des billets"
251La définition des caractères de formatage est identique à celle du blog.
252Voir l'aide de la page paramètres du blog.
253
254"Format du texte des billets"
255Le titre de chaque billet peut être formaté suivant des caractères particuliers:
256- "%T": titre du billet,
257- "%C": titre de la catégories,
258- "%S": date de début de l'événement,
259- "%E": date de fin de l'événement.
260
261"Format de surbrillance des billets"
262Le texte afficher lors du passage de la souris peut être formaté suivant les même critères que le texte ci-dessus.
263
264"Uniquement sur la page d'accueil"
265Affiche le widget uniquement sur la ge d'accueil
266
267
268IX.2 Widget "Evènements d'un billet":
269------------------------------------
270
271Ce widget affiche les dates d'événements associés à un billet.
272Il est uniquement présent sur la page d'un billet.
273Il supporte plusieurs critères.
274
275"Titre"
276Titre du widget
277
278"Format des dates des billets"
279La définition des caractères de formatage est identique à celle du blog.
280Voir l'aide de la page paramètres du blog.
281 
282"Format du texte des billets"
283Le titre de chaque billet peut être formaté suivant des caractères particuliers:
284- "%S": date de début de l'événement,
285- "%E": date de fin de l'événement.
286
287
288X. Modification de l'administration:
289====================================
290
291Des options sont ajoutés sur certaines pages d'administration.
292
293X.1 Nouveau billet (post.php):
294------------------------------
295
296Sur la page de création et de modification de billet, dans la barre latérale, des choix de dates de début et de fin sont ajoutés.
297Il suffit d'entrer une date de début et de fin pour associer un événement à un billet.
298Une listes des évènemets dèjà lié à un billet peut être présente, il suffit de la selectionner pour l'effacer lors de l'enregistrement du billet.
299
300X.2 Billets (posts.php):
301------------------------
302
303Sur la page de la listes de billets, dans la listes d'actions, des choix d'ajout ou de suppression de date d'événement par paquet sont ajoutés.
304Pour l'ajout d'événement par paquet tous les billets selectionnés auront les mêmes dates d'événement.
305
306X.3 Action sur les billets (posts_action.php):
307----------------------------------------------
308
309Permet les actions par paquet. (Ajout d'événement sur plusieurs billets.)
310
311X.4 Extension Evénements (plugin.php):
312--------------------------------------
313
314Bien sur, une page spéciale pour la gestion de l'extension est présente soit dans le menu "Blog" soit dans le menu "Extension".
315
316
317XI. Modification des catégories:
318================================
319
320Les pages de catégories peuvent être réordonnées par date de début d'événement. (gèré dans l'onglet Catégories de l'extension)
321Les catégories marquées comme réordonnées seront redirigées vers la page des événements restreint à la catégorie correspondante.
322L'extension utilise le behavior "tplBeforeData" pour rediriger la page.
323
324
325XII. Page publique des événements:
326==================================
327
328Une page publique dédiés aux événements est disponible.
329L'url publique de cette page est modifiable et par default "events".
330Son thème ressemble à la page d'une catégorie. Des pages, des blocs et des valeurs ont été ajoutés:
331
332XII.1 Liste des pages:
333----------------------
334
335"events":
336C'est la page principale affichant la liste des événements suivant diffèrents critères qui sont les mêmes que pour les billets,
337avec la prise en compte de la pagination et de la période. Par exemple, si votre lien de page est <em>events</em> cela donne:
338- http://.../events : Affiche tous les événements,
339- http://.../events/ongoing : Affiche les événements en cours,
340- http://.../events/scheduled : Affiche les événements à venir,
341- http://.../events/finished/page/2 : Affiche la 2ème page des événements terminés,
342- http://.../events/feed/rss2 : Affiche le flux RSS des événements.
343
344"eventstheme":
345Ce n'est pas une page mais une redirection vers les fichiers de thème de l'extension, cela permet d'afficher des images, des css, etc...
346Les url des images des fichiers css apellés depuis ce liens seront également réécrits.
347
348XII.2 Liste des blocks:
349-----------------------
350
351"EventdataEntries"
352Supporte les mêmes attribus que le bloc "Entries" avec en plus:
353- Trie des billets par début, fin d'évenement,
354- restriction du type d'événement, par default "eventdata",
355- restriction de periode d'événement (pas) en cours, (pas) commencé, (pas) fini,
356- restriction de date de début ou de fin stricte.
357
358A l'interieur de ce bloc, la majorité des balises et blocs de "Entries" sont valable.
359
360"EventdataPagination"
361Supporte les mêmes attribus que le bloc "Pagination"
362Permet de faire la pagination en fonction des événements. (Restore le bon comptage)
363
364"EntryEventdataDates"
365Supporte de nombreux attribus.
366Ce bloc liste les événements associés à un billet.
367
368"EventdataDatesHeader"
369Voir categoriesHeader.
370Utilisée dans le contexte de la boucle "EntryEventdataDates", le contenu de cette balise s'affiche uniquement pour la première date de la boucle.
371
372"EventdataDatesFooter"
373idem ci-dessus
374
375XII.3 Liste des valeurs:
376------------------------
377
378"EventdataPageTitle"
379Supporte les attribus communs.
380Si c'est une catéorie réordonnée alors EventdataPageTitle affichera le nom de la catégorie.
381
382"EventdataPageDescription"
383Supporte les attribus communs.
384Si c'est une catéorie réordonnée alors EventdataPageDescription affichera la description de la catégorie.
385
386"EventdataPageURL"
387Supporte les attribus communs.
388L'URL de la page public des événements. (S'utilise comme {{tpl:BlogURL}} )
389
390"EventdataPageNav"
391Supporte les attribus communs.
392Menu de choix de période d'événement à afficher. (ex: Non débuté, En cours, etc...)
393Un attribu supplémantaire est ajouté: "menus", il permet de limiter le menu à des choix prédéfinis parmis les suivants:
394 'ongoing','outgoing','notstarted','started','notfinished','finished','all'. Par exemple pour limiter le menu à 2 choix
395il faut utiliser {{tpl:EventdataPageNav menus="notstarted,ongoing"}} ce qui donnera le menu suivant:
396"<div id="eventdata_nav"><ul><li><a href="...">Non débuté</a></li><li><a href="...">En cours</a></li></ul></div>"
397Si un tri est reconnu la balise "li" prendra la class "active".
398
399"EventdataPeriod"
400Supporte les attribus communs.
401Affiche dans quel periode se trouve l'entrée courante.
402Par exemple si le billet en cours à un événement associé qui est terminé, la period sera "finished"
403Un attribu suplémentaire est ajouté: "strict", si il est présent, une des valeurs "scheduled", "ongoing", "finished" sera retourné,
404cela peut servir pour les CSS par exemple.
405
406"EventdataStartDate"
407Supporte les mêmes attribus que "EntryDate".
408Date de début d'événement.
409
410"EventdataStartTime"
411Idem ci-dessus
412
413"EventdataEndDate
414idem ci-dessus
415
416"EventdataEndTime"
417idem ci-dessus
418
419"EventdataFullDate"
420Support les mêmes attribus que "EntryDate"
421Ecrit la date compète d'un événement en utilisant la valeur de langue "From %S to %D"
422Les attribus suplémentaires sont:
423- "start_format": Pour formater la date de début,
424- "end_format" : pour formater la date de fin.
425
426
427Les valeurs "EventdataStartDate", "EventdataStartTime", "EventdataEndDate", "EventdataEndTime", "EventdataFullDate" peuvent être utilisées
428soit sur la page "post.html", soit dans une bloc "EventdataEntries", soit dans un bloc "EntryEventdataDates".
429
430
431XIII. Behaviors publiques:
432==========================
433
434Les modifications des pages publiques passent par des appelles aux behaviors à differents niveaux.
435
436"publicBeforeDocument"
437Inscrit dans le "core" le chemin vers le modèle de l'extension.
438 
439"publicHeadContent"
440Ajoute au "head" du document le fichier css du modèle de l'extension.
441 
442"tplBeforeData"
443Redirige les pages des catégories réordonné vers la page "events".
444 
445"publicEntryBeforeContent"
446Si le modèle de l'extension possède un fichier "eventdataentrybeforecontent.html"
447le contenu de la balise "body" de ce fichier sera ajouté au document.
448Cela sert à ajouter dans un billet la liste des événements liés au billet sans toucher aux thèmes.
449Cet apelle peut-être désactivé dans la page de gestion du modèle au cas ou on préfère utiliser le widget.
450 
451"publicEntryAfterContent"
452Idem ci-dessus
453
454
455-----------
456End of file
Note: See TracBrowser for help on using the repository browser.

Sites map