User:Remember the dot/Syntax highlighter/fr

Remember the dot a créé un script qui permet de colorer la wikisyntaxe. Contrairement à d'autres scripts de coloration (wikEd et AceWikiEditor)  :

• la coloration du texte que vous tapez s'effectue immédiatement ;
• les boutons Défaire et Annuler ne sont pas affectés ;
• la vérification orthographique n'est pas perturbée ;
• il possède une forte compatibilité avec les autres scripts affectant la zone d'édition.

Installation

Note : pensez à consulter la liste des problèmes connus avant l'installation.

Pour l'utilisateur final

Si le script est installé sur le wiki

Syntax highlighter est disponible en tant que gadget, allez dans vos préférences et activez-le (pour la Wikipédia francophone : Zone d'édition, DotsSyntaxHighlighter).

Si le script n'est pas installé sur le wiki

Si l'installation en tant que gadget n'est pas possible, ajoutez ces lignes dans votre page common.js.

//syntax highlighter
mw.loader.load('//www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-DotsSyntaxHighlighter.js&action=raw&ctype=text/javascript');

Par exemple, si la Wikipédia francophone ne proposait le gadget, il faudrait ajouter ces lignes sur https://fr.wikipedia.org/wiki/Special:MyPage/common.js (après avoir créé cette page si elle n'existe pas).

Pour les administrateurs des Wiki de Wikimedia Foundation

Sur votre wiki créez la page MediaWiki:Gadget-DotsSyntaxHighlighter.js‎ avec le code :

mw.loader.load('//www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-DotsSyntaxHighlighter.js&action=raw&ctype=text/javascript');

Puis ajoutez à la page MediaWiki:Gadgets-definition‎ une nouvelle ligne : *DotsSyntaxHighlighter[ResourceLoader]|DotsSyntaxHighlighter.js

Créez enfin la page MediaWiki:Gadget-DotsSyntaxHighlighter‎ avec : active la coloration syntaxique du wikitexte.

Pour les administrateurs d'autres Wiki

Sur votre wiki créez la page MediaWiki:Gadget-DotsSyntaxHighlighter.js‎ en copiant le code source de User:Remember the dot/Syntax highlighter.js.

Puis ajoutez à la page MediaWiki:Gadgets-definition‎ une nouvelle ligne : *DotsSyntaxHighlighter[ResourceLoader]|DotsSyntaxHighlighter.js

Créez enfin la page MediaWiki:Gadget-DotsSyntaxHighlighter‎ avec : active la coloration syntaxique du wikitexte.

Pour MediaWiki 1.22 ou supérieur.

Problèmes connus

Compatibilité

1. La coloration syntaxique fonctionne mieux avec la dernière version de Firefox ;
2. La coloration syntaxique fonctionne de façon quasi systématique avec Chrome, Safari et Opera mais peut rencontrer des difficultés en cas d'écriture en thaï ou tibétain ;
3. La coloration syntaxique ne fonctionne pas avec Internet Explorer ;
4. La coloration syntaxique peut rencontrer des difficultés en cas de zoom dans le navigateur ;
5. La coloration syntaxique peut se révéler incompatible avec certains scripts affectant la zone d'édition.

Parsing

1. Pour des raisons de performances, la coloration syntaxique requiert que tous les tags soient valides. Par exemple, assurez-vous si vous débutez un <p> de bien le fermer avec </p>, préférez également <br/> plutôt que <br> ;
2. Pour des raisons de performances, la coloration syntaxique ne peut gérer '''apostrophe italic'' ou ''italic apostrophe'''. Il est possible de s'affranchir de cette limitation en utilisant le modèle {{'}} ou les apostrophes courbes ;
3. Les balises <pre> créées par l'insertion d'une espace en début de phrase n'entraînera pas sa coloration : Syntax highlighter ne sait détecter si cette espace en début de phrase est simplement un blanc au sein d'un modèle ou non ;
4. __NOTOC__ ainsi que les autres sélecteurs de comportements ne sont pas colorés.

Divers

1. La coloration syntaxique peut rencontrer des problèmes de performance sur de lourd articles, elle se désactive automatiquement si la durée de chargement dépasse 100 ms ;
2. La coloration syntaxique ne fonctionne pas lors du téléchargement de fichier ;
3. La coloration syntaxique peut remplacer vos styles personnels de la zone d'édition ;
4. Les couleurs peuvent être changées en cas de suggestion, les commentaires seront appréciés par l'auteur ;-)

Personnalisation

Il est facile de modifier les couleurs ou de ne pas mettre en évidence certaines syntaxes. Voir la liste des couleurs pour connaître les paramètres disponibles.

Liste des paramètres

Les paramètres suivants sont personnalisables :

defaultColor	pour les éléments qui n'ont pas de syntaxe particulière
boldOrItalicColor	'''gras''' ''italique''
wikilinkColor	[[wikilien]]
externalLinkColor	[http:// lien externe], http://lien-externe.com
headingColor	== Titre ==, ; définition
listOrIndentColor	* Liste à puce, # Liste à puce numérotée, : indentation
signatureColor	~~~~
tableColor	{| table |}
templateColor	{{modèle}}
parameterColor	{{{Paramètre de modèle}}}
hrColor	----
tagColor	<tag>...</tag>, <tag/>
commentColor	<!-- commentaire -->
entityColor	&entity;

Par exemple, pour faire apparaître les wikiliens en cyan et les liens externes en orange, vous pouvez ajouter dans le fichier https://fr.wikipedia.org/wiki/Special:MyPage/common.js (après avoir créé ce fichier s'il n'existe pas) les lignes ci-dessous. Toutefois, si Syntax highlighter est installé en tant que gadget, il est inutile de copier les deux premières lignes :

//syntax highlighter
mw.loader.load('//www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-DotsSyntaxHighlighter.js&action=raw&ctype=text/javascript');

syntaxHighlighterConfig = {
    externalLinkColor: "#FFCC66", //orange
    wikilinkColor: "#E6FFFF", //cyan
}

Pour ne pas mettre en évidence une syntaxe, marquez sa couleur comme "". Par exemple, pour désactiver le surlignage des textes en gras et en italique, vous pouvez utiliser :

//syntax highlighter
mw.loader.load('//www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-DotsSyntaxHighlighter.js&action=raw&ctype=text/javascript');

syntaxHighlighterConfig = {
     boldOrItalicColor: "",
}

Pour mettre évidence uniquement le type de syntaxe que vous souhaitez, mettez "" à defaultColor et indiquez seulement les syntaxes que vous souhaitez voir mises en évidence. Si vous souhaitez utiliser la couleur prédéfinie, indiquez "normal". Par exemple :

//syntax highlighter
mw.loader.load('//www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-DotsSyntaxHighlighter.js&action=raw&ctype=text/javascript');

syntaxHighlighterConfig = {
    defaultColor: "",
    tagColor: "normal",
}

Vous pouvez également définir un délai de chargement maximum (par défaut à 20 ms). Par exemple :

//syntax highlighter
mw.loader.load('//www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-DotsSyntaxHighlighter.js&action=raw&ctype=text/javascript');

syntaxHighlighterConfig = {
    timeout: 30,
}

Rapport de bugs

Note : vérifier au préalable si le bug n'est pas déjà répertorié dans #Problèmes connus.

Quand vous informez Remember the dot de bugs :

• Indiquer le plus de détails possible ;
• Indiquer les informations sur votre configuration ;
• Indiquer l'habillage que vous utilisez. (Vector, Monobook, ...)