La manipulation du Structured Text

Le Structured Text est du texte qui utilise l'indentation et des symboles simples pour indiquer la structure d'un document.

Une chaîne de caractères structurée consiste en une suite de paragraphes séparés par une ou plusieurs lignes vides. Chaque paragraphe a un niveau qui est défini par l'indentation minimale du paragraphe. Un paragraphe est un sous-paragraphe d'un autre paragraphe si l'autre paragraphe est le dernier paragraphe qui le précéde et d'un niveau inférieur.

Des symboles spéciaux sont utilisés pour indiquer des constructions particulières :

  • Un paragraphe composé d'une seule ligne dont les paragraphes suivants sont de niveaux inférieurs 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 par une espace est traité comme un élément d'une liste ordonnée.

  • Un paragraphe qui commence par une suite de phrases, où chaque suite est une suite des chiffres ou une suite de lettres suivie par un point est traité comme un élément d'une liste ordonnée.

  • Un paragraphe dont la première ligne contient du texte, suivi par quelques espaces et -- est traité comme un élément d'une liste descriptive. Le texte de début de phrase est traité comme le titre de l'élement.

  • Les sous-paragraphes d'un paragraphe qui se termine avec les mots example, examples ou les caractères :: sont traités comme du code source d'exemple et affichés comme tel.

  • Du texte entre guillemets simples (avec espace à gauche du premier guillemet et espace ou ponctuation à droite du second guillemet) est traité comme du code source d'exemple.

  • Du texte entouré par les caractères * (avec espace à gauche du premier * et espace ou ponctuation à droite du second *) est écrit en italique.

  • Du texte entouré par les caractères ** (avec espace à gauche du premier ** et espace ou ponctuation à droite du second **) est écrit en gras.

  • Du texte entouré par les caractères _ (avec espace à gauche du premier _ et espace ou ponctuation à droite) est rendu souligné.

  • Du texte entre guillemets doubles suivi d'une virgule, d'une URL et enfin d'un signe de ponctuation et d'une espace, ou simplement d'une espace, est traité comme un hyperlien. Par example:

    Zope est ...

    est interprété comme 'Zope est ....'

    Note: Ceci fonctionne aussi bien pour les URLs relatives qu'absolues.

  • Du texte entre guillemets doubles, suivi d'une virgule, une ou plusieurs espaces, une URL absolue et se terminant par un signe de ponctuation et d'une espace, ou simplement d'une espace, est traité comme un hyperlien. Par example:

    "écrivez-moi", mailto:amos@digicool.com.

    est interprété comme 'écrivez-moi.'

  • Un paragraphe dont les blocs de texte sont entourés de || est traité comme un tableau. Les blocs de texte correspondent aux cellules du tableau et les rangées du tableau sont marquées par les retours à la ligne. Par défaut les cellules sont alignées au centre. On peut répandre une cellule sur plus d'un colonne en faisant précéder le bloc de texte avec un nombre équivalent de séparateurs ||. Il n'est pas possible de placer des retours à la ligne et des | à l'intérieur d'une cellule de texte. Par example:

    |||| **Ingrédients* || || Nom || Quantité* || ||Spam||10|| ||Eggs||3||

    est interprété comme: 

        <TABLE BORDER=1 CELLPADDING=2>
     <TR>
      <TD ALIGN=CENTER COLSPAN=2> <strong>Ingrédients</strong> </TD>
     </TR>
     <TR>
      <TD ALIGN=CENTER COLSPAN=1> <em>Nom</em> </TD>
      <TD ALIGN=CENTER COLSPAN=1> <em>Quantité</em> </TD>
     </TR>
     <TR>
      <TD ALIGN=CENTER COLSPAN=1>Spam</TD>
      <TD ALIGN=CENTER COLSPAN=1>10</TD>
     </TR>
     <TR>
      <TD ALIGN=CENTER COLSPAN=1>Eggs</TD>
      <TD ALIGN=CENTER COLSPAN=1>3</TD>
     </TR>
    </TABLE>