Pour utiliser la coloration syntaxique dans les éditeurs wikitext, comme l’éditeur de source, pour rendre l’édition plus facile, voir l'extension CodeMirror ou les scripts utilisateurs de Remember the dot and Cacycle.

Manuel des extensions MediaWiki

SyntaxHighlight État de la version : stableCategory:Stable extensions/fr
Implémentation	Balise Category:Tag extensions/fr
Description	Permet de mettre en évidence la syntaxe du code source sur les pages wiki
Auteur(s)	Brooke Vibber, Tim Starling, Rob Church, Ori Livneh
Dernière version	mises à jour continues
Politique de compatibilité	Le master conserve la compatibilité arrière.
MediaWiki	1.25+Category:Extensions with manual MediaWiki version/fr
Modifie la base de données	Non
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: parcourir le dépôt (Phabricator · GitHub) relecture Gerrit du code historique Git des validations (commits) Télécharger le tarball source Category:Extensions in Wikimedia version control/fr README
Paramètres $wgPygmentizePath $wgSyntaxHighlightMaxLines $wgSyntaxHighlightMaxBytes
Balises ‎<syntaxhighlight>
Accroches utilisées ApiFormatHighlight Category:ApiFormatHighlight extensions/fr ContentAlterParserOutput Category:ContentAlterParserOutput extensions/fr ParserFirstCallInit Category:ParserFirstCallInit extensions/fr ResourceLoaderRegisterModules Category:ResourceLoaderRegisterModules extensions/fr SoftwareInfo Category:SoftwareInfo extensions/fr
Traduire l’extension SyntaxHighlight
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension SyntaxHighlight, anciennement connue sous le nom de SyntaxHighlight_GeSHi, fournit un formatage riche du code source à l'aide de la balise ‎<syntaxhighlight>. Il est alimenté par la bibliothèque Pygments et prend en charge des centaines de langages de programmation et de formats de fichiers différents.

Comme les balises ‎<pre> et <poem >, le texte est affiché exactement comme il a été tapé, en préservant tous les espaces.

L'extension SyntaxHighlight ne fonctionne pas sur les installation wiki hardened en utilisant Hardened-PHP du au manque de proc_open, shell_exec et d'autres fonctions. Voir T250763.

Le tag ‎<syntaxhighlight> est devenu très coûteux depuis la 1.39 pour 5,000 ou une autre quantité extrême de balises de surbrillance de syntaxe dans une seule page, comme pour Wikibooks. Augmenter la valeur de temps de délais du serveur Web dans des environnements dans des cas extrêmes. (Voir T316858).

Utilisation

Une fois installé, vous pouvez utiliser les balises "syntaxhighlight" sur les pages wiki. Par exemple,

def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

est le résultat de la balise de texte wiki suivante:

<syntaxhighlight lang="python" line>
def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

Pour utiliser un code source qui est transclus, par exemple pour un appel de module, utilisez le #tag du parser et le safesubst: :^[1]

{{#tag:syntaxhighlight|{{safesubst:Module:Sandbox/userName/myModule}}|lang=lua}}

Dans les versions plus anciennes (avant MediaWiki 1.16), l'extension utilisait la balise ‎<source>. Cette balise est toujours supportée, mais obsolète. ‎<syntaxhighlight> devrait être utilisé à la place.

Mise en forme

Si le code affiché est trop important, vous pouvez l'ajuster en mettant ce qui suit dans la page MediaWiki:Common.css dans votre wiki (créer la si elle n'existe pas) :

/* Le CSS placé ici sera appliqué à tous les skins */
.mw-highlight pre {
	font-size: 90%;
    /*  Ajouter du style CSS ici */
}

L'encapsulation de blocs de code dans des bordures peut être effectuée en insérant une ligne comme border: 1px dashed blue; dans la section ci-dessus Le contrôle sur la « famille de polices » utilisée peut également être exercé en insérant une ligne comme font-family: "Courier New", monospace; dans la section ci-dessus.

Catégorie d'erreurs de la mise en forme de la syntaxe

L'extension ajoute les pages qui ont un mauvais attribut lang dans une balise ‎<syntaxhighlight> à une catégorie de suivi. La clé de message MediaWiki:syntaxhighlight-error-category détermine le nom de la catégorie; sur ce wiki, c'est Category:Pages with syntax highlighting errors.

L'erreur la plus courante qui conduit à la marque de pages avec cette catégorie est une balise ‎<syntaxhighlight> sans attribut lang du tout, car les versions plus anciennes de cette extension prennent en charge la définition de $wgSyntaxHighlightDefaultLang . Ceux-ci peuvent généralement être remplacés soit par ‎<pre>, ou lang="text" peut être ajouté à la balise. Par exemple :

<syntaxhighlight lang="text">
...
</syntaxhighlight>

La catégorie peut également être ajoutée, et le contenu ne sera pas mis en évidence, s'il y a plus de 1000 lignes ou plus de 100 kB de texte.^[2]

Paramètres

def quick_sort(arr):
    less = []

<syntaxhighlight lang="python">
...
</syntaxhighlight>

def quick_sort(arr):
	less = []

<syntaxhighlight lang="python" line>
...
</syntaxhighlight>

def quick_sort(arr):
    less = []

<syntaxhighlight lang="python" line start="55">
...
</syntaxhighlight>

def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

<syntaxhighlight lang="python" line linelinks="example">
...
</syntaxhighlight>

[[#example-3|...]]
[[#example-2--example-4|...]]

def quick_sort(arr):
    less = []
    pivot_list = []
    more = []
    if len(arr) <= 1:
        return arr

<syntaxhighlight lang="python" line start="3" highlight="1,5-7">
...
</syntaxhighlight>

Le <syntaxhighlight lang="python" inline>lambda x: x * 2</syntaxhighlight> suivant est une [[w:Lambda (programming)|lambda expression]] en Python.

def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

<syntaxhighlight lang="python" style="border: 3px dashed blue;">
def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

def quick_sort(arr):
    less = []

<syntaxhighlight lang="python" copy>
def quick_sort(arr):
    less = []
</syntaxhighlight>

Langues prises en charge

En janvier 2020, la liste complète des langues prise en charge par Pygments est :

• ActionScript
• Ada
• Agda (y compris le litéral)
• Alloy
• AMPL
• ANTLR
• APL
• AppleScript
• Assemblage (divers)
• Asymptote
• Augeas
• AutoIt
• Awk
• BBC Basic
• Befunge
• BlitzBasic
• Boa
• Boo
• Boogie
• BrainFuck
• C, C++ (y compris les dialectes comme Arduino)
• C#
• Chapel
• Charm++ CI
• Cirru
• Clay
• Clean
• Clojure
• CoffeeScript
• ColdFusion
• Common Lisp
• Component Pascal
• Coq
• Croc (MiniD)
• Cryptol (y compris le cryptol littéral)
• Crystal
• Cypher
• Cython
• D
• Dart
• DCPU-16
• Delphi
• Dylan (y compris la console)
• Eiffel
• Elm
• Emacs Lisp
• Email
• Erlang (y compris les sessions shell)
• Ezhil
• Factor
• Fancy
• Fantom
• Fennel
• FloScript
• Forth
• Fortran
• FreeFEM++
• F#
• GAP
• Gherkin (Cucumber)
• GLSL shaders
• Golo
• Gosu
• Groovy
• Haskell (y compris le Haskell littéraire)
• HLSL
• HSpec
• Hy
• IDL
• Idris (y compris Idris littéraire)
• Igor Pro
• Io
• Jags
• Java
• JavaScript
• Jasmin
• Jcl
• Julia
• Kotlin
• Lasso (y compris les modèles)
• Limbo
• LiveScript
• Logtalk
• Logos
• Lua
• Mathematica
• Matlab
• Modelica
• Modula-2
• Monkey
• Monte
• MoonScript
• Mosel
• MuPad
• NASM
• Nemerle
• NesC
• NewLISP
• Nimrod
• Nit
• Notmuch
• NuSMV
• Objective-C
• Objective-J
• Octave
• OCaml
• Opa
• OpenCOBOL
• ParaSail
• Pawn
• PHP
• Perl 5
• Pike
• Pony
• PovRay
• PostScript
• PowerShell
• Praat
• Prolog
• Python (y compris les sessions de console et les trace-backs)
• QBasic
• Racket
• Raku a.k.a. Perl 6
• REBOL
• Red
• Redcode
• Rexx
• Ride
• Ruby (y compris les sessions irb)
• Rust
• S, S-Plus, R
• Scala
• Scdoc
• Scheme
• Scilab
• SGF
• Les scripts (Bash, Tcsh, Fish)
• Shen
• Silver
• Slash
• Slurm
• Smalltalk
• SNOBOL
• Snowball
• Solidity
• SourcePawn
• Stan
• Standard ML
• Stata
• Swift
• Swig
• SuperCollider
• Tcl
• Tera Term language
• TypeScript
• TypoScript
• USD
• Unicon
• Urbiscript
• Vala
• VBScript
• Verilog, SystemVerilog
• VHDL
• Visual Basic.NET
• Visual FoxPro
• Whiley
• Xtend
• XQuery
• Zeek
• Zephir
• Zig

Installation

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé SyntaxHighlight_GeSHi dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SyntaxHighlight_GeSHi
  

• Seulement lorsque vous installez à partir de Git, exécutez Composer pour installer les dépendances PHP, en entrant composer install --no-dev après vous être positionné dans le répertoire de l'extension. (Voir T173141 pour des complications potentielles.)Category:Extensions requiring Composer with git/fr
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'SyntaxHighlight_GeSHi' );
  

• Sous Linux, définir les autorisations d'exécution pour le binaire pygmentize. Vous pouvez utiliser un client FTP ou la commande shell suivante pour le faire:

chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize

• Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Installation Vagrant :

• Si vous utilisez Vagrant , installez avec vagrant roles enable syntaxhighlight --provision

{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/SyntaxHighlight_GeSHi/composer.json"
			]
		}
	}
}

Avertissement :

Lors du téléchargement de l'extension via FTP, assurez-vous de télécharger le fichier « pygments/pygmentize » avec le type de transfert « binaire ».

Utilisation avancée

• Contrairement aux balises ‎<pre> et ‎<code>, les entités de caractères HTML telles que   n'ont pas besoin (et ne devraient pas) avoir le caractère & échappé sous la forme &.
• Comme la balise ‎<pre> mais contrairement à la balise ‎<code>, les balises dans la plage (autres que sa propre balise de fermeture) n'ont pas besoin d'avoir le symbole < échappé comme <, et le wikitext n'a pas besoin d'être échappé avec une balise ‎<nowiki>.

• De plus, alors que ‎<pre> suppose des tabulations tous les 8 caractères et rend les tabulations en utilisant des espaces réels lorsque le texte rendu est copié, ‎<syntaxhighlight> utilise des tabulations à 4 espaces (sauf Internet Explorer, qui en utilise 8) et préserve les caractères de tabulation dans le texte rendu ; ce dernier peut être modifié en utilisant une balise $span englobante (pas $div, et sans utiliser son propre attribut $style).
  • Tab stop length for ‎<syntaxhighlight> may be adjusted using a ‎<span style=""> tag nested inside it that specifies the tab-size (its own style attribute cannot be used to specify the tab stops, and ‎<div> cannot be used instead): ‎<span style="-moz-tab-size: nn; -o-tab-size: nn; tab-size: nn;">
  • Le préfixe -moz- est nécessaire pour Firefox (de la version 4.0 à la version 90), et le préfixe de -o- est nécessaire pour Opera (de la versions 10.60 à la version 15).^[3]

(Notez que la boîte d'édition du wiki suppose des tabulations de 8 espaces. Ceci ne s'applique qu'aux pages enregistrées réelles; les prévisualisations générées par une boîte de rédaction ou Special:ExpandTemplates peuvent différer.)

Voir aussi

• Instructions on updating the pygments version used by SyntaxHighlight
• Pygments – Python syntax highlighter
• Extensions dépendantes de cette:
  • Extension:SyntaxHighlightPages – met en évidence les pages en fonction des suffixes de titre.
• Extensions alternatives:
  • Extension:Highlightjs Integration – un metteur en évidence de syntaxe qui utilise la bibliothèque HighlightJS (inclut la prise en charge de certaines langues manquantes dans les Pygments, comme Maxima).
  • Extension:GoogleCodePrettify – surligneur de syntaxe qui utilise la bibliothèque Google Code Prettify.
  • Extension:ExternalContent – intégrez du contenu externe, tel que du code provenant de GitHub, GitLab et des dépôts Bitkeeper avec rendu automatique des fichiers Markdown ; et utilisez la coloration syntaxique via la bibliothèque Prism.js pour près de 300 langues prises en charge. Contenu indexé par CirrusSearch

Notes de bas de page

Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki.

Cette extension est incluse dans les fermes de wikis ou les hôtes suivants et / ou les paquets : BlueSpice Category:Extensions included in BlueSpice/fr Canasta Category:Extensions included in Canasta/fr Debian Category:Extensions available as Debian packages/fr Fandom Category:Extensions included in Fandom/fr Miraheze Category:Extensions included in Miraheze/fr MyWikisCategory:Extensions included in MyWikis/fr ProWikiCategory:Extensions included in ProWiki/fr semantic::coreCategory:Extensions included in semantic::core/fr ShoutWiki Category:Extensions included in ShoutWiki/fr wiki.gg Category:Extensions included in wiki.gg/fr WikiForgeCategory:Extensions included in WikiForge/fr Cette liste ne fait pas autorité. Certaines fermes de wikis ou hôtes et / ou paquets peuvent contenir cette extension même s'ils ne sont pas listés ici. Vérifiez toujours cela avec votre ferme de wikis ou votre hôte ou votre paquet avant de confirmer.