Un texte structuré est un texte qui utilise des indentations et des symboles simples pour indiquer la structure d'un document. Pour la prochaine génération de texte structuré, jettez un oeil sur ReStructuredText et ici.

Un texte structuré est une séquence de paragraphes séparés par une ou plusieurs lignes blanches. Chaque paragraphe possède un niveau défini par la plus petite idententation du paragraphe. Un paragraphe est sous-paragraphe d'un autre si ce dernier est le dernier paragraphe le précédant qui a un niveau inférieur.

Des symboles spéciaux sont utilisés pour indiquer certaines constructions :

• Un paragraphe d'une seule ligne dont les paragraphes qui suivent sont d'un niveau inférieur est traité comme un titre.

• Un paragraphe qui commence par '-', '*' ou 'o' est traité comme un élément d'une liste non ordonnée.

• Un paragraphe qui commence par une suite de chiffres suivie d'un caractère traité comme un espace est vu comme un élément d'une liste ordonnée.

• Un paragraphe qui commence par une séquence de séquences où chaque séquence est une séquence de chiffres ou une séquence de lettres suivie d'un point est également traité comme un élément d'une liste ordonnée.

• Un paragraphe dont la première ligne contient du texte, suivi par un caractère blanc et '--' est traité comme élément d'une liste descriptive. Le texte en tête est traité comme le titre de l'élément.

• Un sous-paragraphe d'un paragraphe qui se termine par le mot 'example' ou 'examples' ou encore '::' est traité comme un exemple de codes et est affiché tel quel.

• Du texte enfermé entre deux apostrophes (avec un espace à gauche et un espace ou une ponctuation à droite) est traité comme un exemple de code.

• Du texte entouré de deux étoiles (avec un espace à gauche et un espace ou une ponctuation à droite) est mis en valeur.

• Du texte entouré de deux '**' (avec un espace à gauche et un espace ou une ponctuation à droite) est mis en gras.

• Du texte entouré de deux '_'(avec un espace à gauche et un espace ou une ponctuation à droite) est souligné.

• Du texte enfermé entre deux guillemets, suivi d'une virgule, d'une URL et terminé par un signe de ponctuation ou un espace, ou simplement un espace, est traité comme un lien. Par exemple :

  • "Zope": http://www.zope.org/ est ...

  est interprété comme '<a href=" http://www.zope.org/">Zope</a> est ....'

  Note: Cela fonctionne également avec les liens relatifs.

• Du texte enfermé entre deux guillemets suivi d'une virgule, d'un ou plusieurs espaces, une URL absolue et terminé par une ponctuation et des espaces ou simplement un espace est traité comme un lien. Par exemple :

  • "mail me", mailto:amos@digicool.com.

  est interprété comme '<a href=" mailto:amos@digicool.com">mail me</a>.'

• Du texte enfermé entre deux crochets qui est composé uniquement de lettres, de chiffres, du caractère souligné et du tiirer est traité comme un lien dans le document. Par exemple :

  • Comme montré par Smith [12] cette technique est efficace.

  est interprété comme '... par Smith <a href="#12">[12]</a> cette ...'. En combinant cette règle avec la suivante, on peut facilement créer des références.

• Du texte enfermé entre deux crochets précédé par un début de ligne, deux points et un espace est traité comme un lien nommé. Par exemple :

  • .. [12] "Effective Techniques" Smith, Joe ...

  est interprété comme '<a name="12">[12]</a> "Effective Techniques" ...'.

• Un paragraphe dont les blocs de textes sont enfermés entre deux '||' est traité comme une table. Les blocs de textes sont les cellules de la table et les colonnes sont représentées par une nouvelle ligne. Par défaut, les cellules sont alignées. Une cellule peut prendre plusieurs colonnes en faisant précéder le bloc de textes d'autant de séparateurs de colonnes que l'on veut étendre la cellule. Le caractère '|' et les sauts de lignes ne peuvent pas faire partie d'une cellule. Par exemple :

  • |||| **Ingrédients** ||
    || *Nom* || *Quantité* ||
    ||Jambon||10||
    ||Oeufs||3||
    

  donne ceci :

  • **Ingrédients**
    *Nom*	*Quantité*
    Jambon	10
    Oeufs	3