Aide à la rédaction

Présentation

Berrypédia utilise DokuWiki, un logiciel libre puissant conçut pour écrire un wiki. L'objectif de cette page est de vous donner quelques indications pour vous aider à créer, éditer de nouvelles pages, et les intégrer au travail déjà fait dans Berrypédia.

1. Mise en page

1.1 Utilisation des icônes

Concernant la mise en page, vous pouvez utiliser les icônes disponibles en haut de la fenêtre en mode édition. Le survol avec la souris fait apparaître une étiquette qui indique pour chaque icône le résultat obtenu en cliquant sur cette icône. Il faut toujours surligner la partie du texte que l'on veut modifier, avant de cliquer sur l'icône de mise en forme.

Exemple, pour mettre en caractère gras, sélectionner la partie du texte à mettre en valeur, 
cliquer sur l'icône repérée par un B. **La partie surlignée est alors entourée de deux étoiles**, 
qui indique au logiciel de la faire apparaître graissée.

Résultat :

Exemple, pour mettre en caractère gras, sélectionner la partie du texte à mettre en valeur, cliquer sur l'icône repérée par un B. La partie surlignée est alors entourée de deux étoiles, qui indique au logiciel de la faire apparaître graissée.

1.2 Connaître toutes les subtilités de la mise en page

Pour tirer parti de toutes les ressources de mise en page offertes par DokuWiki, vous pouvez vous référer au Guide de mise en page présent sur ce wiki.

2. Création et organisation des pages

Les règles pour créer et organiser les pages de Berrypédia doivent satisfaire à la fois au respect de la syntaxe propre à DokuWiki, et aux principes d'organisation de Berrypédia.

Principe : le nommage des pages intervient à la fois sur le nom des pages et sur la création et l'organisation des répertoires.

Exemple : si vous cliquez dans le menu de droite sur Index alphabétique, vous voyez apparaître dans la barre d'adresse de votre navigateur :

http://berrypedia.org/doku.php?id=alpha

Il vous est indiqué que la page “alpha” se trouve à la racine du répertoire contenant les pages de Berrypédia.

Mais “alpha” est aussi le nom d'un répertoire qui contient l'ensemble des lettres de l'alphabet qui contiennent à leur tour l'ensemble des pages de la lettre qui leur correspond.

Un répertoire se repère par la présence du signe ”:”. Exemple, on accède à la page “b” dans le répertoire “alpha” en tapant dans la barre d'adresse du navigateur :

http://berrypedia.org/doku.php?id=alpha:b

Sur le même principe, on accède à la page “Stéphane Branger” dans le sous-répertoire “b” de “alpha” en tapant dans la barre d'adresse

http://berrypedia.org/doku.php?id=alpha:b:branger_stephane

La difficulté pour comprendre ces principes d'écriture vient du fait qu'une même chaîne de caractère peut renvoyer soit à un nom de répertoire, soit à un nom de page.

Dans l'exemple

http://berrypedia.org/doku.php?id=alpha:b

b renvoie à la page “b” du répertoire “alpha” Mais ici

http://berrypedia.org/doku.php?id=alpha:b:branger_stephane

b renvoie au sous-répertoire “b” du répertoire “alpha”

Pour simplifier les choses, il suffit de se souvenir que la dernière chaine de caractère qui apparait dans la ligne d'adresse correspond au nom de la page, et que toutes celles placées avant, suivies du signe ”:” correspondent à des répertoires.

3. Principes d'organisation des pages dans Berrypédia

Vous savez presque tout. Pour créer une nouvelle page dans Berrypédia, il faut la nommer pour faire en sorte d'une part que son nom corresponde à son objet (pour faciliter le repérage et la maintenance des pages), d'autre part pour faire en sorte qu'elle soit rangée dans le bon répertoire de Berrypédia.

4. Et pratiquement ?

  • Création manuelle

Une méthode possible pour créer une page et la ranger au bon endroit dans Berrypédia consiste à copier l'adresse suivante[CTRL+C], la coller[CTRL+V] et la compléter dans la barre d'adresse de votre navigateur :

  1. par le répertoire de la lettre dans lequel va se placer votre article,
  2. par le nom de la page de votre article
http://berrypedia.org/doku.php?id=alpha:[lettre du répertoire]:[nom de page de votre article]

Cela donne par exemple pour l'article cathédrale :

http://berrypedia.org/doku.php?id=alpha:c:cathedrale

ou “alpha” correspond au répertoire général de Berrypédia, “c” le répertoire où sont rangés tous les articles commençant par c, et “cathedrale” (sans accent, ni espace, ni caractère interdits) le nom de l'article à écrire.

À noter : tous les sous-répertoires alphabétiques de “alpha” sont créés. Vous n'avez pas à vous en occuper. La seule chose à laquelle vous devez faire attention est de nommer correctement vos pages, et de les placer au bon endroit.

4.1 Cas d'une bibliographie annexe

Les bibliographie annexes étant rangées dans un répertoire particulier, tapez dans la ligne d'adresse

http://berrypedia.org/doku.php?id=biblio:[nom_de_la_bibliographie]

5. Règles de nommage des pages

Un nom de page

  1. doit avoir un nom qui évoque son contenu
  2. ne doit pas comporter d'accent
  3. ne doit pas comporter d'espace. Remplacer les espaces par le signe de soulignement _

6. Effacer une page

Pour effacer une page, il suffit de la vider de son contenu, et d'enregistrer les modifications. Seuls les validateurs et les administrateurs sont autorisés à effacer des pages.

7. Utilisation des tags

Les tags servent à opérer une organisation transversale de Berrypédia. C'est par les tags que les portails thématiques sont générés automatiquement. Un article est validé à partir du moment ou il est marqué par un tag de classement thématique. Cette décision est de la responsabilité des validateurs. En cours d'élaboration, tout article comporte le tag suivant :

{{tag>elaboration}}

Les tags sont placés en toute fin de page.

Tableau des tags

Tag Utilisation Remarques
A, B, C … Classement dans les index alphabétiquesliste fixe, permanent
sciences, patrimoine, …Classement dans les index thématiquesliste ajustable, permanent
moisArticle classé “article du mois”temporaire
recentArticles classés “articles récemment validés”temporaire
elaborationarticle classé “article en cours d'élaboration”par défaut à la création, temporaire

Exemple de tags pour un l'article BRANGER, Stéphane

{{tag>arts B mois recent}}

Résultat : cet article est classé dans l'index thématique “Arts et lettres”, dans l'index alphabétique “B”, il est en outre classé “Article du mois” et apparait dans la liste des “articles récemment validés” (sur la page index alphabétique).

8. Liens, appel de notes

Bien que la syntaxe à employer pour faire des liens ou provoquer un appel de notes se trouve dans Guide de mise en page, il n'est pas inutile de l'évoquer dès à présent, car vous en aurez pratiquement immédiatement besoin.

8.1 Liens

Pour faire un lien dans DokuWiki, la syntaxe à respecter est la suivante

[[ [URL] | [Nom du lien] ]]

exemple : faire un lien vers Berrypédia

[[http://berrypedia.org|Berrypédia]]

exemple : faire un lien vers une page de Berrypédia

[[alpha:b:branger_stephane|Article Stéphane Branger]]

Attention : si vous faites un lien vers une page qui n'existe pas dans Berrypédia, DokuWiki vous proposera de la créer. Ne créez que les pages dont vous avez besoin. Par exemple, ne recréez pas une page qui existe déjà simplement parce que vous avez fait une erreur de syntaxe en écrivant votre lien !

Vous l'aurez compris : il est possible de créer des pages dans Berrypédia soit en tapant dans la barre d'adresse le nom et l'emplacement de la page dans Berrypédia, soit en créant un lien vers une page qui n'existe pas encore. À vous de choisir la méthode qui vous convient le mieux.

8.1.1 Créer une ancre et faire un lien s'y rapportant

Le plugin BOOKMARK étant installé, vous pouvez créer des ancres et faire des liens vers elles. Cela permet de faciliter la navigation dans les pages longues. Vous pouvez aussi appeler une ancre directement depuis n'importe quelle page du wiki.

Pour créer une ancre :

À l'endroit où vous voulez créer une ancre, taper

<BOOKMARK:[nom de l'ancre]> 

Attention de respecter la syntaxe. BOOKMARK s'écrit toujours en majuscule

Pour faire un lien vers une ancre existante :

syntaxe :

[[[nom de la page]#[nom de l'ancre]|Intitulé du lien]]

exemple : pour faire un lien vers l'ancre “working”, sur la page index alphabétique

[[:alpha#working|Aller directement à la liste des articles en cours d'élaboration]]

résultat : Aller directement à la liste des articles en cours d'élaboration

8.1.2 Créer un lien vers une sous-section de page

syntaxe :

[[[nom de la page]#[nom de la sous-section]|Intitulé du lien]]

8.2 Appel de notes

Une chaine de caractère mise entre deux parenthèses est renvoyée en note numérotées en bas de page.

 (([texte de la note]))

9. Organisation hiérarchique des pages

Dans le menu de mise en forme, vous disposez des icônes H1, H2 etc. Elles vous permettent d'organiser votre texte en section et sous-section distinguées hiérarchiquement selon leur ordre numérique. Il faut vous en servir,

  1. pour structurer logiquement votre article
  2. parce que DokuWiki s'en sert pour générer automatiquement une table des matières.

Outils personnels