Wikilivres:Conventions sur les titres

Raccourci [+]
WL:CT

Retour Aide:Accueil.

Recommandation Wikilivreslink={{{link}}}

Ce texte est considéré comme une recommandation dans Wikilivres.
Il décrit un principe adopté et recommandé par une majorité des personnes actives au sein du projet.
Vous pouvez librement modifier cette page, mais veuillez utiliser la page de discussion pour proposer une modification majeure.

La convention

modifier

Chaque titre de page d'un wikilivre doit commencer par le nom du livre suivi d'un slash (/) et du nom du chapitre : Titre_du_livre/Nom_du_chapitre.

Après ça, les auteurs d'un livre sont libres de décider de la structure la plus adaptée au livre. La seule condition est que si une structure hiérarchique est utilisée sur la page principale, un slash devrait être utilisé comme séparateur :

  • Titre_du_livre/Chapitre/Nom_de_page ;
  • Titre_du_livre/Chapitre/Nom_de_page/Nom_de_sous-page ;
  • etc.

Important : Il est recommandé de n'avoir qu'un seul niveau de titre (un seul slash) afin de pouvoir :

  • déplacer un sous-chapitre d'un chapitre à un autre plus facilement,
  • avoir des liens qui ne soient pas trop longs,
  • faciliter l'utilisation de modèles de navigation entre les chapitres,
  • ne pas dépasser la limite de 255 octets (encodage UTF-8) pour le lien (résultat de l'expansion des / et ..). Par exemple, le lien suivant est trop long :
    [[aaaaaaaaaabbbbbbbbbbccccccccccddddddddddeeeeeeeeeeffffffffffgggggggggghhhhhhhhhhiiiiiiiiiijjjjjjjjjjaaaaaaaaaabbbbbbbbbbccccccccccddddddddddeeeeeeeeeeffffffffffgggggggggghhhhhhhhhhiiiiiiiiiijjjjjjjjjjaaaaaaaaaabbbbbbbbbbccccccccccddddddddddeeeeeeeeeeffffff|un lien de 256 octets]]

Donc au lieu d'avoir les titres suivants :

  • Le livre/Introduction
  • Le livre/Introduction/Historique
  • Le livre/Introduction/Présentation

il est préférable d'avoir :

  • Le livre/Introduction
  • Le livre/Historique
  • Le livre/Présentation

Limiter la longueur d'un titre

modifier

Un titre ne doit pas être un résumé ni une phrase complète. En général il ne doit pas contenir de caractères de ponctuation. Dans le cas contraire cela indique que le titre ressemble trop à une phrase.

Un titre doit seulement comporter quelques mots (jusqu'à 7 environ). Le contenu de la page ou de la section est là pour éventuellement compléter et préciser davantage la nature du texte.

Un titre trop long peut ne pas être supporté ni par MediaWiki (voir section précédente), ni par le lecteur qui risque de ne pas percevoir le plan du livre.

Le slash dans un titre

modifier

Certains termes d'un titre comportent un slash (ou barre oblique) qui ne constitue pas un séparateur de sous-partie : Entrées/Sorties, GNU/Linux, TCP/IP.

Il faut dans ces cas-là, si possible, remplacer le caractère barre oblique par un tiret : Entrées-sorties, GNU-Linux. Cette règle n'est pas applicable pour les termes qui s'écrivent de façon standard en utilisant la barre oblique : TCP/IP.

Exemples

modifier

On peut voir comment les conventions sont appliquées sur ces deux exemples (en anglais) :

La structure plate est généralement plus populaire.

Niveau des titres

modifier

Le système wiki utilise la syntaxe suivante pour les titres :

= titre niveau 1 =
== titre niveau 2 ==
=== titre niveau 3 ===
==== titre niveau 4 ====
...

Le nombre de signes égal aux deux bouts détermine le niveau du titre.

Il est recommandé de réserver le niveau 1 aux versions imprimables pour reprendre le titre de la page. Le niveau 2 est donc celui qui doit être utilisé pour diviser une page en sections. Chaque titre de niveau n peut être divisé en différents titres de niveau n+1, c'est-à-dire qu'il faut éviter de sauter un niveau (ex : passer d'un titre de niveau 2 à un titre de niveau 4).

Présentation

modifier

La lecture des titres utilisant la convention n'est pas toujours lisible, surtout quand certaines parties du titre utilisent un slash (entrées/sorties, TCP/IP, ...). Pour résoudre ce problème, il est possible d'afficher chaque niveau de titre sur une ligne à part. Ce qui est fait par le script par défaut.

Cependant, celui-ci ne fonctionne pas en dehors de l'espace de nom principal en mode visualisation de page, ou pour certaines pages. Il est possible alors d'utiliser le gadget nommé « Affichage amélioré des titres (alternative à la fonction par défaut) » dans les préférences de l'utilisateur, onglet « Gadgets ».

Chaque ligne affichée est un lien vers le niveau correspondant. Ainsi, dans l'exemple précédent, la ligne « Le système d'exploitation Linux » permet de retourner à la page principale du livre.

Astuces

modifier

Notez que chaque page avec un slash dans le nom génère automatiquement un lien vers la hiérarchie. Vous pouvez aussi utiliser un style de lien adéquat, particulièrement utile dans la table des matières de votre livre.

  • [[/Chapitre/]] sur la page Livre à la place de [[Livre/Chapitre|Chapitre]]
  • [[/Chapitre|titre du lien]] sur la page Livre à la place de [[Livre/Chapitre|titre du lien]]
  • [[../Unautrechapitre/]] sur la page Livre/Chapitre au lieu de [[Livre/Unautrechapitre|Unautrechapitre]]

Pas de numérotation

modifier

Afin de faciliter le ré-ordonnancement des chapitres, et l'insertion de nouveaux chapitres, il est recommandé de ne pas donner un numéro dans le titre (ex: Nom du livre/Chapitre 1, Nom du livre/Chapitre 2, ...), mais de donner le nom des chapitres (ex: Nom du livre/Nom du chapitre).

Nomenclature à suivre

modifier
  1. Restrictions techniques : les caractères suivants ne sont pas permis dans les noms de pages: # < > [ ] { } | ; Le caractère spécial ? peut être utilisé directement dans un lien wiki ou en l'encodant %3F dans une URL, ou un lien complet.

Voir aussi

modifier