Syntaxe PLUME

Lors de la rédaction d'une fiche ou d'un message, vous pouvez utiliser une syntaxe de rédaction rapide qui vous permettra de mettre en forme votre texte rapidement sans connaître le langage HTML.

Basée sur la syntaxe Markdown, en voici les principaux raccourcis/

Texte

Gras et italique

*lorem ipsum* donnera lorem ipsum
**lorem ipsum** donnera lorem ipsum

Listes

Listes à puces

* premier item
* second item
* troisième item

donnera :

  • premier item
  • second item
  • troisième item

Listes ordonnées

1. premier item
2. second item
3. troisième item

donnera :

  1. premier item
  2. second item
  3. troisième item

Attention : une ligne vide est requise avant le premier astérisque et un espace doit impérativement suivre l'astérisque. De même, une ligne vide est requise après le dernier item, sinon PLUME considèrera la ligne suivante comme faisant partie de la dernière puce.
NB: les astérisques peuvent être remplacés par des tirets ("-")

Titres

#Titre 1
##Titre 2
###Titre 3
####Titre 4

donnera :

Titre1

Titre 2

Titre 3

Titre 4

(oui, le titre 1 apparaît comme plus petit que le titre 2)...

Commandes

On utilise le caractère "`" (obtenu avec la combinaison de touches Alt Gr + 7)

Pour afficher le contenu d'un dossier, tapez `ls -al` puis validez avec `Enter`.

donnera :
Pour afficher le contenu d'un dossier, tapez ls -al puis validez avec Enter.
(notez les caractères en police de largeur fixe)

Bloc de code

On utilise <code> et </code> :
<code>
if (1==1) {
print "PLUME, c'est bien !";
}
</code>

donnera :

if (1==1) {
  print "PLUME, c'est bien !";
}

Le code HTML ne sera pas interprété au sein de ces balises.

Liens

Par défaut, les liens sont transformés automatiquement en liens cliquables : http://www.projet-plume.org/
Les URL de plus de 50 caractères seront automatiquement tronquées à l'affichage (tout en gardant la destination exacte).
Attention : si vous mettez le lien entre parenthèses, n'oubliez pas de mettre un espace avant et après : PLUME = ( http://www.projet-plume.org )

Tableaux

Function name  | Description
------------- | -------------
help()  | Display the help window.
destroy()  |  Destroy your computer!

donnera :

Function name
Description

help()
Display the help window.

destroy()
Destroy your computer!

Autres

Bonnes pratiques :

  • en règle générale, n'abusez pas des options de mise en forme ;
  • n'oubliez pas de mettre une ligne vide avant une liste à puces, ni de mettre un espace après l'astérisque ou le tiret ;
  • certaines balises HTML sont autorisées. Si vous les utilisez, pensez bien à rendre votre code compatible xHTML :
    <a href="http://www.projet-plume.org" title="voir le site PLUME">PLUME</a> (la balise titre est importante)