Mise en forme des articles de la base de connaissance

La base de connaissance (nommée aussi KB ou FAQ) dans la rubrique Trucs & Astuces utilise une mise en forme de type Wiki.

Voici les possibilités.

1 - Les titres

• Le titre général est placé entre le signe "égal" ("=").
• Le titre de niveau 1 est placé entre 2 signes "égal" ("==").
• Le titre de niveau 2 est placé entre 3 signes "égal" ("===").
• .. etc ...

Attention : la ligne doit commencer et finir par le signe "="

1.1 - Exemple

=Titre de niveau1=

==Titre de niveau2==

=====Titre de niveau5=====

2 - Les listes

* Puce niveau 1

** Puce niveau 2
*** Puce niveau 3

Notez qu'il est déconseillé de commencer par une puce de niveau 2, car l'affichage sera précédé d'une puce de niveau 1 vide ! Par ailleurs, veillez à ne pas sauter de niveaux entre chaque item pour les mêmes raisons.

2.1 - Exemple conseillé

*Test1

*Test2
**Test2.1
**Test2.2
***Test2.2.1
***Test2.2.2
**Test2.3
***Test2.3.1
****Test2.3.1.1
**Test2.4
**Test2.5
*Test3
*Test4

2.1.1 - Résultat

• Test1
• Test2
  • Test2.1
  • Test2.2
    • Test2.2.1
    • Test2.2.2
  • Test2.3
    • Test2.3.1
      • Test2.3.1.1
    • Test2.4
    • Test2.5
• Test3
• Test4

2.2 - Exemples déconseillés

2.2.1 - Commencer par un niveau X

2.2.1.1 - Exemple

****Exemple

2.2.1.2 - Résultat

• • • • Exemple

2.2.2 - Sauter des niveaux de puce

2.2.2.1 - Exemple

*Test1

*Test2
***Test2.1.1
*Test3

2.2.2.2 - Résultat

• Test1
• Test2
  • • Test2.1.1
• Test3

3 - La table des matières

2 fois underscore ("__") de chaque côté et TOC en majuscule créé automatiquement la table des matière (avec liens) en se basant sur les titres et sous titres.

__TOC__

Remarques : Veuillez à :

• Ne pas donner les mêmes noms aux titres et sous titres, car les liens vers les passages de l'article ne vont pas fonctionner.
• Ne pas laisser trop de retours chariot (à la ligne) entre la table de matières et le corps de l'astuce ainsi qu'entre les différents niveaux de titres car ceci engendre un mauvais affichage de la table.
• Ne pas mettre des liens dans vos titres et sous-titres.

4 - Les liens

Pour créer un lien, il suffit d'utiliser la syntaxe suivante :

[url texte du lien]

Il est important de laisser un espace entre l'URL et le texte. Si aucun texte n'est mis, l'URL sera utilisée comme texte.

4.1 - Lien rapide

Par ailleurs, vous pouvez faire un lien direct vers un article en utilisant la syntaxe suivante :

[[Mot clé]]

Par exemple [[carte mère]] créera automatiquement un lien vers l'article sur la carte mère.

4.2 - Autres liens

• Insérer lien hypertexte : utiliser la fonction pour chercher une astuce, article, logiciel ou un produit rapidement. Le lien sera mis automatiquement dans le message.
• Insérer lien dynamique CCM : remplace le mot sélectionné par le lien hypertexte le plus approprié au mot sélectionné. Cette fonction est équivalente au double crochets.

5 - Les ancres

L'ancre est constituée par le titre de niveau 1 ou 2 et le nom de cette ancre reprend le nom du titre en minuscule, sans accents, sans caractères spéciaux et sans espace.

[#ancre-vers-le-titre-1-ou-2 ancre vers le titre 1 ou 2]

Notez que la syntaxe exacte est de placer entre crochet ("[]") :

• la dièse ("#")
• suivie immédiatement et sans espace du nom du titre ou sous titre (Ici l'espace est volontaire pour contourner la mise en forme Wiki).
• suivi d'un espace
• pour terminer par le texte visible du lien vers l'ancre.

Il faut donc :

• n'utiliser que des minuscules et des lettres sans accent,
• ne pas ponctuer,
• remplacer les espaces par des "-",
• ne pas placer de liens dans les titres et sous titres

Ainsi :

• Pas de "( )",
• Les " ' " sont remplacées par des " - ",
• Les "ç" sont remplacées par des "c",
• "1 - titre" devient "#1-titre"

6 - Les images

6.1 - Ajouter une image

Vous avez trois possibilités :

• Manuellement : Il suffit de suivre la syntaxe suivante :

  [[Image: url_de_l_image]]

• Via le bouton Insérer Image et choisir les attributs désirés
• Via le champs Charger une image : Il suffit de prendre la capture sur votre PC et utiliser les boutons Parcourir et Charger pour sélectionner et envoyer l'image sur CCM

Pour plus d'informations sur les images de la FAQ : Insérer une image dans la FAQ
Voir également ici : Insérer une image dans une discussion

6.2 - Attributs

Il est possible d'y adjoindre des attributs supplémentaires, pouvant être cumulés. Les attributs sont séparés par le signe "|" (AltGr+6). Les attributs peuvent être mis dans n'importe quel ordre mais l'attribut ALT doit toujours être le dernier.

6.3 - Liste des attributs

• Positionnement de l'image à gauche :

  [[Image: url_de_l_image|left]]

• Positionnement de l'image à droite :

  [[Image: url_de_l_image|right]]

• Positionnement de l'image centré (par défaut) :

  [[Image: url_de_l_image]]

• Redimensionnement de l'image (en pixels) :

  [[Image: url_de_l_image|200px]]

• Attribut ALT de l'image, il s'agit du dernier attribut avant le crochet :

  [[Image: url_de_l_image|right|150px|Attribut ALT de l'image]]

7 - Le code

Avec cette balise, l'indentation est préservée et la police est une police de programmation.

<code>Code</code>

8 - Gras

<gras>Texte en gras</gras>

9 - Italique

<ital>Texte en italique</ital>

10 - Souligné

<souligne>Texte  souligné</souligne>