Dotclear

source: plugins/rateIt/README.txt @ 1301

Revision 1301, 10.2 KB checked in by JcDenis, 14 years ago (diff)

rateIt 0.4:

  • changed database rateit_id to allow text id
  • fixed some js bugs
  • fixed translation
  • Added option to edit thank msg
  • Added cookie and/or ip option
  • Added images choice
  • Added some options to widget
  • Added extension ability
  • Added import/export support
Line 
1rateIt 0.4 (2009/06/27) plugin for Dotclear 2
2
3Préambule:
4==========
5
6Cette extension pour Dotclear 2 permet d'ajouter un système complet
7de notation pour les billets. (et plus avec ses addons).
8
9Cette documentation est en cours d'écriture...
10
11
12I. Licence:
13===========
14
15This file is part of rateIt, a plugin for Dotclear 2.
16Copyright (c) 2009 JC Denis and contributors
17jcdenis@gdwd.com
18Licensed under the GPL version 2.0 license.
19A copy of this license is available at
20http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21
22Some icons from Silk icon set 1.3 by Mark James at:
23http://www.famfamfam.com/lab/icons/silk/
24under a Creative Commons Attribution 2.5 License at
25http://creativecommons.org/licenses/by/2.5/
26
27The javascript Cookie plugin
28Copyright (c) 2006 Klaus Hartl (stilbuero.de)
29is licensed under the MIT License and the GPL License.
30http://www.opensource.org/licenses/mit-license.php
31http://www.gnu.org/licenses/gpl.html
32
33The javascript Star Rating Plugin by Fyneworks.com
34Copyright (c) 2008 Fyneworks.com
35is licensed under the MIT License and the GPL License.
36http://www.opensource.org/licenses/mit-license.php
37http://www.gnu.org/licenses/gpl.html
38
39
40II. Support:
41============
42
43http://blog.jcdenis.com/?q=dotclear+plugin+rateIt
44http://forum.dotclear.net/viewtopic.php?id=39801
45http://lab.dotclear.org/wiki/plugin/rateIt
46
47
48III. Installation:
49==================
50
51Voir la procédure d'installation des plugins Dotclear 2.
52Pour information, le plugin rateIt créé la table "rateit".
53
54
55IV. Désintallation:
56===================
57
58Une procédure complète est disponible à partir du gestionnaire d'extension
59ou depuis l'onglet "désinstallation" de l'extension "RateIt".
60
61
62V. Onglet "Administration":
63===========================
64
65V.1 Extension:
66--------------
67
68"Activer l'extension"
69Permet d'activer ou non l'extension sur un blog.
70Avec une configuration d'origine, la désactivation de l'extension
71masquera toutes les balise en rapport avec le plugin coté publique.
72
73"Inclure dans les billets":
74Permet d'inclure l'outil de vote directement à la fin d'un billet sans modifier les templates.
75La balise {{tpl:SysBehavior behavior="publicEntryAfterContent"}} doit être présente
76dans le thème utilisé pour que cete option fonctionne.
77
78"Identifier l'utilisateur par"
79Methode de gestion des votes, soit par Ip, soit par cookie, soit les deux.
80Chaque méthode a ses avantages et ses inconvénients.
81
82V.2 Note:
83---------
84
85"Note sur"
86Permet de modifier le quotient de la note de 2 à 20. (exemple de note 5/20)
87
88"Nombre de décimals"
89Permet d'arrondir le résultat affiché à x chiffres après la virgule. (de 0 à 4)
90
91"Message de remerciement"
92Après un vote l'interface peut être modifié en affichant un message au votant.
93Si le message est vide, l'interface ne sera pas modifié.
94
95V.2 Image:
96----------
97
98Vous pouvez modifer l'apparence de l'interface de vote avec
99un choix prédéfinie d'image ou en en ajoutant une nouvelle.
100La nouvelle image doit obligatoirement être à format "png"
101et avec trois parties égales en hauteur:
102- Une partie haute représentant "un non vote",
103- une partie centrale représentant un vote positif et
104- une partie basse représentant le survole par la souris.
105La largeur et la hauteur sont à votre convenance.
106
107
108VI. Onglet "Désintallation":
109============================
110
111...
112
113
114VII. Onglet "A propos":
115=======================
116
117Donne des indications sur l'extension.
118La version, Les droits, des liens vers le support...
119
120
121VIII. Onlget "Billets":
122======================
123
124...
125
126
127IX. Autres onlgets:
128===================
129
130D'autres onglets peuvent être présents si d'autres plugins
131utilisent l'interface "rateIt".
132...
133
134
135X. Widgets:
136===========
137
1382 widgets sont disponibles:
139
140X.1 Evaluation:
141---------------
142
143Ce widget (de class "rateitwidget" ) permet d'afficher une interface de vote sur la page d'un billet.
144
145"Autoriser le vote pour les billets"
146Si cette option est cochée et qu'on est sur la page d'un billet,
147le widget affichera un formulaire de vote.
148
149"Titre pour les billets"
150Permet de modifier le titre du widget pour le vote sur les billets.
151Si ce champs est vide alors la balise de titre ne sera pas présente.
152
153"..."
154D'autres options sont possibles ici si d'autres plugins utilisent la même interface.
155Par exemple le vote pour des catégories, des tags...
156Un behavior "parseWidgetRateItVote" est disponible ici.
157
158"Afficher la note complète"
159Ajoute l'affichage d'une balise de class "rateit-fullnote" contenant:
160- soit la note complète, exemple: 5/20,
161- soit la note en pourcentage, exemple: 25%
162- soit la balise n'est pas présente si "cacher" est selectionné.
163
164"Afficher la note"
165Affiche la note dans une list-item,
166
167"Afficher le nombre de votes"
168Idem ci-dessus.
169
170"Afficher la note la plus haute"
171Idem ci-dessus.
172
173"Affiher la note la plus basse"
174Idem ci-dessus.
175
176
177X.2 Top évaluation:
178-------------------
179
180Ce widget (de class "rateitpostsrank") permet d'afficher un classement des votes.
181
182"Titre"
183Permet de modifier le titre du widget.
184Si ce champ est vide la balise de titre ne sera pas présente.
185
186"Type"
187Par défaut seul le type "Billets" est présent.
188D'autres type sont possibles ici si d'autres plugins utilisent la même interface.
189Un behavior "parseWidgetRateItRank" est disponible ici.
190
191"Longueur"
192Nombre de billets à afficher.
193
194"Trier par"
195Il est possible de trier les résultats par nombre de vote ou par note.
196
197"Trier"
198Permet de modifier l'ordre. Croissant ou décroissant.
199
200"Texte"
201Permet de mettre en forme le résultat avec comme options:
202- %rank% : le rang (1, 2, 3...)
203- %title% : le titre du billet,
204- %note% : la note
205- %quotient% : le quotient,
206- %percent% : la note en pourcentage,
207- %count% : le nombre de vote.
208
209"Uniquement sur la page d'accueil"
210Affiche le widget uniquement sur la page d'accueil du blog.
211
212
213XI. Comment modifier l'apparence de l'extension?
214================================================
215
216XI.1 Emplacement des fichiers:
217------------------------------
218
219...
220
221XI.2 les widgets:
222-----------------
223
224a) Widget "Evaluation":
225
226Voici la structure type de ce widget:
227
228<div class="rateitwidget">
229 <h2>titre</h2>
230 <p><span id="xxx" class="rateit-fullnote">0/10</span></p>
231 <form class="rateit-linker" id="xxx" action="xxx" method="post">
232  <p>
233   <input name="xxx" class="rateit-type-id" type="radio" value="1"/>
234   <input name="xxx" class="rateit-type-id" type="radio" value="2"/>
235   ...
236   <input type="submit" name="submit" value="Voter"/>
237  </p>
238 </form>
239 <ul>
240  <li>Note:<span id="xxx" class="rateit-note">0</span></li>
241  <li>Vote:<span id="xxx" class="rateit-vote">0</span></li>
242  <li>Plus haute:<span id="xxx" class="rateit-higher">0</span></li>
243  <li>Plus basse:<span id="xxx" class="rateit-lower">0</span></li>
244 </ul>
245</div>
246
247La structure de la balise "form" est modifiée par le javascript de notation.
248La structure CSS en rapport avec ce javascript est directement généré dans
249le code source de la page.
250
251b) Widget "Top évaluation":
252
253Voici la structure type de ce widget:
254
255<div class="rateitpostsrank">
256 <h2>titre</h2>
257 <ul>
258  <li>texte</li>
259  <li>texte</li> ou
260  <li><span class="rateit-rank">1</span>texte</li>
261  ...
262 </ul>
263</div>
264
265XI.3 Formulaires inclus dans la page:
266-------------------------------------
267
268Son emplacement dépend du thème utilisé sur le blog.
269Par défaut il se situe après le contenu d'un billet
270et utilise le behavior {{tpl:SysBehavior behavior="publicEntryAfterContent"}}
271Son apparence dépend également du thème.
272Par défaut il utilise le fichier "default-templates/tpl/rateit.html" de l'extension.
273
274
275XII. Comment étendre cette extension à d'autres types de notation?
276==================================================================
277
278...
279
280
281XIII. Behaviors:
282================
283
284XIII.1 callBehavior:
285---------------------
286
287"addRateItType":
288
289"rateitGetRates":
290
291"adminRateItTabs":
292
293"templateRateItRedirect":
294
295"publicRatingBlocsRateit":
296
297"templateRateIt":
298
299"templateRateItTitle":
300
301"initWidgetRateItVote":
302
303"parseWidgetRateItVote":
304
305"initWidgetRateItRank":
306
307"parseWidgetRateItRank":
308
309
310XIII.2 addBehavior:
311--------------------
312
313"pluginsBeforeDelete":
314
315"adminBeforePostDelete":
316
317"adminPostsActionsCombo":
318
319"adminPostsActions":
320
321"adminPostsActionsContent":
322
323"exportFull":
324
325"exportSingle":
326
327"importInit":
328
329"importSingle":
330
331"importFull":
332
333"publicHeadContent":
334
335"publicEntryAfterContent":
336
337"initWidgets":
338
339
340XIV. Public Urls, values, blocks:
341=================================
342
343XIV.1 Urls:
344-----------
345
346"rateit":
347
348"rateitnow":
349
350"rateitservice":
351
352XIV.2 blocks:
353-------------
354
355"rateIt":
356
357"rateItIf":
358
359XIV.3 values:
360-------------
361
362"rateItLinker":
363
364"rateItTitle":
365
366"rateItTotal":
367
368"rateItMax":
369
370"rateItMin":
371
372"rateItNote":
373
374"rateItFullnote":
375
376"rateItQuotient":
377
378
379XV. Javascripts:
380================
381
382...
383
384
385XVI. Base de données:
386=====================
387
388XVI.1 Structure:
389----------------
390
391CREATE TABLE `dc_rateit` (
392  `blog_id` varchar(32) collate utf8_bin NOT NULL,
393  `rateit_id` varchar(255) collate utf8_bin NOT NULL,
394  `rateit_type` varchar(64) collate utf8_bin NOT NULL,
395  `rateit_note` int(11) NOT NULL,
396  `rateit_quotient` int(11) NOT NULL,
397  `rateit_ip` varchar(64) collate utf8_bin NOT NULL,
398  `rateit_time` datetime NOT NULL default '1970-01-01 00:00:00',
399  PRIMARY KEY  (`blog_id`,`rateit_type`,`rateit_id`,`rateit_ip`),
400  KEY `dc_idx_rateit_blog_id` USING BTREE (`blog_id`),
401  KEY `dc_idx_rateit_rateit_type` USING BTREE (`rateit_type`),
402  KEY `dc_idx_rateit_rateit_id` USING BTREE (`rateit_id`),
403  KEY `dc_idx_rateit_rateit_ip` USING BTREE (`rateit_ip`)
404) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;
405
406
407XVII. Arborescence:
408===================
409
410/rateIt
411
412/rateIt/default-templates
413
414/rateIt/default-templates/img
415
416/rateIt/default-templates/img/stars
417
418/rateIt/default-templates/js
419
420/rateIt/default-templates/tpl
421
422/rateIt/inc
423
424/rateIt/locales
425
426/rateIt/locales/fr
427
428
429XVIII. Remerciements:
430=====================
431
432Je tiens à remiercier les personnes qui ont eu la patience de tester toutes les versions d'essais
433et de donner un coup de main. Je remercie également toute l'équipe de Dotclear.
434
435-----------
436End of file
Note: See TracBrowser for help on using the repository browser.

Sites map