Les titres

Le principe est de souligner, les titres avec différents caractères selon leur niveau, on peut également souligner et surligner en même temps pour mettre en valeur le titre principal d’un document. Le soulignage doit être au moins aussi long que le titre lui même. Le choix des symboles pour cela est assez libre, choisis entre principalement "= - ` : ' " ~ ^ _ * + # < >", Comme je pense que trois niveaux de titre est largement suffisant (ce qui est utilisé dans ce billet par exemple), l’utilisation par exemple pour les titres pourrait être :

Ce qui donnerais une sorti équivalente à :

On remarque que le niveau 1 correpond à une balise de type <h2>, mais c’est parce que j’ai explicitement demandé dans le fichier de configuration cela, sinon le lvl1 correpondrait bien à une balise <h1>. Il est possible d’obtenir une hiérarchisation numéroté automatiquement, également grâce au fichier de configuration.

Les liens hypertextes

Il y a plusieurs façon de créer un lien externe, et c’est ce que j’aime bien de ne pas être cloîtré sur une seul solution, deux principales possibilités que j’ai retenu, l’une tout en ligne, l’autre séparé de son context

• Lien en une ligne, consiste à écrire d’une traite le lien et l’ancre en même temps. La syntaxe est simple :

• L’autre possibilité, qui peut parraître redondent et déroutant au premier abord, mais c’est pourtant une façon intéressante de séparer complètement les liens du contenu, gagnant ainsi une meilleur lisibilité. Les liens peuvent être regroupé en fin de texte ou même après un paragraphe par exemple.

Les marquages de texte

On peut obtenir du texte en italique, gras ou autre simplement, un exemple rapide ici, pour avoir une liste plus complète, s’en référer à la documentation cité plus haut.

**C'est** `*`tout simple`*` *à utiliser*. aura pour rendu : C’est tout simple à utiliser.

Les bloques de code

Cette fonctionnalité est importante pour moi, écrivant régulièrement des billets comportant du code, avec de la coloration syntaxique, le tout basé sur le plugin wp-syntax. Cependant, cela implique quelques impératif qui demande un peu plus d’attention :

• Le balisage utilisé est de la forme <pre lang="xxx">. De plus un simple <pre> n’est pas reconnu par le plugin, n’ajoutant pas les div de wp-syntax du coup, utile pour la css et uniformiser le style ;
• Les caractères échappé ne sont pas retranscrit à l’intérieur de ces balises, et là, tout le monde verra de quoi je parle, on s’est tous retrouvé avec des ‘&lt;‘ ou ‘&gt;‘ au beau milieu d’un code, alors qu’on souhaitait avoir ‘<‘ ou ‘>‘. Donnant ainsi de belle erreurs à la compilation pour personnes qui en auront fait un copier coller ;
• L’indentation doit être respecter pour le code, il serait risible d’avoir un blog publiant un code non-indenté.

Je n’ai pas trouvé LA solution parfaite, qui d’une commande, d’une config’ ou d’une macro répondrait parfaitement à ma demande. Il y a cependant bien des moyens pour parvenir à ses fins, bien que les besoins peuvent varier d’une personne à l’autre, et même d’un billet à l’autre. Je note ici les quelques solutions qui me semble aller vers le sens qu’on souhaite, sois directement grâce aux moyens fournis par reStructuredTet, soit à base de quelques sed pouvant être facilement rajouté à la commande ou à insérer dans un Makefile

L’insertion d’un bloc est facilement fait avec ::, pouvant s’employer de deux façon, il donnera des balises <pre>, le seul soucis c’est qu’ils associent une classe avec la balise, et ne contient pas le lang="xxx=" que l’on souhaite, mais on s’en arrangera avec un sed après.

L’autre possibilité est un raccourci lorsqu’on fini son paragraphe par ‘:’ et on se retrouve souvent quand on parle du code , comme le présent exemple

Il faut noter que la ligne vide après les ‘::’ n’est pas facultative, la sortie ne serait plus la même sinon. La sortie est de la forme <pre class="literal-block"> ... </pre> mais la commande suivant redonnera le schéma souhaité, en remplaçant text avec le langage souhaité :

L’avantage de cette méthode, c’est rapide et simple, tout est respecté, sauf… les caractères d’échappement, comme &gt;, mais on peut également remettre ça en place avec un autre sed :

Mais je ne suis pas forcément fan de cette solution, qui commence à être un peu lourde je trouve, si j’ai des caractères à échappé, c’est je pense plus simple d’utiliser ce qui suis. L’autre solution, plus « radicale » consiste à passer par la commande raw, tout ce qui suis la commande est retranscrit tel quel dans le fichier de sortie, l’avantage c’est de ne pas avoir de sed à rajouter après, mais par contre, il faut écrire les balises soi-même, encore une fois, ça dépend des usages qu’on en a. Pour mettre ça en place, voici un exemple :

Liste à puces et images

Les listes à puces sont on ne peut plus simple à réaliser, il suffit d’utiliser * en début de ligne, et les différent niveau de liste impliqué sont obtenu avec les différentes indentations des puces. Rapide exemple quand même

Les images ne sont pas bien plus compliqué, alors je n’ai pas vraiment essayé car j’utilise peu d’image sur mon blog, et je me préoccupe plus à présenté correctement les blocs de code :þ

On peut insérer l’image simplement, ou avec des arguments en plus

Les pièges à éviter

Je n’ai pas trop mis l’accent dessus dans le billet, mais les indentations, ou les lignes vides ont leur importance, il est rapide au début de se faire avoir par une syntaxe pas tout à fait respecter

Pour l’indentation, et lorsqu’on colle tout un code par exemple, il se peut retrouve mal indenté d’un niveau, la petite astuce avec vim pour indenter un bloc entier d’un niveau, il suffit de le surligner en mode visuel, puis de taper > pour indenter d’un cran tout le bloc, et inversement avec <. Ça peut être pratique.