Créer un jeu de couleurs pour Gedit

Cette page indique comment créer un jeu de couleurs pour Gedit.

Lorsque vous écrivez un code source, vous avez plusieurs styles de texte : les variables, les types de fonction/variable… Gedit peut colorer ces styles de texte, pour le plus grand plaisir de nos yeux délicats. Un jeu de couleur prend la forme d'un fichier xml, attribuant des effets de texte à un style de texte déjà défini.

Un programme existe, badschemer, pour créer des jeux de couleurs de façon plus confortable. Il est aussi possible d'y aller à la main pour faire quelque chose de plus personnalisé, et c'est ce que nous allons voir.

Voici un exemple de contenu d'un jeu de couleurs vide :

<?xml version="1.0" encoding="UTF-8"?>
<style-scheme id="exemple" _name="Exemple" version="1.0">

  <author>Auteur</author>
  <_description>Mettez une description du thème (ce qu'il évoque, l'origine d'un tel thème...).</_description>

  <!-- On place ici les différentes informations sur le style -->

</style-scheme>

Quelques explications sur les balises utilisées :

<?xml version="1.0" encoding="UTF-8"?>

Cette ligne est la première ligne de quasiment tous les fichiers en xml. Elle indique qu'on utilise la version 1.0 du xml avec un encodage de caractères en utf-8.

<style-scheme id="exemple" _name="Exemple" version="1.0">

• id est un identifiant pour le jeu de couleurs, qu'il est conseillé de mettre en minuscule.
• _name est le nom du jeu de couleurs que Gedit affichera dans l'onglet Police et Couleurs, dans les Préférences.
• version est la version des styles de texte que vous utilisez. Pour l'instant on n'a qu'une seule version, la 1.0, donc autant la laisser telle quelle.

<author>Auteur</author>

• C'est assez clair, non ?

<_description>Mettez une description du jeu de couleurs (ce qu'il évoque, l'origine d'un tel thème...).</_description>

• Une courte description du jeu de couleurs que vous créez/modifiez est affichée dans l'onglet Police et Couleurs, dans les Préférences. C'est ici qu'il faut l'indiquer.

<!-- On place ici les différentes informations sur le style -->

• Le texte dans la balise est un commentaire, c'est-à-dire que vous pouvez écrire ce que vous voulez ici sans que cela ne soit pris en compte. Histoire de vous y retrouver dans ce que vous écrivez, usez-en !

Pour éviter de faire des fichiers deux fois plus lourds que nécessaire, n'en abusez pas non plus, sauf si vous débutez.

Toutes vos prochaines balises seront à placer entre </_description> et </style-scheme>.

Vous pouvez appliquer différents effets à du texte, notamment le colorer. Lorsque vous voulez afficher une couleur, vous pouvez seulement indiquer une valeur hexadécimale, par exemple :

foreground="#FFFFFF"

Mais il faudra alors rentrer manuellement chacune des couleurs. Et si vous comptez appliquer la même couleur à plusieurs styles ? Et si vous voulez changer d'un coup la couleur de ces mêmes styles ? Une méthode plus rapide, et aussi plus claire, est de donner des noms à des couleurs.

Par convention on met ces indications de couleur tout de suite après la balise </_description>.

Voici un exemple de couleurs que vous pouvez définir :

<color name="gris" value="#bbbbbb"/>
<color name="blanc" value="#eeeeee"/>
<color name="jaune" value="#fce94f"/>
<color name="kaki" value="#617200"/>

Ainsi vous définissez vos propres valeurs de gris, de blanc, et ainsi de suite. Si vous trouvez qu'une certaine valeur de jaune est mal appropriée par rapport aux autres couleurs, vous avez juste à la modifier Ça tombe bien, Gedit possède un greffon pour sélectionner une couleur et l'insérer dans le document. Voir la section des greffons de Gedit.

Si vous en utilisez, votre fichier de style ressemblera alors à ça :

<?xml version="1.0" encoding="UTF-8"?>
<style-scheme id="base" _name="Base" version="1.0">

  <author>Vous</author>
  <_description>Ceci est un fichier de base pour faire son thème.</_description>
  
  <!-- Aidez-vous de ce tutoriel pour faire votre propre style : 
  http://doc.ubuntu-fr.org/creer_un_jeu_de_couleurs_pour_gedit
  -->
  
  <!-- Couleur : facultatif -->
  <color name="" value="">
  <!-- name : le nom de la couleur à utiliser, value : la valeur hexadécimale (exemple #003366) --></style-scheme>

Voila le plus intéressant : les styles ! Certaines parties de votre code seront reconnues comme étant un style particulier. Comment ça peut se faire ? On ne le sait pas et on s'en moque : on veut juste formater ces bouts de texte. Un style se définit comme tel :

<style name="nomdustyle" parametre="valeur" autreparametre="autrevaleur"/>

Dans name on met le nom du style, et pour les paramètres on met les divers effets de texte à appliquer au style. Il existe beaucoup de styles, en fait on pourrait même en avoir à l'infini ! Pour ça on va d'abord regarder quels paramètres on peut appliquer aux styles, et nous pourrons ensuite les tester sur les styles.

Voici la liste des paramètres disponibles :

• bold : afficher du texte en gras.
• italic : afficher du texte en italique.
• underline : afficher du texte en souligné.
• strikethrough : barrer du texte.

Pour ces quatre paramètres, il faut donner une valeur booléenne : true pour afficher cet effet, false dans le cas contraire. Par définition, ces paramètres sont réglés sur false. Cependant, il se peut que deux styles se chevauchent, et qu'un texte s'affiche en gras alors que vous le voulez sans l'effet de gras quoi qu'il arrive. Dans ce cas-là, annoncez explicitement le paramètre en false.

• use-style : utiliser un style déjà défini. Voir plus bas la liste de style définissables.
• foreground : définir la couleur du texte du style.
• background : définir la couleur de fond du style.
• line-background : Si le texte du style que vous désignez occupe au moins le premier caractère d'une ligne, alors line-background colorera le fond de tout ce qui se trouve sur la ligne à droite du style en question. Dans ce cas, et si un autre style doit s'appliquer sur la ligne sur la droite, la propriété background prendra le dessus sur la line-background à cet endroit-là. Ce paramètre est difficile à bien placer, il peut être utilisé pour les commentaires par exemple ou pour le style bracket-match (voir plus bas).

Ces trois derniers paramètres demandent une couleur. Vous pouvez indiquer une valeur hexadécimale du genre : #000000 , ou bien un nom donné à une couleur (voir ci-dessus la balise couleur).

Souvenez-vous de cette fameuse ligne :

<style name="nomdustyle" parametre="valeur" autreparametre="autrevaleur"/>

Un style est défini au paramètre name. On sait quel(s) paramètre(s) mettre, maintenant c'est au tour des styles. Certaines options de Gedit ont besoin d'un style pour eux. La colonne affichant les numéros de ligne par exemple. Si vous ne l'avez pas activée, allez dans le menu Édition → Préférences → onglet Affichage. Cochez la case Afficher les numéros de ligne. Hop, une colonne apparait sur la gauche ! Et cette colonne, on peut la colorer différemment selon les envies. Ouvrez maintenant l'onglet Jeu de couleurs dans les Préférences, et faites varier les jeux de couleurs. Si cette colonne, disponible de base sous Gedit, a des jolies couleurs, c'est parce qu'elle a un style de base.

Voici la liste des styles de base :

• text : Pour le texte en général.
• selection : Pour le texte sélectioné (surligné avec le curseur)
• selection-unfocused : Imaginez que vous avez sélectionné un bout de texte sous Gedit. Tout à coup, vous voulez regarder vos mails, vous allez donc sur un autre programme que Gedit. Si vous regardez la fenêtre de Gedit (sans la sélectionner), grâce à ce style vous verrez votre sélection d'une autre couleur jusqu'à ce que vous reveniez sur Gedit.
• current-line : Gedit propose de mettre en valeur la ligne où se trouve le curseur (voir les Préférences). current-line définit les effets appliqués sur cette ligne.
• line-numbers : Gedit propose d'afficher une colonne indiquant les numéros de ligne comme expliqué juste au-dessus. line-number définit les effets appliqués à cette colonne. Les effets de texte tels bold ou underline ne fonctionnent pas.
• cursor : Définit les propriétés du curseur. Les effets de texte tels bold ou underline ne fonctionnent pas.
• secondary-cursor : Apparemment pour certaines langues, par exemple pendant qu'on écrit en chinois, une zone de préédition apparait en créant un deuxième curseur. Vous pouvez colorer ce second curseur avec le style secondary-cursor d'une couleur différente de cursor, les propriétés des deux styles étant les mêmes (donc bold ne fonctionne pas non plus).
• bracket-match : Gedit propose, lorsque vous avez un duo de parenthèse et que vous mettez votre curseur sur une des parenthèses, de mettre en valeur l'autre parenthèse. Regardez dans vos Préférences et faites le test : pour une parenthèse ouvrante choisie on peut voir la seconde différemment.
• bracket-mismatch : Cette fonctionnalité n'a pas encore été implanté dans Gedit. Le principe étant de montrer les erreurs de parenthésage, par exemple (] où le crochet prend la place d'une parenthèse fermée.
• search-match : Lors d'une recherche, plusieurs termes sont colorées : un qui est sélectionné, les autres qui ne le sont pas. search-match vous permet d'appliquer des effets sur ces termes.

Détail important : pour tester votre jeu de couleurs, il faut le (ré)importer dans Gedit. Allez dans Édition → Préférences → onglet Police et Couleurs, et faites Ajouter en choisissant votre petit fichier xml. Si le jeu de couleurs était déjà en marche dans Gedit, choisissez un autre style et revenez au style que vous élaborez.

Maintenant que vous savez ça, vous pouvez tester ces premiers styles de base pour vous mettre à l'aide avec tout ce que nous avons vu. Voici à quoi pourrait ressemble votre jeu de couleurs à ce stade :

<?xml version="1.0" encoding="UTF-8"?>
<style-scheme id="base" _name="Base" version="1.0">

  <author>Zarmakuizz</author>
  <_description>Ceci est un fichier de base pour faire son thème.</_description>
  
  <!-- Aidez-vous de ce tutoriel pour faire votre propre style : 
  http://doc.ubuntu-fr.org/creer_un_jeu_de_couleurs_pour_gedit
  -->
  
  <!-- Couleur : facultatif -->
  <color name="" value="">
  <!-- name : le nom de la couleur à utiliser, value : la valeur hexadécimale (exemple #003366) -->
  
  <!-- Plusieurs styles sont listés, ajoutez après le name les paramètres que vous voulez, par exemple pour mettre en gras mettez : bold="true" -->
  <!-- Styles de base -->
  <style name="text"/>
  <style name="selection"/>
  <style name="selection-unfocused"/>
  <style name="current-line"/>
  <style name="line-numbers"/>
  <style name="cursor"/>
  <style name="bracket-match"/>
  <style name="search-match"/>
</style-scheme>

Sauf que vous, vous avez mis des paramètres j'espère.

Bon, c'est bien beau mais Gedit est fait pour programmer. Il doit bien y avoir quelques styles secrets !

Gedit est un éditeur de texte avant tout destiné à programmer, de ce fait il peut formater du code, et ça passe aussi par les styles. Les styles que vous allez utiliser ont été créés, nommés, détaillés dans des fichiers bien spéciaux appelés "définitions de langage". Ces fichiers sont localisés normalement dans le dossier : /usr/share/gtksourceview-2.0/language-specs/ , sinon entrez :

find / -name def.lang

Ce dossier contient des définitions de langage pour de nombreux langages, vous devez sûrement voir dans le dossier de nombreux fichiers .lang. Tous ces langages font appel à des styles qui ont été définis dans le fichier def.lang de ce dossier, ce qui en fait le fichier le plus important d'entre tous les autres. Ensuite, chaque langage définit ses propres styles en indiquant à quelle partie du texte appliquer quel style de def.lang. Ce qui veut dire que vous pouvez définir des styles pour chacun des langages en y allant au cas-par-cas. Mais comme c'est long et lourd, il vaut mieux définir des styles par défaut, et indiquer des styles bonus après ça. Pour utiliser le style d'un langage, il faut indiquer son style et son fichier. Un style par défaut est défini comme ceci :

<style name="def:style" parametre="valeur" autreparametre="autrevaleur"/>

Parce que les styles par défaut sont dans le fichier def.lang Mais si vous voulez définir un style pour le C uniquement, il faut d'abord voir quels styles sont définis dans le fichier c.lang : ouvrez-le et cherchez les lignes du genre :

<styles>
        <style id="comment"           _name="Comment"             map-to="def:comment"/>
        <style id="printf"            _name="printf Conversion"   map-to="def:special-char"/>
        ...
</styles>

Les noms des styles sont dans le paramètre id: si vous voulez formater le style comment (voir plus bas), il vous faudra l'appeler ainsi :

<style name="c:comment" parametre="valeur" autreparametre="autrevaleur"/>

Le paramètre _name indique un nom plus complet pour le style. Le paramètre map-to dit quel style appeler pour le formatage si aucun style n'a été précisé. Si vous ne précisez pas de style pour comment, on ira prendre le style comment par défaut. Autre information, l'organisation des styles pourrait changer lors du passage à la version 3 de Gedit. Ce qui n'est pas pour tout de suite

Bien, passons à ces styles par défaut. Vous trouverez ci-dessous tous les noms des styles, tous précédés du préfixe def: , comme ça ceux qui lisent la doc un peu vite peuvent tout de suite copier/coller les noms des styles Certains styles, s'ils ne sont pas définis, adoptent les mêmes propriétés qu'un autre style. On peut former ainsi des "familles de styles" qui sont ici représentées par des décalages sur la droite. À titre d'exemple, si le style def:shebang n'est pas défini, comme on peut dire que def:shebang est le "style fils" de def:comment, alors le style def:shebang sera identique à def:comment. Si par contre def:comment n'est pas défini, n'ayant pas de "style parent" alors def:comment s'affichera comme du texte.

• def:comment : Pour désigner les commentaires .
  • def:shebang : Dans les fichiers de shell, on indique le shell à utiliser en début de fichier avec un shebang, par exemple : #!/bin/bash .
  • def:doc-comment : Pour les commentaires contenant du texte destiné à la documentation du programme, la documentation en question sera générée à la compilation.
  • def:doc-comment-element : Utilisé pour les textes du style doc-comment, permet de mettre en valeur certains éléments comme @author.

• def:special-char : Pour désigner des "caractères spéciaux" : par exemple en C, on peut utiliser des caractères comme %s ou \n.
• def:constant : Pour désigner des valeurs constantes. Lorsque vous écrivez "variable=123", 123 est une valeur qui ne changera jamais. variable par contre, elle, variera (c'est le but aussi ). Les styles qui suivent correspondent à différentes catégories de constantes :
  • def:character : Lorsque vous saisissez un caractère, par exemple 'c' que vous voulez stocker dans une variable de type char
  • def:string : Pour les chaines de caractère cette fois.
  • def:number : Pour les valeurs de nombre.
    • def:floating-point : Pour les valeurs flottantes, par exemple 2.3e10 .
    • def:decimal : Pour des valeurs décimales classiques, comme 1234.
    • def:base-n-integer : Pour des nombres de base-N. Par exemple la valeur hexadécimale d'une couleur comme vous allez en utiliser pour faire un jeu de couleurs : #00abd3.
    • def:complex : Pour des nombres complexes.
  • def:special-constant : Pour des constantes spéciales, par exemple en C la constante NULL.
    • def:boolean : pour les valeurs booléennes, true et false.

• def:identifier : pour des identifiants de variable.
  • def:function : pour les identifiants de fonction.
  • def:builtin : Pour les identifiants de fonction de type Built-in, par exemple abs en Python.

• def:statement : Le terme général pour désigner les deux styles qui suivent.
  • def:operator : Pour désigner les opérateurs : +, *, etc.
  • def:keyword : pour les mots-clés comme if, else, switch, etc.

• def:type : Pour les types de données : int, double, char…

• def:preprocessor : Pour les directives de préprocesseur. Certains langages indiquent au compilateur les librairies à importer, ces lignes situées au début du fichier sont appelées directives de préprocesseurs. Plus d'information sur Wikipédia
• def:error : Pour des erreurs d'écriture.
  • def:reserved : Certains mots sont "réservés", par exemple en Java : const, goto…
• def:note : Des notes destinées au programmeur, par exemple TODO…
• def:underlined : Tout ce qui doit être souligné, par exemple en HTML les liens, ou les adresses mail. Si vous voulez un peu de folklore, vous pouvez décider que ces textes soient affichés en italique, mais pensez un peu aux autres, par pitié appliquez seulement un soulignement à ce style si vous le définissez.

Petit rappel de comment définir un de ces styles :

<style name="def:comment" parametre="valeur" autreparametre="autrevaleur"/>

Votre fichier doit être plein de belles lignes :

<?xml version="1.0" encoding="UTF-8"?>
<style-scheme id="base" _name="Base" version="1.0">

  <author>Zarmakuizz</author>
  <_description>Ceci est un fichier de base pour faire son thème.</_description>
  
  <!-- Aidez-vous de ce tutoriel pour faire votre propre style : 
  http://doc.ubuntu-fr.org/creer_un_jeu_de_couleurs_pour_gedit
  -->
  
  <!-- Couleur : facultatif -->
  <color name="" value="">
  <!-- name : le nom de la couleur à utiliser, value : la valeur hexadécimale (exemple #003366) -->
  
  <!-- Plusieurs styles sont listés, ajoutez après le name les paramètres que vous voulez, par exemple pour mettre en gras mettez : bold="true" -->
  <!-- Styles de base -->
  <style name="text"/>
  <style name="selection"/>
  <style name="selection-unfocused"/>
  <style name="current-line"/>
  <style name="line-numbers"/>
  <style name="cursor"/>
  <style name="bracket-match"/>
  <style name="search-match"/>

  <!-- Les commentaires -->
  <style name="def:comment"/>
  <style name="def:shebang"/>

  <!-- Les constantes -->
  <style name="def:special-char"/>
  <style name="def:constant" />
  <style name="def:character" />
  <style name="def:string"/>
  <style name="def:number" />
  <style name="def:special-constant"/>
  
  <!-- Les identifiants-->
  <style name="def:identifier"/> 
  <style name="def:function"/>
  <!-- Les états -->
  <style name="def:statement"/>

  <!-- Les types -->
  <style name="def:type"/> 

  <!-- Autres -->
  <style name="def:preprocessor"/>
  <style name="def:error"/>

</style-scheme>

Ici vous avez juste à mettre tous les paramètres que vous voulez. Je n'ai pas mis tous les styles possibles, c'est à vous de voir ce que vous voulez de coloré

Sur cette page on a vu comment formater le texte. En partie. Peut-être aimeriez-vous colorer certaines parties de texte qui n'ont pas encore de style ? Il faudra alors créer le style. Et pour créer le style, ça se fait directement dans les fichiers de définition de langage vus plus haut. Il n'y a pas encore de page française pour expliquer comment créer ou modifier des définitions de langage. Vous trouverez plus bas des liens vers une documentation et un tutoriel, en anglais.

Si vous cherchez des indications supplémentaires sur la coloration du texte ou si ce tuto vous semble flou, n'oubliez pas de contacter le(s) contributeur(s).

Vous avez fait un nouveau langage ? Vous voulez faire vous même un fichier de style ? Nous allons voir ensemble comment faire ça en prenant comme exemple un fichier .lang de coloration syntaxique pour le langage bbcode (celui qu'on utilise dans les forums). Avant tout il faut voir un peu à quoi ressemble ce bbcode, sa syntaxe.

Voilà un petit aperçu de bbcode

[code]
#une suite de commandes
commande a b c fichier
commande2 etc.
[/code]
[quote=ubuntu-fr] Hello world[/quote]

J'ai décidé les "conventions" suivantes:

Les mots clés des balises seront différents soit la liste suivante ([code][/code], [quote][/quote], [url][/url] etc).

Quand on peut rajouter une valeur, comme dans [quote=doc ubuntu], la valeur doit être colorié.

le bbcode n'a pas de caractère pour les commentaires, donc je choisi le #

Pour commencer il va falloir créer un fichier bbcode.lang . Vous devrez placer ce fichier dans le dossier /usr/share/gtksourceview-2.0/language-specs/

La première ligne que tout document XML se doit d'avoir

<?xml version="1.0" encoding="UTF-8"?>

• Documentation pour créer un fichier lang (en)
• Un tutoriel pour créer un fichier lang (en)

Contributeurs : Zarmakuizz.