Textile ou Markdown ?
Une bonne lisibilité contribue à améliorer la perception. Le formatage riche est très important pour les logiciels de suivi des problèmes car il nous permet de mettre en évidence des éléments plus importants, en attirant ainsi une attention particulière sur eux. Dans Redmine, la mise en forme enrichie peut être obtenue à l'aide d'un langage de balisage léger (Textile ou Markdown) et est prise en charge dans presque toutes les zones de texte. Ces deux langages de balisage utilisent une syntaxe de formatage en texte brut.
Textile est utilisé par Redmine comme format par défaut et le seul formateur disponible depuis de nombreuses années. Il est grandement soutenu et parfaitement testé. Tout utilisateur expérimenté de Redmine est familier avec Textile et de nombreux plugiciels Redmine étendent sa syntaxe. C'est notamment pour ces raisons que la majorité des installations de Redmine, y compris le site officiel Redmine.org, utilisent ce formateur. Ainsi, la plupart des utilisateurs de Redmine utilisent définitivement Textile.
Cependant, Textile est utilisé par aucune autre application à l'exception de Redmine. Au contraire, Markdown est plus la norme de facto pour le formatage riche basé sur du texte brut. Ainsi, il est utilisé par GitHub et Stack Overflow. On peut dire que la plupart des développeurs utilisant un langage de balisage utilisent Markdown.
Cela signifie que pour une nouvelle installation, si votre public cible ne s'est pas encore habitué à Textile, vous devriez probablement sélectionner Markdown. De plus, Redmine n'est livré avec aucun convertisseur de Textile à Markdown. Ainsi, si vous choisissez Textile pour votre nouvelle installation, vous y serez probablement lié pour toujours. Par contre, la version 3.1 est en fait la première version de Redmine pour laquelle le formateur Markdown n'est plus considéré comme expérimental (il a été ajouté en 2.5). Cela signifie que ce formateur est fiable. Une autre raison possible de conserver Textile comme formateur est que de nombreux utilisateurs Redmine existants, si l'un d'eux va utiliser votre installation, s'attendront probablement à ce que Textile soit utilisé. Donc, généralement, vous feriez mieux de demander à vos utilisateurs.
Mais ne soyons pas trop verbeux et comparons les règles de base de ces formateurs :
Textile | Markdown | |
---|---|---|
Texte en gras | *Bold* | **Bold** |
Texte en italique | _Italic_ | *Italic* |
Texte souligné | +Underline+ | Non disponible |
Code en ligne | @inline code@ | `inline code` |
Texte pré-formaté | <pre> ... <pre> |
~~~ ... ~~~ |
Mise en évidence de la syntaxe | <pre><code class="ruby"> ... </code></pre> |
~~~ ruby ... ~~~ |
Liste à puces | * Item 1 * Item 2 |
* Item 1 * Item 2 |
Liste numérotée | # Item 1 # Item 2 |
1. Item 1 2. Item 2 |
Entête | h1. Heading 1 h2. Heading 2 ... h6. Heading 6 |
# Heading 1 ## Heading 2 ... ###### Heading 6 |
Liaison | "Anchor":http://link | [Anchor](http://link) |
Images | !image_url(Title)! | ![Title](image_url) |
Tables | |_.Table|_.Heading| |Cell |Cell | |
|Table|Heading| |-----|-------| |Cell |Cell | |