Raccourcis : Contenu - rubriques - sous rubriques
EN FR

l'éditeur wiki consiste à fournir une barre d'outils permettant de facilité la mise en forme de son texte.

Pour cela MarkItUp a été intégré.

Configuration de l'éditeur

La configuration d'un éditeur doit avoir un nom, que l'on indiquera dans la balise <wikieditor>. Ce nom est utilisé comme prefix dans les paramètres de configuration de la section wikieditors du fichier de configuration.

Voici la configuration par défaut, nommé default :


[wikieditors]

default.engine.name = wr3
default.wiki.rules = wr3_to_xhtml

Où :

  • "default" est le nom de la configuration de l'éditeur
  • default.engine.name indique le nom du moteur utiliser pour le rendu
  • default.wiki.rules indique le nom de la règle de transformation

Il faut également spécifier les fichiers JS et CSS. On utilise pour cela les les webassets. Le groupe de webassets pour une configuration wikieditor doit prendre le nom de la configuration (ici default), préfixé par jforms_wikieditor_. La configuration par défaut est celle-ci :


[webassets_common]

; path to markitup files
jforms_wikieditor_default.js[]="$jelix/markitup/jquery.markitup.js"

; path to translation files
jforms_wikieditor_default.js[]="$jelix/markitup/sets/wr3/$locale.js"

; path to a skin for MarkitUp
jforms_wikieditor_default.css[]="$jelix/markitup/skins/simple/style.css"
jforms_wikieditor_default.css[]="$jelix/markitup/sets/wr3/style.css"

; dependency of markitup: the webassets group named "jquery"
jforms_wikieditor_default.require=jquery

Vous pourriez aussi utiliser un autre set supporté par MarkitUp, tel que markdown. Il faudrait alors créer une autre configuration, ou modifier celle par défaut. On peut l'appeler "md", et utiliser donc les fichiers js et css du "set" markdown de MarkitUp.


[wikieditors]
md.engine.name = markdown
md.wiki.rules = md_to_xhtml

[webassets_common]

jforms_wikieditor_md.js[]="$jelix/markitup/jquery.markitup.js"
jforms_wikieditor_md.js[]="$jelix/markitup/sets/markdown/set.js"
jforms_wikieditor_md.css[]="$jelix/markitup/skins/simple/style.css"
jforms_wikieditor_md.css[]="$jelix/markitup/sets/markdown/style.css"
jforms_wikieditor_md.require=jquery

(les rêgles md_to_xhtml n'existent pas vraiment, il faudrait les développer).

Configuration jForms

Donc pour ajouter un éditeur wiki à son formulaire on notera dans son fichier *.form.xml :


<wikieditor ref="message" config="default" required="true">

où :

  • ref est le nom du champ ici message
  • config est le nom de la configuration utilisée dans mainconfig.ini.php
  • required dans le cas où l'on souhaite obliger la saisie du champ "message"