rw-rw-r-- to auteur

How do you wiki?

Article écrit par Arnaud, complété et wikisé par to_.

1 Introduction

Voici un exemple d'article pour le Wiki, je donne ici toutes les balises qui vous seront utiles lors de l'écriture d'article sur le Wiki..

2 Haut du document

On commence par mettre le « Pager » qui va permettre la navigation entre les différents articles de la rubrique :

<plugin Pager>

On met le titre qui est le « Nom » de l'article donné dans le formulaire. 

+ %TITLE%

Notez également qu'on crée une rubrique en mettant le symbole « + » (rub1), « ++ » pour une sous rubrique (rub2), et pour une sous rubrique de rub2 « +++ », et ainsi de suite... (exemple au paragraphe 3.1.1)

On met la table des matières :

<toc>

On met l'auteur de l'article et celui qui l'a porté sur le wiki, éventuellement, les « * » permettent de mettre en gras (voir au paragraphe 3.1):

*Article écrit par Auteur et wikisé par Wikiseur.*

3 Corps du document

3.1 Formatage de texte

3.1.1 Rubriques

Pour insérer une rubrique dans le document, on utilise le symbole « + » que l'on place en début de ligne et que l'on fait suivre d'un espace:

++ Rubrique1

On peut mettre une sous Rubrique de "Rubrique1" en accumulant les « + » (jusqu'à 6 maximum) :

+++ Sous Rubrique1

et ainsi de suite...

On génère ainsi une hiérarchie, qui sera reprise dans la tables des matières « toc » vue précédemment.

3.1.2 Mise en forme

Pour mettre du texte en évidence, vous disposez des styles les plus courants:

  • texte en /italique/ car entouré des symboles « / »
  • texte en *gras* car entouré des symboles « * »
  • texte en taille =fixe= car entouré des symboles « = »
  • texte en <sup>exposant</sup>
  • texte en <sub>indice</sub>

que vous pouvez par ailleurs mixer à volonté:

" you can mix the styles "

soit en wiki:

" /you *=can=*/ =mix= *the =styles=* "

Attention, il ne faut pas mettre d'espace entre le texte à formatter et les symboles de formattage.

3.1.3 Texte préformatté

Pour insérer un texte préformatté, on utilise la balise « <pre> »:

                 _           _ 
  __ _ _ __   __| | ___  ___(_)
 / _` | '_ \ / _` |/ _ \/ __| |
| (_| | | | | (_| |  __/\__ \ |
 \__,_|_| |_|\__,_|\___||___/_|

dont voici le code:

<pre>
                 _           _ 
  __ _ _ __   __| | ___  ___(_)
 / _` | '_ \ / _` |/ _ \/ __| |
| (_| | | | | (_| |  __/\__ \ |
 \__,_|_| |_|\__,_|\___||___/_|
</pre>

3.1.4 Divers

  • Pour faire une ligne horizontale, on mets trois « - » :
---
  • Pour faire un commentaire dans le code wiki on utilise la balise « <rem> »:

" Vous pouvez lire: ceci / mais pas: ! "

soit en wiki:

" Vous pouvez lire: ceci / mais pas: <rem>cela</rem> ! "
  • Indentation

Pour indenter(décrocher vers la droite) l'intégralité d'un paragraphe(comme l'est celui-ci), on utilise la balise « <q> »:

<q>
Ceci est un paragraphe
dont le texte est indenté
</q>

3.2 Listes à puces

On peut également faire des listes à puce, notez qu'un espace permet de mettre un sous élément, comme on peut le voir ci-dessous.

3.2.1 non-numérotées

Voici un exemple de liste à puce non numérotée (notez l'indentation d'un espace pour chaque niveau de l'arborescence) :

* Element1
 * Sous-Element1, fils d'Element1
 * Sous-Element2, fils d'Element1
  * Sous-Sous-Element1, fils de Sous-Element2
* Element2

voici le résultat:

  • Elment1
    • Sous-Element1, fils d'Element1
    • Sous-Element2, fils d'Element1
      • Sous-Sous-Element1, fils de Sous-Element2
  • Element2

3.2.2 numérotées

Voici un exemple de liste à puce numérotée (notez l'indentation d'un espace pour chaque niveau de l'arborescence) :

# Element1
 # Sous-Element1, fils d'Element1
 # Sous-Element2, fils d'Element1
  # Sous-Sous-Element1, fils de Sous-Element2
# Element2

voici le résultat:

  1. Element1
    1. Sous-Element1, fils d'Element1
    2. Sous-Element2, fils d'Element1
      1. Sous-Sous-Element1, fils de Sous-Element2
  2. Element2

3.2.3 mixtes

Voici un exemple de liste mixte (notez l'indentation d'un espace) :

* Element1
 # Sous-Element1, fils d'Element1
 # Sous-Element2, fils d'Element1
  # Sous-Sous-Element1, fils de Sous-Element2
* Element2

en voici le résultat:

  • Element1
    1. Sous-Element1, fils d'Element1
    2. Sous-Element2, fils d'Element1
      1. Sous-Sous-Element1, fils de Sous-Element2
  • Element2

3.2.4 astuces

Vous pouvez également faire un retour à la ligne en conservant l'indentation de la puce en question grâce à la balise « <br> »:

  • voici une une puce
    qui s'étend sur une deuxième ligne

voici le code correspondant:

* voici une une puce<br> qui s'étend sur une deuxième ligne

3.3 Tableaux

Maintenant nous allons faire des tableaux, uniquement ceux que vous devrez utilisez pour Andesi, notez que les « | » permettent d'insérer un élement dans le tableau.

3.3.1 Le tableau de base

Voici l'exemple de tableau typique qui permet de donner les choix que vous avez par exemple lors de l'installation d'un paquet, vous devrez mettre le nom du paquet dans la colone Element1, la question dans la seconde colonne et enfin la réponse :

<table cellpadding="2" border="1">
||| Commande qui conduit à ces choix
| Nom du paquet | Question | Réponse à choisir
| Ligne1.Element1 | Ligne1.Element2 | Ligne1.Element3
| Ligne2.Element1 | Ligne2.Element2 | Ligne3.Element3
</table>

le voici:

Commande qui conduit à ces choix
Nom du paquet Question Réponse à choisir
Ligne1.Element1 Ligne1.Element2 Ligne1.Element3
Ligne2.Element1 Ligne2.Element2 Ligne3.Element3

3.3.2 Les spéciaux

Voici les cinq autres types de tableaux très utiles:

3.3.2.1 Avertissement

Voici un tableau qui permet de donner au lecteur un avertissement pour une partie délicate de l'article :

warning C'est le dernier avertissement !!!

et voici son code:

<table class="info">
| <plugin Embed src="http://www.andesi.org/img_articles/Icones/warning.gif" alt="warning" height="20" width="20"> C'est le dernier avertissement !!!
</table>
3.3.2.2 Observation

Voici un autre tableau qui permet de faire observer quelque chose au lecteur (une sorte de note) :

note Notez bien que...

et voici son code:

<table class="info">
| <plugin Embed src="http://www.andesi.org/img_articles/Icones/note.gif" alt="note" height="20" width="20"> Notez bien que...
</table>
3.3.2.3 Astuce

Voici un autre tableau qui permet d'afficher une astuce :

tip La grosse astuce

et voici son code:

<table class="info">
| <plugin Embed src="http://www.andesi.org/img_articles/Icones/tip.gif" alt="tip" height="20" width="20"> La grosse astuce
</table>
3.3.2.4 Commande

Voici comment on met une commande à taper par l'utilisateur sur son système :

$ commande
ce que `commande` retourne

et voici son code:

<table class="code">
| *$ commande*
| ce que `commande` retourne
</table>

N'oubliez pas de préciser sous quels utilisateurs les commandes doivent être lancées en mettant le signe « $ » pour un utilisateur normal, et le signe « # » pour l'utilisateur root.

3.3.2.5 Pointons du doigt

Voici le dernier de tableau qui concerne quelque chose d'important :

important Fais gaffe, hein(j'suis armé)!

et voici son code:

<table class="info">
| <plugin Embed src="http://www.andesi.org/img_articles/Icones/important.gif" alt="important" height="20" width="20"> Fais gaffe, hein(j'suis armé)!
</table>
3.3.2.6 du code

Si on veut insérer le contenu d'un fichier(de configuration par exemple)dans l'article, on doit faire comme ça :

#ceci est un fichier de configuration
et ceci est du code:  .-  -.  -.. .  ... .. 
#ouais bon en fait c'est pas vraiment du code mais plutôt "andesi" en morse :)

et en wiki, cela donne:

<code>
#ceci est un fichier de configuration
et ceci est du code:  .-  -.  -.. .  ... .. 
#ouais bon en fait c'est pas vraiment du code mais plutôt "andesi" en morse :)
</code>

Fin des tableaux disponibles pour Wikiser un article !

3.4 Les images

Vous pouvez insérer des images. Cependant n'oubliez pas le titre de l'image, voici un exemple d'image inséré dans l'article :

andesi

et voici son code:

<plugin Embed src="http://www.andesi.org/img_articles/Bannieres/andesi_468x60_v5.jpg" height="60" width="468" alt="andesi" title="bannière andesi">

3.5 Les liens

Occupons nous maintenant des URL, nous allons voir les différents types d'URL possibles :

voici un url sans légende: http://www.andesi.org et le même avec légende: andesi

et voici leur code respectif:

((http://www.andesi.org))
((http://www.andesi.org)(andesi))

De plus, on peut faire 2 types de liens:

  • les liens internes au wiki:

pour cela faîtes:

((Nom de la rubrique|Nom de l'article)(Légende))

ou tout simplement

((Nom de la rubrique|Nom de l'article))

exemple: Participer

  • les liens externes au wiki:

pour ceux-là, n'oubliez pas les: « mailto: », ou « http:// », ou « https:// », ou « ftp:// », ou enfin « news: »

4 Quelques conseils...

  • N'oubliez pas de mettre les chemins en italique. Par exemple pour /usr/bin , afin que les « / » du PATH soient conservés mais que le texte soit en italique, on fera :
/<noop>/usr/bin </noop>/

idem pour les pipe (« | »), et d'une manière plus générale, tout ce qui pourrait être interprété pour du code wiki est a mettre entre balises « noop ».

  • De plus, les commandes à taper doivent être mise en gras afin de les mettre en valeur par rapport au résultat, on pourra faire ainsi :
*# cat toto*

Pour plus d'informations, vous pouvez également vous reportez à la section « Using coWiki » de cet page : http://cowiki.org.

Référence

How do you wiki? http://www.andesi.org/LeSite/HowDoYouWiki