Go diagrams with maxiGos.

Maxigos is a plugin for SPIP which allows the use of the main features of maxiGos, « a set of tools to insert games, problems and go diagrams saved in sgf format in a web page. »

The plugin works on basis of a model. The sgf code can be written as a parameter of the model or contained in an sgf (Smart Game Format) file.

The plugin was tested under SPIP 3.1, but there is no reason it should not work under SPIP 3.0, or 2.1 and 2.0. You have to test. Feedbacks from users are welcome.

Installation.

As any spip plugin

Authorization of SGF documents

SPIP has « forgotten » ;) to allow .sgf extension files and compresses them as zip files. They have to be authorized directly in the database, by adding a row in the « spip_type_documents » table. The plugin performs this operation on activation.

Third party.

The plugin embeds its own version of maxiGos, v6.64 (standalone players only + editor + language files), licensed BSD.

Rules for sgf format.

If you want to write sgf directly into the content, refer to the spécifications. But, most of the time, you will probably prefer to use sgf files.

Model parameters

formatting
-  langue=[langue] where [langue] can take the values : fr (for French, default), en (for English), ja (for Japanese), zh (for Chinese), zh-tw (for Chinese-taiwan)
-  style=[style] where [style] can take the values : classic (default), neo (for neo-classic), tatami, minimal (for minimalist), cameleon, [which are multitype values] or fm, kifu, tiger [which are monotype values]
-  type=[type] where [type] can take the values : basic (default), comment, diagram, game, problem, tree [which are multistyle values], edit, lesson [which are monostyle values]

For the meaning of the style and type parameters, refer to the examples on this page http://jeudego.org/maxiGos/_maxigos/_doc/_en/download.php from the maxiGos website under the heading « Download stand-alone players only » and view the examples.

Multitypes or monotypes, and multistyles or monostyles

  • Multitypes style values ​​and multistyles type values ​​can be associated, for example : | style=neo | type=comment or | style=cameleon | type=problem
  • On the other hand,
    • The monotype style values ​​(fm, kifu, tiger) have their own type (and therefore the | type=[something] parameter will not do anything with these styles.
    • And the monostyle types (edit, lesson) have their own style (and therefore the | style=[something] parameter will not work with these types.

SGF content
If the two following parameters (id_doc and contenu) are present, only the id_doc parameter will be taken into account.
-  id=XX or <maxigosXX|[...]> - the content is in a file of id=XX, with extension .sgf, downloaded via SPIP. Regardless of whether the file is linked to the object (such as the article) where the model call is inserted
-  contenu=a_sgf_content_directly_written - the SGF content is written directly or copied/pasted into the SPIP object. Beware, sgf content manually written in an article, does not support the « | » (pipe). This applies only to the contenu parameter.

Customization parameters, by types and styles

  • All types
    • init=[init] where [init] can take the values : first (default, =go to the start of the SGF) or last (=go to the end of the main variant of the SGF file) - maxiGos parameter : initMethod
    • ombre=X where X can take the values : 0 (default, =does not display a shadow on stone bottom right) or 1 (=displays a shadow on stone bottom right). - maxiGos parameter : stoneShadowOn
  • Types basic, comment, game, tree, edit, lesson and styles fm, tiger
    • demo=X where X can take the values : 0 (=the visitor can place stones on the goban and thus create variants) or 1 (=the visitor can not place a stone on the goban or create variants). Practical for demonstrations. - Parameter maxiGos : (opposite to) canPlaceVariation
  • Types comment, diagram, problem, tree, lesson, styles fm, tiger, kifu and all tatami style types
    • indices=X where X can take the values : 0 (=The indices are not displayed arround the goban), 1 (=The indices are displayed arround the goban) or undefined (=the SGF decides via the FG property). - Parameter maxiGos : indicesOn
    • numeros=X where X can take the values : 0 (=the stones on the goban are not numbered), 1 (=the stones on the goban are numbered) or undefined (=the SGF decides via the PM property). - MaxiGos parameter : numberingOn
  • Types tree, edit, and tiger style
    • commentaire_arbre=X where X can take the values : 0 or 1 (= If X is 1, replaces in the tree commented move numbers by a «  ? »). - maxiGos parameter : markCommentOnTree
  • Type problem only.
    • recommencer_tout=X where X can take the values : 0 or 1 (=If recommencer_tout is 1, displays a retry button). - maxiGos parameter : canRetry
    • reprendre_coup=X where X can take the values : 0 or 1 (= If reprendre_coup is 1, displays an undo button). - MaxiGos parameter : canUndo
    • montrer_suite=X where X can take the values : 0 or 1 (= If montrer_suite is 1, displays a continuation button. A click on this button shows moves of the first branch of the sgf tree from the current position). - MaxiGos parameter : canContinuation

Examples of use.

In an article, since the use in a template appears here irrelevant.

<maxigos|content=(;FF[4]GM[1]SZ[19]VW[aa:ii]FG[1]AW[ee]AB[de][fe][ed];B[ef]C[Correct !])> will present an example of a problem (taking a stone), in classic style, basic type.

<MaxigosXX|style=tatami|type=tree|language=zh> will display a tatami-style player, with a tree type, in Chinese language, from the game or the problem contained in a .sgf file of id=XX.

Temporary demonstration


-  In the articles of this section
-  On European Go Congress 2019 website

Discussion

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

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.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom