source: spip-zone/_plugins_/pgn4spip/branches/_LisezMoi.txt @ 90061

Last change on this file since 90061 was 90061, checked in by jack@…, 6 years ago

Avant de tout casser on passe le trunk dans "branches"

File size: 6.6 KB
Line 
1Le plug-in pgn4spip 2.61.0 pour SPIP 2 et 3 affiche l'échiquier et la partie de jeu d'échecs
2saisie au format PGN américain à l'intérieur d'un article entre les balises [pgn] et [/pgn]
3ou [PGN] et [/PGN].
4
5Usage dans le corps d'un article :
6
7Avant
8[pgn] 1. e4 Nf6 [/pgn]
9Après
10
11
12pgn4spip est l'interface pour SPIP de pgn4web de Paolo Casaschi
13http://pgn4web.casaschi.net/home.html
14
15Démo en ligne
16http://pgn4web.casaschi.net/demo.html
17
18Démo en local
19http://localhost/spip/plugins/pgn4spip/pgn4web/demo.html
20
21pgn4spip a été développé par Matt Chesstale en PHP, Javascript, HTML, CSS, CFG et SPIP.
22matteo.chesstale@gmail.com
23Licence : GNU GPL 3.0 (c) 2012
24
25    This program is free software: you can redistribute it and/or modify
26    it under the terms of the GNU General Public License as published by
27    the Free Software Foundation, either version 3 of the License, or
28    (at your option) any later version.
29
30    This program is distributed in the hope that it will be useful,
31    but WITHOUT ANY WARRANTY; without even the implied warranty of
32    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
33    GNU General Public License for more details.
34
35    You should have received a copy of the GNU General Public License
36    along with this program.  If not, see <http://www.gnu.org/licenses/>.
37
38Il ne nécessite pas le plug-in CFG 3.x pour sa configuration dans SPIP 3.x
39Il nécessite le plug-in CFG 1.x pour sa configuration dans SPIP 2.x
40http://plugins.spip.net/cfg.html
41
42pgn4spip est compatible avec le plug-in Couteau Suisse 1.8.x,
43lame "Améliorations des textes : Guillemets typographiques"
44pgn4spip doit être activé APRES le Couteau Suisse.
45pgn4spip ne nécessite pas le Couteau Suisse.
46________________
47
481. Installation du plug-in
49
50Déziper pgn4spip-2.61.0.zip dans le répertoire des plug-ins SPIP.
51Exemple : D:\Xampp\Xampp177\htdocs\spip\plugins\
52
53Télécharger la dernière version de pgn4web: pgn4web-2.61.zip
54http://code.google.com/p/pgn4web/downloads/list
55
56Déziper pgn4web-2.61.zip dans le répertoire de pgn4spip
57Exemple : D:\Xampp\Xampp177\htdocs\spip\plugins\pgn4spip
58
59Le nom du répertoire du plug-in est toujours en minuscule.
60
61Enlever le numéro de version :
62renommer pgn4spip\pgn4web-2.61 en pgn4spip\pgn4web
63Exemple : D:\Xampp\Xampp177\htdocs\spip\plugins\pgn4spip\pgn4web
64
65Le répertoire pgn4web a une taille de 13 Mo.
66Dans le cas de site ayant une place disque réduite,
67on peut éventuellement effacer certaines polices non utilisées
68parmi alpha, merida, svgchess ou des fichiers de démo.
69Garder les polices uscf/20 et 26.
70________________
71
722. Configuration du plugin
73
74http://localhost/spip/ecrire/?exec=admin_plugin
75SPIP Configuration > Gestion des plugins
76
77Cliquer [x] pour activer le plug-in.
78Dans SPIP 3, confirmer en cliquant sur "Valider" même grisé.
79
80Cliquer sur le nom "pgn4spip" pour avoir l'aide.
81
82Cliquer sur l'icône du tournevis et de la clef (cfg-16.png) à droite en face du nom pgn4spip
83
84Le répertoire doc\ n'est pas nécessaire à l'exécution du plugin.
85Il n'est pas utile de le copier sur le site SPIP en ligne.
86
87La configuration peut être facultativement testée en anglais en ligne dans
88http://pgn4web.casaschi.net/board-generator.html
89
90ou en local
91http://localhost/spip/plugins/pgn4spip/pgn4web/board-generator.html
92________________
93
943. Usage avancé
95
96Le plugin peut être optionnellement configuré dans les paramètres de la balise [pgn]
97à l'intérieur d'un article. Voir l'aide lors de la configuration du plugin.
98
99doc\pgn4web parameters.txt
100http://localhost/spip/plugins/pgn4spip/pgn4web/board.html?help=true
101
102Exemple dans le corps d'un article :
103
104Avant
105[pgn height=500 autoplayMode=loop] 1. e4 Nf6 [/pgn]
106Après
107
108
109Fichier texte exemple de test à copier-coller dans un article SPIP 2 ou SPIP 3 :
110
111Test01 Symbol eval.txt : variations, évaluations symboles "avec l'idée de"
112Test02 MultiPgn.txt    : plusieurs parties de jeu d'échecs
113Test03 Puzzle Fen.txt  : deux problèmes d'échecs
114Test04 Puzzle URL      : problèmes d'échecs via l'URL du fichier .pgn
115Test05 Puzzle Doc.txt  : problèmes d'échecs dans fichier .pgn attaché à l'article
116Test06 Comment.txt     : commentaires dans une partie d'échecs
117Test07 Puzzle Docs     : le fichier .pgn est attaché à l'article comme un document
118Test08 Table 2 board   : deux balises pgn horizontalement dans une table
119Test09 Live horizontal : diffusion en temps réel de la partie live.pgn mode horizontal
120Test10 Live vertical   : diffusion en temps réel de la partie live.pgn mode vertical
121
122Le répertoire test\ n'est pas nécessaire à l'exécution du plugin.
123________________
124
1253.1 Résolution de problèmes
126
127Symptôme 1 : avec le Couteau Suisse activé
128A la place de l'échiquier, je vois l'entête du PGN avec éventuellement
129quelques étranges guillemets ou même des figurines d'Echecs à l'intérieur des commentaires PGN.
130
131Solution 1: désactiver pgn4spip puis réactiver pgn4spip.
132Cela permet d'activer pgn4spip après le Couteau Suisse.
133
134Solution 2: si le problème persiste, essayer à nouveau en vidant le cache de SPIP
135entre la désactivation et la réactivation du plugin pgn4spip.
136SPIP 3 : Maintenance > Vider le cache > Cliquer "Vider le cache" dans Taille du répertoire cache.
137SPIP 2 : Configuration > Vider le cache > Cliquer "Vider le cache" dans Taille du répertoire cache.
138
139Solution 3: si le problème persiste, essayer à nouveau en vidant également le cache du navigateur sinon
140désactiver le Couteau Suisse ou sa lame "Améliorations des textes : Guillemets typographiques".
141____________
142
143Symptôme 2 : les paramètres à l'intérieur de la balise <pgn> de document attaché ne sont pas pris en compte
144Syntaxe erronée : <pgn1 | movesDisplay = puzzle bd = s>
145
146Solution: ajouter option="..." et enlever chaque espace séparateur
147sauf après une valeur et le paramètre suivant.
148<pgn1|option="movesDisplay=puzzle bd=s sS=35">
149
150Voir test\Test05
151________________
152
1533.2 Diffusion en live de la partie d'Echecs
154
155test\Test09 et Test10 montrent l'usage du paramètre movesDisplay=live et refreshMinutes=0.25
156qui gérent le rafraichissement périodique de l'échiquier à partir du fichier
157pgnData=http://localhost/spip/plugins/pgn4spip/pgn4web/live/live.pgn
158mis à jour à une autre fréquence grâce au simulateur
159spip\plugins\pgn4spip\pgn4web\live\live-simulation.sh
160
161C'est un script Unix Bash que l'on peut faire fonctionner dans Windows avec le freeware c:\cygwin
162Lire instructions dans test\Test09
163
164spip\plugins\pgn4spip\test\MacroRunSimu.bat est un outil batch à personnaliser.
165Indiquer le chemin complet du serveur web et le répertoire du plugin.
166Il définit des macros doskey pour la ligne de commande "Command Prompt" de Windows
167afin de lancer votre serveur web et le (s)imulateur.
Note: See TracBrowser for help on using the repository browser.