Rédiger un article pour le wiki

L'article en accès direct en bas à gauche de l' accueil du wiki est exhaustif.

syntaxe_dokuwiki

Mais, il n'y a pas besoin de lire tout cela pour se lancer dans la rédaction d'un article.

Propos de cet article

Donner quelques conseils de mise en forme et d'usage basique de la création d'articles pour le wiki.

Donner quelques conseils afin de rédiger un article.

Rappel

Le wiki est la partie site internet “ classique” du forum icaunux.

Il permet en principe une utilisation collaborative d'un espace de travail en ligne.

Il peut dans ce cadre être utilié pou un projet ponctuel dans la gestion d'un document, d'une association.

Il conserve un historique des modifications des articles.

Il permet de comparer plusieurs versions d'une page ou d'un document.

Il permet de modifier un article écrit par un autre rédacteur, afin de le corriger ou de l'améliorer, ou de mettre à jour des liens périmés, des informations nouvelles.

Attention, ce n'est pas un blog, vous devez choisir l'endroit où l'article sera modifié.

Enfin, une page du site wiki, voire la présentation générale du wiki peut aussi être modifiée (attention !).

Prérequis

Un administrateur doit vous avoir donné les droits d'éditer le wiki.

La qualité de membre de l'association, ou de membre du forum ne donne pas automatiquement ces droits.

Afin d'éviter le bazar, ils ne sont accordés qu'au compte-goutte, à des membres de confiance, de préférence ceux du bureau.

Si vous avez un compte sur le forum, il est souhaitable que vous choisissiez un autre login quand vous demanderez un mot de passe à l' admin.

Ceci permettra à firefox de mémoriser les deux mots de passe et les deux comptes.

Les bases

Avant de créer un article il faut avoir une idée de son plan, même si celui-ci peut être modifié ensuite.

Rédigeur

On peut entrer son texte directement en ligne, mais cela n'est pas très malin.

La fenêtre du wiki n'est pas aussi large que la fenêtre de l' éditeur de texte.

En cas de bug du navigateur ou du PC (rarissime mais quand même !), vous perdez votre travail, Plus souvent, il s'agira d'une panne de batterie, de secteur, d'un incident le chien passe entre le portable et l'adaptateur secteur, etc…

Préparer un brouillon vous donne plus de temps pour réfléchir, modifier, corriger votre texte.

Il faut donc rédiger avec un éditeur de texte, tel gedit sous linux par exemple.

Corriger les fautes

Astuce, afin de bénéficier d'un correcteur de texte, vous pouvez copier coller le contenu du document gedit dans un document Libre Office.

Attention, si la correction, par simple ajoût d'un s qui manque, fait sauter une ligne, il y aura risque de décalage lors de la réimportation dans le wiki.

Il vaut mieux recoller le texte corrigé dans gedit.

Bac à sable

En pratique le bac à sable ne modifie par le wiki, et ne crée par de nouvel article.

Il ne sert que lors des premiers essais, mais, à titre personnel, ne m'a rien apporté de concluant.

Il est facile de créer un nouvel article “ créer cette page”, puis de coller son texte depuis gedit et de faire aperçu, SURTOUT pas enregistrer !

Si cela vous satisfait, vous enregistrerez, sinon anulez; pour plus de sûreté,vous fermez l' onglet ouvert dans votre navigateur.

Rédigeur 2

Il est possible de compléter la mise en forme du texte en ligne dans la page du wiki ( depuis le navigateur), pour insérer une photo ou une capture d'écran par exemple.

On peut utiliser le bouton dédié en haut de la fenêtre de texte.

Selon les sites et wiki, il nous conduit vers une boite de dialogue, :

- Souvent un site qui héberge des images, ou qui propose un plugin en ligne pour les redimensionner et les mettre au format suporté par le wiki.

-Il peut s'agir aussi d'un plugin du wiki.

Pour ce qui concerne le wiki Icaunux, les images doivent au préalable avoir été uploadées (déposées) sur la partie du site réservée à cet usage, là aussi c'est un plugin en ligne qui modifie les images afin de les adapter au wiki. Vous avez le choix de leur taille et de leur nom.

Pour le coup, la fonction aperçu du wiki sera essentielle.

Le document d'origine dit :

Vous pouvez inclure des images externes et internes avec des accolades.

Vous pouvez spécifier leur taille (facultatif).

Plan et Index

Le titre

Choisir le titre est important car c'est ce qui sera vu en premier dans l' index des articles.

Il est mieux qu'il ne soit pas trop long, car sinon, il ne tient pas à côté de la table des matières automatiquement générée à chaque fois qu'un titre ou sous-titre est entré.

Si vous avez plus de trois titres, une table des matières est construite automatiquement – ceci peut être désactivé en incluant la chaîne dans le document.

Il suffit de taper six fois le signe égal de chaque côté du titre afin qu'il soit reconnu par le wiki en tant que titre.

Plan et chapîtres

Il est souhaitable de garder ce format pour les titres de chapitre principaux car de la sorte la partie (largeur) lisible est plus importante surtout lorsqu'on a créé des sous-titres.

Niveau 1 six signe égal Niveau 2 cinq égal Niveau 3 quatre égal Niveau 4 trois égal

Chercher le niveau 5 n'est pas souhaitable pour des raisons de lisibilité.

De toute façon, il faut un texte long pour justifier autant de niveaux de titres. Or, plus le texte est long, justement, plus il faudra scroller dans la page pour lire la suite, ce qui est assez pénible pour la navigation dans le texte.

Indexer l' article

Index

Se place en bas de votre texte.

Il est encadré par deux accolades en_debut_et_deux_accolades_en_fin

Il est constitué d'un invariant “tag suivi de >” soit

 tag>

Ce qui suit immédiatement le tag> doit appartenir à une section existante de la documentation, plus exactement à son nommage dans le wiki, ce nommage est choisi par le créateur de la catégorie.

Exemple averti pour la partie “documentation pour les avertis” débutant pour la partie “documentation pour les débutants”

Donc tag_averti_votre_titre

Il n'est pas obligatoire de placer des _ entre les mots de votre titre, mais c'est mieux

De toute façon, ce n'est pas ce titre là qui sera visible en tant que nom d' article, mais le premier titre de rang 1.

Agrémenter le corps du texte

Les notes

Aspect dynamique. ne pas en abuser, mais elles agrémentent le texte et en facilitent la lecture.

Le panneau stop apparaît ainsi qu'une boite de couleur en entrant simplement

  <note bloquante> Votre texte </note>

Idem avec note importante, etc ( voir doc originel pour compléments)

Les saut de paragraphe

La touche Entrée suffit à obtenir un saut de ligne ( aérer un paragraphe ou sous-paragraphe).

Il ne faut pas en abuser, car on garde le plus possible la cohérence textuelle de l' écrit habituel. Chaque paragraphe contient si possible une idée, etc…

Format des caractères

Gras

** votre mot ** donnera votre mot .

Ce qui se voit le mieux est sans aucun doute, les caractères gras. Ils peuvent permettre de mettre en valeur une critique, un goupe de mots important. Là aussi ne pas en abuser, car la page devient lourde visuellement.

Eviter le plus possible les majuscules, les titres sont naturellement et automatiquement mis en caractères plus gros.

Souligné

__votre mot__ donne votre mot

Bas de page

Double parenthèse de chaque côté du texte de la note de bas de page. Inutile d'entrer son numéro, il sera automatiquement incrémenté.

Lignes de commande & blocs de texte

Pour donner une indication sur la ligne de commande à entrer plusieurs solutions.

Après un saut de page, valider quatre cinq fois la touche espace.

Liens

Les liens externes sont reconnus automatiquement :

http://www.google.fr ou www.google.fr

Le lien en dur copié depuis un site web, suit les parenthèse; il est parfois très long et moche. Il s'agit de le faire suivre d'un pipe, puis de le renommer (votre choix) puis fermer les ] ( deux) Vous pouvez aussi donner des noms aux liens : Ce lien pointe vers Google.

Conseils généraux au débutant

Avant de se lancer dans des mises en page élaborées, focalisez vous sur la cohérence et la syntaxe de votre texte.

Il est possible de créer des pages techniques (tableaux, etc)…

Modifier votre article

Pourquoi

Vous notez des fautes oubliées, vous apportez une précision, corriger un lien mort, etc.

Deux méthodes

Si vous souhaitez restructurer complètement le corps du texte et/ou son contenu, bouton en haut à gauche de la page.

Modifier cette page.

Si vous souhaitez restructurer simplement un paragraphe, bouton à droite en bas du paragraphe concerné.

rediger_un_article_pour_le_wiki.txt · Dernière modification: 2012/05/06 14:52 (modification externe)
GNU Free Documentation License 1.3
Powered by PHP Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0 Valid HTML5