Documentation des filtres

Soumis par anarcat le dimanche, 8 février, 2004 - 19:54
L'Insomniaque

Plusieurs raccourcis existent dans L'Insomniaque vous permettant de séparer logiquement votre texte, de rajouter du style ou faire des liens vers d'autres documents. Ceci est accompli avec un ensemble de filtre qui sont appliqués sur le texte soumis.

Note: Les notions avancées sont indiquées par des astérisques (*).

Filtres de structure

Paragraphes

Les paragraphes du texte doivent être séparés par 2 fins de lignes (i.e. des retours de chariots). Pour faire simplement une nouvelle ligne (<br />), on peut utiliser le raccourci %%%. Exemple:

Cette ligne est brisée %%% en deux par 3 pourcentages.

Donne:

Cette ligne est brisée
en deux par 3 pourcentages.

Titres

Un ou plusieurs points d'exclamations en début de ligne marquent un titre. Le nombre de points d'exclamations marque le niveau du titre. Ainsi:

! Titre de niveau 1

!! Titre de niveau 2

!!! Titre de niveau 3

donne:

Titre de niveau 1

Titre de niveau 2
Titre de niveau 3
Listes

Les filtres de L'Insomniaque sont capables de reconnaître des structures de liste simples. Les éléments des listes non-numérotées doivent être précédés d'un astérisque et d'un espace (* ), comme suit:

* item
* item
* item

donne la liste:

  • item
  • item
  • item

Les filtres reconnaissent également les listes numérotées. Il suffit de précéder chaque ligne par signe "#" suivi d'un espace. Exemple:

# item 1
# item 2
# item 3

donne:

  1. item 1
  2. item 2
  3. item 3

Notez que chaque item de la liste doit être sur une seule ligne, sinon le filtre risque de devenir confus.

Notes de bas de page

Les filtres supportent également les notes de bas de page. Les notes sont automatiquement numérotées. Pour marquer du texte comme faisant partie d'une note, il suffit de l'entourer de deux accolades. La référence de la note apparaît à l'endroit où les accolades ont été placées et la note est placée en bas de page. Par exemple:

Si je veux placer une note ici, je fais{{ceci est une note}} et je continue mon texte.

ce qui donne:

Si je veux placer une note ici, je fais[1] et je continue mon texte.

Citations

Pour faire une citation en bloc, on met un la chaîne ";:" devant chaque ligne et le contenu est rendu en italique, avec un retrait à gauche et à droite. Exemple:

;: Modern man has a kind of poverty of the spirit which stands
;: in great contrast to his remarkable scientific and technological
;: achievements. We've learned to walk in outer space and yet we
;: haven't learned to walk to earth as brothers and sisters. -- Dr. Martin Luther King, Jr.

donne:

Modern man has a kind of poverty of the spirit which stands in great contrast to his remarkable scientific and technological achievements. We've learned to walk in outer space and yet we haven't learned to walk to earth as brothers and sisters. -- Dr. Martin Luther King, Jr.

Texte préformatté (*)

Parfois, il est peut être embêtant d'utiliser le raccourci %%% pour séparer toutes les lignes d'un paragraphe. On indente alors le texte avec des espaces. Le texte sera aussi rendu en une fonte de taille fixe, pour permettre l'art ASCII. Exemple:

  owl-1   10/96
         ,___,       
         (9v9)      
         (_^((\     
    jgs^^^"^" \\^^^^
       ^^^^^^^^^^^^^

Filtres de style

Emphase et accents

On peut mettre de l'accent sur certains termes en entourant ces ces termes d'astérisques (*). Pour mettre de l'/emphase/ sur du texte, on peut utiliser la barre oblique (\/) ou le caractère souligné (_). Les marqueurs entrants doivent être précédés d'un espace et les marqueurs fermants doivent en être suivis. Exemple: \/emphase\/, _emphase_ et *accent* nous donnent: /emphase/, emphase et accent.

Noter que si on oublie de mettre des espaces ou de la ponctuation autour des raccourcis, ils ne fonctionne pas. Exemple: il n'yapas d'espaces dans le rac/cour/ci, alors ça ne marche pas.

Note: il est pour l'instant impossible de mettre l'accent ou de l'emphase sur du texte situé en début ou fin de texte. Pour éviter ce problème, rajouter un espace avant ou après l'accent ou l'emphase, ou encore faire suivre le style de ponctuation.

Liens

Les crochets ([ et ]) sont utilisés pour créer des hyperliens. On utilise donc deux crochets ouvrants et deux fermants pour marquer du texte à mettre en hyperlien. On distingue 5 méthodes pour marquer les liens:

  1. [[http://insomniaque.org/|Insomniaque.org]] donne Insomniaque.org
  2. [[http://insomniaque.org/]] donne http://insomniaque.org/
  3. [[texte]] est une variante du précédent. Il procède à faire un recherche pour un article sur L'Insomniaque nommé "texte". S'il n'est pas trouvé, le résultat est le même qu'en 2. Résultat: [[Orientations politiques]] donne Orientations politiques.
  4. [[111|lien vers un autre article]] donne lien vers un autre article.Le numéro (ici, le 111) est l'index unique attribué à chaque document du journal. Par exemple, l'adresse de cette page est http://insomniaque.org/node/view/521, donc cette page porte le numéro 521.
  5. [[X]] (où X est un chiffre) est similaire à 4, mais le filtre va automatiquement mettre le titre de l'article numéro X comme texte du lien. Exemple: [[111]] donne Orientations politiques.
Échappement des filtres (*)

Il peut arriver que l'on ait besoin de mettres des caractères qui soient /a priori/ interprétés par les filtres, mais que ce ne soit pas désiré. Il faut alors s'échapper des filtres. Pour ce faire, on utilise la syntaxes des entités HTML. Voici donc la liste des caractères spéciaux des filtres et du HTML ainsi que leur échappement HTML, pour plus de facilité.

  • & devient &amp;
  • < devient &lt; (utile pour présenter du code HTML sans qu'il soit interprété)
  • > devient &gt; (idem)
  • sauts de ligne: les % deviennent &#37;
  • titres: les ! deviennent &#33;
  • blockquote: les ; deviennent &#59;
  • listes et accent: les * deviennent &#42;
  • listes numérotées: les # deviennent &#35;
  • notes: {{texte}} devient &#123;&#123;texte&#125;&#125;
  • liens: les [[lien]] deviennent &#91;&#91;lien&#93;&#93;
  • emphase: les / deviennent &#47; et les _ deviennent &#95;

Et c'est tout!

--
[1] ceci est une note