source: spip-zone/_plugins_/pgn4spip/trunk/_LisezMoi.txt @ 100374

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

nettoyage, mise à jour fichiers lisez-moi

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