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

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

Des mises à jour de LisezMoi/ReadMe? en attente...

File size: 5.2 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 après avoir créé un dossier plugins/auto/
41
42________________
43
442. Configuration du plugin
45
46http://monsite.tld/ecrire/?exec=admin_plugin
47SPIP Configuration > Gestion des plugins
48
49Cliquer [x] pour activer le plug-in.
50Confirmer en cliquant sur "Valider".
51
52Cliquer sur le nom "pgn4spip" pour avoir l'aide.
53
54Cliquer sur l'icône du tournevis et de la clef à droite en face du nom pgn4spip
55
56La configuration peut être facultativement testée en anglais en ligne dans
57http://pgn4web.casaschi.net/board-generator.html
58
59________________
60
613. Usage avancé
62
63Le plugin peut être optionnellement configuré dans les paramètres de la balise [pgn]
64à l'intérieur d'un article. Voir l'aide lors de la configuration du plugin.
65
66doc\pgn4web parameters.txt
67http://localhost/spip/plugins/pgn4spip/pgn4web/board.html?help=true
68
69Exemple dans le corps d'un article :
70
71Avant
72[pgn height=500 autoplayMode=loop] 1. e4 Nf6 [/pgn]
73Après
74
75Fichier texte exemple de test à copier-coller dans un article SPIP 2 ou SPIP 3 :
76
77Test01 Symbol eval.txt : variations, évaluations symboles "avec l'idée de"
78Test02 MultiPgn.txt    : plusieurs parties de jeu d'échecs
79Test03 Puzzle Fen.txt  : deux problèmes d'échecs
80Test04 Puzzle URL      : problèmes d'échecs via l'URL du fichier .pgn
81Test05 Puzzle Doc.txt  : problèmes d'échecs dans fichier .pgn attaché à l'article
82Test06 Comment.txt     : commentaires dans une partie d'échecs
83Test07 Puzzle Docs     : le fichier .pgn est attaché à l'article comme un document
84Test08 Table 2 board   : deux balises pgn horizontalement dans une table
85Test09 Live horizontal : diffusion en temps réel de la partie live.pgn mode horizontal
86Test10 Live vertical   : diffusion en temps réel de la partie live.pgn mode vertical
87
88Le répertoire test\ n'est pas nécessaire à l'exécution du plugin.
89________________
90
913.1 Résolution de problèmes
92
93Symptôme 1 : avec le Couteau Suisse activé
94A la place de l'échiquier, je vois l'entête du PGN avec éventuellement
95quelques étranges guillemets ou même des figurines d'Echecs à l'intérieur des commentaires PGN.
96
97Solution 1: désactiver pgn4spip puis réactiver pgn4spip.
98Cela permet d'activer pgn4spip après le Couteau Suisse.
99
100Solution 2: si le problème persiste, essayer à nouveau en vidant le cache de SPIP
101entre la désactivation et la réactivation du plugin pgn4spip.
102SPIP 3 : Maintenance > Vider le cache > Cliquer "Vider le cache" dans Taille du répertoire cache.
103
104Solution 3: si le problème persiste, essayer à nouveau en vidant également le cache du navigateur sinon
105désactiver le Couteau Suisse ou sa lame "Améliorations des textes : Guillemets typographiques".
106____________
107
108Symptôme 2 : les paramètres à l'intérieur de la balise <pgn> de document attaché ne sont pas pris en compte
109Syntaxe erronée : <pgn1 | movesDisplay = puzzle bd = s>
110
111Solution: ajouter option="..." et enlever chaque espace séparateur
112sauf après une valeur et le paramètre suivant.
113<pgn1|option="movesDisplay=puzzle bd=s sS=35">
114
115Voir test\Test05
116________________
117
1183.2 Diffusion en live de la partie d'Echecs
119
120test\Test09 et Test10 montrent l'usage du paramètre movesDisplay=live et refreshMinutes=0.25
121qui gérent le rafraichissement périodique de l'échiquier à partir du fichier
122pgnData=http://localhost/spip/plugins/pgn4spip/pgn4web/live/live.pgn
123mis à jour à une autre fréquence grâce au simulateur
124spip\plugins\pgn4spip\pgn4web\live\live-simulation.sh
125
126C'est un script Unix Bash que l'on peut faire fonctionner dans Windows avec le freeware c:\cygwin
127Lire instructions dans test\Test09
128
129spip\plugins\pgn4spip\test\MacroRunSimu.bat est un outil batch à personnaliser.
130Indiquer le chemin complet du serveur web et le répertoire du plugin.
131Il définit des macros doskey pour la ligne de commande "Command Prompt" de Windows
132afin de lancer votre serveur web et le (s)imulateur.
Note: See TracBrowser for help on using the repository browser.