Le plugin fonctionne sur base d’un modèle. Le contenu sgf peut être écrit en paramètre du modèle ou contenu dans un fichier au format sgf (Smart Game Format).
Le plugin a été testé sous SPIP 3.1 et 3.2, mais il n’y a pas à priori de raison pour qu’il ne fonctionne pas également sous SPIP 3.0, ou 2.1 et 2.0. Simplement, il faut tester. Des retours d’utilisateurs sont les bienvenus à ce propos.
Installation.
Comme n’importe quel plugin spip
Autorisation des documents SGF
SPIP a « oublié » ;) d’autoriser les fichiers d’extension .sgf et les compresse zip. Il faut donc les autoriser directement dans la base de données, en ajoutant une ligne dans la table « spip_type_documents ». Le plugin réalise cette opération à son activation.
Tierce partie
Le plugin embarque sa propre version de maxiGos, v6.64 (lecteurs autonomes seulement + editeur + fichiers de langue), sous licence BSD.
Règles du format sgf.
Si vous voulez écrire du sgf directement dans le contenu, référez vous aux spécifications du format. Mais, la plupart du temps, vous préférerez sans doute utiliser des fichiers sgf créés automatiquement.
Paramètres du modèle
Formatage
- langue=[langue]
où [langue] peut prendre les valeurs : fr (pour français, défaut), en (pour anglais), ja (pour japonais), zh (pour chinois), zh-tw (pour chinois taiwan)
- style=[style]
où [style] peut prendre les valeurs : classic (par défaut), neo (pour neo-classic), tatami, minimal (pour minimalist), cameleon, [qui sont des valeurs multitypes] ou fm, kifu, tiger [qui sont des valeurs monotypes]
- type=[type]
où [type] peut prendre les valeurs : basic (par défaut), comment, diagram, game, problem, tree [qui sont des valeurs multistyles], edit, lesson [qui sont des valeurs monostyles]
Pour la signification des paramètres style et type, référez-vous aux exemples présentés sur cette page http://jeudego.org/maxiGos/_maxigos/_doc/_fr/download.php du site de maxiGos, sous l’intertitre « Téléchargement des lecteurs autonomes uniquement », et visualisez les exemples.
Valeurs multitypes ou monotypes, et multistyles ou monostyles
- Les valeurs de style multitypes et les valeurs de types multistyles peuvent être associées, par exemple :
|style=neo|type=comment
ou|style=cameleon|type=problem
- Par contre,
- les valeurs de style monotypes (fm, kifu, tiger) ont leur propre type (et donc, le paramètre
|type=[quelquechose]
ne servira à rien avec ces styles. - et les valeurs de types monostyles (edit, lesson) ont leur propre style (et donc, le paramètre
|style=[quelquechose]
ne servira à rien avec ces types.
- les valeurs de style monotypes (fm, kifu, tiger) ont leur propre type (et donc, le paramètre
Contenu SGF
Si les deux deux paramètres qui suivent (id_doc et contenu) sont présents, seul le paramètre id_doc sera pris en compte.
- id=XX
ou <maxigosXX[...]>
— le contenu est dans un fichier d’id=XX, avec l’extension .sgf, téléchargé via SPIP ; peu importe que ce fichier soit lié ou non à l’objet (article, par exemple) où l’appel du modèle est inséré
- contenu=un_contenu_sgf_ecrit_directement
— le contenu SGF est écrit directement ou copié/collé dans l’objet SPIP. Attention, le contenu sgf écrit manuellement dans un article, ne supporte pas les « | » (pipe). Ceci vaut uniquement pour le paramètre contenu.
Paramètres de personnalisation, par types et styles
- Tous les types
-
init=[init]
où [init] peut prendre les valeurs : first (defaut, =aller au début du SGF) ou last (=aller à la fin de la variante principale du fichier SGF) — Paramètre maxiGos : initMethod -
ombre=X
où X peut prendre les valeurs : 0 (defaut, =n’affiche pas d’ombre en bas à droite des pierres) ou 1 (=affiche une ombre en bas à droite des pierres). — Paramètre maxiGos : stoneShadowOn
-
- Types basic, comment, game, tree, edit, lesson et styles fm, tiger
-
demo=X
où X peut prendre les valeurs : 0 (=le visiteur peut placer des pierres sur le goban et donc, créer des variantes ) ou 1 (=le visiteur ne peut pas placer de pierre sur le goban ni créer des variantes). Pratique pour les démonstrations. — Paramètre maxiGos : (le contraire de) canPlaceVariation
-
- Types comment, diagram, problem, tree, lesson, styles fm, tiger, kifu et tous les types du style tatami
-
indices=X
où X peut prendre les valeurs : 0 (=les indices ne sont pas affichés sur le pourtour du goban), 1 (=les indices sont affichés sur le pourtour du goban ) ou undefined (=le SGF décide via la propriété FG). — Paramètre maxiGos : indicesOn -
numeros=X
où X peut prendre les valeurs : 0 (=les pierres sur le goban ne sont pas numérotées), 1 (=les pierres sur le goban sont numérotées) ou undefined (=le SGF décide via la propriété PM). — Paramètre maxiGos : numberingOn
-
- Types tree, edit, et style tiger
-
commentaire_arbre=X
où X peut prendre les valeurs : 0 ou 1 (=Si X vaut 1, remplace le numéro des coups commentés par un « ? » dans l’arbre des coups). — Paramètre maxiGos : markCommentOnTree
-
- Type problem seulement.
-
recommencer_tout=X
où X peut prendre les valeurs : 0 ou 1 (=Si recommencer_tout vaut 1, affiche un bouton « Recommencer tout »). — Paramètre maxiGos : canRetry -
reprendre_coup=X
où X peut prendre les valeurs : 0 ou 1 (=Si reprendre_coup vaut 1, affiche un bouton « Reprendre un coup »). — Paramètre maxiGos : canUndo -
montrer_suite=X
où X peut prendre les valeurs : 0 ou 1 (=Si montrer_suite vaut 1, affiche un bouton « Montrer la suite ». Un clic sur ce bouton montre les coups de la première de l’arbre des coups à partir de la position courante). — Paramètre maxiGos : canContinuation
-
Exemples d’utilisation.
Dans un article, étant donné que l’utilisation dans un squelette paraît ici peu pertinente.
<maxigos|contenu=(;FF[4]GM[1]SZ[19]VW[aa:ii]FG[1]AW[ee]AB[de][fe][ed];B[ef]C[Correct !])>
présentera un exemple de problème (prise d’une pierre), en style classic, type basic.
<maxigosXX|style=tatami|type=tree|langue=zh>
affichera un lecteur de style tatami, de type tree, en chinois, avec la partie ou le problème contenu dans un fichier .sgf d’id=XX.
Démonstration
- Dans les articles de cette rubrique
- Sur le site de l’European Go Congress 2019
Aucune discussion
Ajouter un commentaire
Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :
Merci d’avance pour les personnes qui vous aideront !
Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.
Suivre les commentaires : |