From Mageia wiki
Jump to: navigation, search
Drakconf multiflag.png
Autres langues

Deutsch ; English ; Français


Introduction

Cette page a pour objectif d'aider quiconque voulant écrire, modifier ou traduire les pages du Wiki de Mageia. Il faudra rejoindre l'équipe de documentation de Mageia (en).

Mageia utilise ce wiki pour trois raisons principales :

  1. Il est utile afin que les équipes coordonnent leurs actions (reports, planning, règles, listes des tâches à réaliser, ...). Toutes ces pages appartiennent à la catégorie "Doc".
  2. Fournir des informations concernant les versions aux utilisateurs finaux de Mageia. Ce sont souvent les Erratas ainsi que les notes de versions. Ces pages appartiennent à la catégorie "Mageia n". i.e. Mageia_4_Errata_Fr.
  3. Procurer des informations supplémentaires concernant la documentation aux utilisateurs finaux. Toutes ces pages appartiennent à la catégorie "Documentation".

Le Wiki n'est majoritairement disponible qu'en anglais pour le moment, cependant un ajout d'une fonction multi-langues sera bientôt prête, (voir la section qui n'est pas encore écrite ci-dessous :) ).

Exigences requises

Généralités

Afin de pouvoir écrire, modifier ou traduire des pages dans le Wiki de Mageia, suivez ces simples règles:

  1. Fournissez les informations vous concernant ici pour obtenir les droits
  2. Rejoignez l'équipe de documentation de Mageia.
  3. Abonnez-vous à la mailing list doc-discuss@ml.mageia.org (en) et expliquez ce que vous avez l'intention de faire. C'est le meilleur moyen de coordonner nos actions, partager nos idées et recevoir de l'aide. Vous pouvez aussi utiliser le canal IRC: #mageia-doc sur Freenode (en anglais).
  4. Soyez attentif à votre style d'écriture, votre orthographe ainsi que votre syntaxe. N'hésitez pas à demander de l'aide si nécessaire, on ne mord pas.
  5. Veillez au bon arrangement de votre page. Les captures d'écrans doivent être lisibles sans être trop grandes (600px est souvent suffisant).
  6. Ayez connaissance et respectez la Charte de Mageia.

Ce pour quoi le Wiki est fait

  • Une documentation collaborative de bonne qualité concernant les projets de Mageia :
    • Exposer le projet de Mageia, son esprit et ses objectifs, les outils inclus, les équipes et les processus internes.
    • Offrir une documentation claire à propos du déroulement des installations/migrations et l'aide à la configuration sur les petites et grosses infrastructures informatiques.
    • Informer concernant les outils et les programmes délivrés ou pouvant être installés sur Mageia.
    • Expliquer l'architecture de la communauté ; permettre l'accès à l'aide pour les contributeurs et leur permettre de rejoindre la communauté ainsi que de participer facilement en fonction de leurs compétences et besoins.
  • Fournir des informations utiles et des conseils.
  • S'adresser tout aussi bien aux utilisateurs finaux qu'aux utilisateurs avancés et les administrateurs.
  • Pour les applications de bureau et de serveurs.
  • Pour la communauté.

Ce pour quoi le Wiki n'est pas fait

  • Dupliquer des informations provenant de ressources déjà existantes :
  • Une page d'hébergement pour les pages de projets individuels,
  • Une F.A.Q, page de question/réponses ou tout autre genre de support (référez-vous au site officiel ou aux sites dédiés pour accéder à ces outils),
  • Documentation online ou documentation offline.

Présentation d'une page Wiki

Sans être connecté

Wiki deco tuto.jpg

Keys:

  1. - La page du Wiki lui-même,
  2. - La page de discussion, où les contributeurs peuvent expliquer leur travail, partager leurs idées et résoudre les problèmes
  3. - Onglet de lecture
  4. - Onglet d'édition, vous devez être connecté pour y avoir accès,
  5. - Une liste chronologique de toutes les modifications, elle permet de les annuler,
  6. - Entrez votre pseudo et votre mot de passe afin d'avoir accès aux droits de modifications,
  7. - Le moteur de recherche du Wiki
  8. - Dans cette boîte à outils, le lien "Pages spéciales" est intéressant. Il donne des statistiques utiles et le lien "Catégories" liste toutes les catégories existantes (voyez ci-dessous comment ajouter des catégories à une page).

En étant connecté

Une fois que vous avez entré votre pseudo et votre mot de passe, de nouveaux outils font leur apparition.

Wiki connecte tuto.jpg

Keys:

  1. - Ce menu sert à personnaliser le Wiki. <connexion> ("Proximacentauri" sur la capture d'écran) est votre espace personnel, un endroit où vous pouvez vous présenter ou créer une nouvelle page avant de lui donner un nom, la "Page de discussion" est la zone d'échange de votre page, les "Préférences" permettent de personnaliser l'interface (i.e. langage désiré), les autres parties vont de soi.
  2. - En passant votre curseur sur l'icône, deux liens s'afficheront, le premier "Renommer" et "Suivre"
  3. - Dans la boîte à outils, la fonction "Téléverser un fichier" permet d'uploader des fichiers (généralement des photos ou des captures d'écrans) dans le Wiki. C'est fortement recommandé afin de comprendre le contenu de la page.

Syntaxe principale

Généralités

Cette partie renseigne sur les commandes basiques afin de créer une page et/ou apporter des éclaircissements. Pour plus d'informations, consultez ces liens ci-dessous et Google (ou tout autre moteur de recherche) est votre ami . Nous vous rappelons que ce Wiki est proposé par MediaWiki.

Dans notre Wiki, le nom de la page apparaît automatiquement comme le titre de cette dernière (actuellement comme ceci "Wiki » Nom de la page"). Toutefois, si vous voulez un titre différent (peu importe le titre), réservez alors l'utilisation du premier niveau de Paragraphe "=" au titre de la page seulement. Dans ce cas, utilisez le second niveau "==" et au-delà pour votre page au lieu du premier niveau "=" et au delà. C'Vous pouvez utiliser ou non des espaces blancs entre les tags et le contenu à votre convenance. Le wiki ignorera les espaces lors de la publication.

Ce que vous écrivez Ce que vous obtenez
= Titre niveau un = Titre niveau un
== Titre niveau deux == Titre niveau deux
=== Titre niveau trois === Titre niveau trois
==== Titre niveau quatre ==== Titre niveau quatre
===== Titre niveau cinq ===== Titre niveau cinq
====== Titre niveau six ====== Titre niveau six

Mise en page

Notepad.png
À noter !
Il y a une mise en page spéciale pour les commandes, les menus, les programmes et les fichiers
Ce que vous écrivez Ce que vous obtenez
' 'italique' ' italique
' ' 'gras' ' ' gras
' ' ' ' 'italique et gras' ' ' ' ' italique et gras
{{cmd|nom de la commande}} nom de la commande
{{menu|menu -> sous-menu}} menu -> sous-menu
{{file|nom du fichier}} nom du fichier
{{prog|nom du programme}} nom du programme
<pre> texte en mode présentation</pre>
 texte en mode présentation

Les lignes
:peuvent être
::placées
:::sur différents niveaux

Les lignes

peuvent être
placées
sur différents niveaux
<span style="color: red;">texte en rouge</span> texte en rouge
<span style="color: blue;">texte en bleu</span> texte en bleu
<span style="color: green;">texte en vert</span> texte en vert
<span style="color: orange;">'''texte gras en orange'''</span> texte gras en orange
<span style="color:#FF00FF;">texte en quelconque couleur</span> texte en quelconque couleur
Insérez le tag <br> pour un retour à la ligne Insérez le tag
pour un retour à la ligne

Listes

Ce que vous écrivez Ce que vous obtenez

* liste désordonnée, première ligne
* liste désordonnée, seconde ligne
** liste désordonnée, troisième ligne
** liste désordonnée, quatrième ligne

  • liste désordonnée, première ligne
  • liste désordonnée, seconde ligne
    • liste désordonnée, troisième ligne
    • liste désordonnée, quatrième ligne

# liste ordonnée, première ligne
# liste ordonnée, seconde ligne
## liste ordonnée, troisième ligne
## liste ordonnée, quatrième ligne
##* les deux, cinquième ligne
# retour à la liste ordonnée

  1. liste ordonnée, first line
  2. liste ordonnée, second line
    1. liste ordonnée, third line
    2. liste ordonnée, fourth line
      • les deux, cinquième ligne
  3. retour à la liste ordonnée

Modèles

Ils sont utilisés afin de mettre quelque chose d'important en avant.

Notepad.png
À noter !
Pour écrire une note, écrivez {{note-fr|Text ...}}
Warning.png
Attention !
Pour écrire un avertissement, écrivez {{attention-fr|Text ...}}
Dragon.png
Ici sont des dragons!
Pour donner une astuce, potentiellement dangereuse écrivez {{dragons-fr|Text ...}}


Info.png
Information:
Pour donner une information, écrivez {{information|Text ...}}


Pour préparer un brouillon, écrivez {{ébauche-fr|Text ...}} en haut de la page, et vous obtiendrez cette bannière :
Brouillon.png


Konsole.png
[root@computer ~]# Pour afficher une commande qui sera inscrite dans une console en root, écrivez {{root console|command line}}
[root@computer ~]# _


Konsole.png
[user@computer ~]$ Pour afficher une commande qui sera inscrite dans une console, écrivez {{Console|command line}}
[user@computer ~]$ _


Pour une liste des Modèles Templates

Tableaux

Les possibilités données par mediawiki pour construire des tableaux sont très importantes, rendez-vous sur cette page pour plus d'informations. Néanmoins, pour construire un simple tableau, vous pouvez utiliser les modèles ci-dessous.

  • Dans la première ligne, remplacez le "1" derrière "border=" par l'épaisseur du bord que vous voulez (en pixels), remplacez "center" par "left" ou "right" (sans les ") et remplacez "800" par une autre largeur.
  • Dans la seconde ligne, ajouter ou enlever une colonne, séparée par "!!". Écrivez alors les titres des colonnes.
  • Dans les autres lignes, ajouter ou enlever les lignes des tableaux, elles sont séparées par "|-"

Ce que vous écrivez (vous pouvez copier/coller le tout afin d'avoir le même tableau sur votre page):

{|border="1" class="wikitable" style="text-align:center; width:800px;"
! Première colonne!! Deuxième colonne!!Troisième colonne
|-
|colonne1 ligne1
|colonne2 ligne1
|colonne3 ligne1
|-
|colonne1 ligne2
|colonne2 ligne2
|colonne3 ligne2
|-
|colonne1 ligne3
|colonne2 ligne3
|colonne3 ligne3
|}

Ce que vous obtenez:

Première colonne Deuxième colonne Troisième colonne
colonne1 ligne1 colonne2 ligne1 colonne3 ligne1
colonne1 ligne2 colonne2 ligne2 colonne3 ligne2
colonne1 ligne3 colonne2 ligne3 colonne3 ligne3

Liens et ancres de liens

Ce que vous pouvez faire Ce que vous écrivez Ce que vous obtenez
Lien vers la page Wiki de Mageia (i.e.: la page d'accueil du Wiki).
(1) Sans nom
(2) Avec le nom "Bienvenue"

[[Main_Page]]
[[Main_Page|Bienvenue]]

[1]
Bienvenue
Lien vers un URL (i.e.: la doc officielle de Mageia.).
(1) Sans nom
(2) Avec le nom "Documentation"

[http://www.mageia.org/fr/doc/]
[http://www.mageia.org/fr/doc/ Documentation]

[2]
Documentation
Ajouter une ancre de lien "ancre1" on the word "texte" some existing <span id="ancre1">texte</span> in a page Un texte sur une page
Créez un lien vers "ancre1" cliquez [[#ancre1|ici]] vers l'ancre1 cliquez ici vers l'ancre1
Créer un lien vers l'ancre de lien "Wiki_documentation" dans la page Wiki "Les_nouveaux_venus_commencent_ici" (en) Lisez la [[Newcomers_start_here_fr#Documentation_du_Wiki|doc]] Lisez la doc
Notepad.png
À noter !
Chaque titre est une ancre par défaut. Son nom est le titre lui-même

Images

Notepad.png
À noter !
Les captures d'écran ne doivent pas dépasser 800px.
Ce que vous écrivez Ce que vous obtenez
[[image:wiki3.png]] Wiki3.png
[[image:wiki3.png|100px]] Wiki3.png
[[image:wiki3.png|right|80px]] Wiki3.png
[[image:wiki3.png|center|100px]] Wiki3.png
[[image:wiki3.png|center|100px|thumb|Legend here]]
Legend here

Signature

Signer une page n'est pas très important étant donné que ces informations sont données dans la partie "Édition", mais il est possible que vous vouliez signer votre page. C'est par exemple très utile dans l'onglet de discussion. C'est aussi un bon moyen de rediriger vers votre propre compte: la page peut être utilisée afin de tester vos pages avant de les publier sur le Wiki.

Ce que vous écrivez Ce que vous obtenez
~~~ lebarhon
~~~~ lebarhon 17:32, 23 June 2014 (UTC)
~~~~~ 17:32, 23 June 2014 (UTC)

Liens utiles

http://fr.wikipedia.org/wiki/Aide:Syntaxe

http://www.mediawiki.org/wiki/Help:Tables/fr

http://www.mediawiki.org/wiki/Help:Images (en)

http://fr.wikipedia.org/wiki/Aide:Tableau

http://fr.wikipedia.org/wiki/Wikip%C3%A9dia:Conventions_de_style

Catégories

Le tag que vous utiliserez le plus souvent est un tag de catégorie:

Syntaxe: [[Category:nom de la catégorie]]

Exemple: [[Category:Documentation]]

Le Wiki est configuré de telle sorte que si vous placez un tag n'importe où sur votre page, un lien vers la page d'accueil de la catégorie Documentation apparaîtra automatiquement au bas de votre page Wiki dans un joli encadré. Votre page apparaît aussi automatiquement dans la page d'accueil de "Documentation". Votre travail s'arrête là. Nous utilisons "Doc" pour les documents internes à l'équipe Doc et "Documentation" pour les documents visant le public, et il y a aussi de nombreuses sous-catégories. Il est préférable d'utiliser "Doc" ou "Documentation" et ajouter d'autres catégories si nécessaire.

Notepad.png
À noter !
Bien qu'il soit possible de placer un tag de Catégories n'importe où, il est préférable de les placer en haut de la page - oui, tout en HAUT de votre page, avec un peu d'espace avant que vous ne commenciez à écrire. C'est important car cela empêche que vos tags ne soient accidentellement supprimés quand le contenu de la page est édité et cela permet de les retrouver facilement si vous écrivez un texte long :).

Utilisez autant de catégories que nécessaire, une liste des catégories peut être trouvée ici.

Comment modifier une page

Généralités

Tout ce dont vous avez à faire c'est de cliquer sur Editer en haut de la page (pour éditer la page entière) ou devant un titre, tout à droite (pour éditer la section désirée seulement). Ce lien vous mènera sur la page d'édition et vous montrera le code du Wiki de la page que vous êtes en train de consulter.

En haut de la page se trouvent des outils de modification basique.
Wiki4.png
Un message d'aide apparaît quand vous passez votre curseur sur l'une des icônes.

En bas de la page se trouve un espace Résumé pour vous afin de commenter les changements. Il est recommandé de remplir cette partie, afin que les contributeurs puissent comprendre facilement ce qui a été modifé dans l'historique de la page.

Vous pouvez aussi spécifier deux options :

  • Modification mineure est à cocher si les changements sont peu importants
  • Suivre cette page vous permet d'être informé par e-mail des modifications de cet article (excepté les modifications mineures).

Et finalement trois boutons :

  • Publier pour sauvegarder votre travail (raccourci clavier : Alt-Shift-S)
  • Prévisualiser pour avoir une idée de ce à quoi ressemblera votre page avant la publication (Alt-Shift-P)
  • Modifications en cours pour voir clairement les différences entre la page d'origine et celle que vous éditez.

Il est fortement recommandé de prévisualiser votre page AVANT de publier les modifications que vous avez faites, afin d'éviter les erreurs.

N'hésitez pas à laisser des commentaires dans l'onglet de Discussion.

Annuler une modification et revenir à un état antérieur

On appelle cela la révocation et doit être utilisée pour écrire un Wiki.

Comment créer une page

1. Soyez sûr que la page que vous voulez créer n'existe pas, ou qu'une page similaire pourrait être simplement complétée.
2. Avertissez la Mailing list (Ml), il est possible qu'une personne travaille déjà sur une page similaire
3. Trouvez un joli titre, voir le paragraphe ci-dessous
4. Connectez-vous au Wiki
5. Écrivez votre titre dans le moteur de recherche du Wiki (key 7 voir cette capture d'écran) and cliquez sur "Rechercher" et acceptez de créer la page en cliquant sur le titre.
6. La nouvelle page est ouverte en mode édition, vous pouvez copier/coller cet exemple dans votre nouvelle page:


{{draft}}

[[Category:Documentation]]

= Présentation =

7. Ajoutez de nouvelles catégories et/ou retirez "Documentation" si nécessaire
8. Veillez à toujours avoir une section "Présentation"/"Introduction" afin d'expliquer ce que votre page va enseigner
9. Voir Comment modifier une page

Nommer les pages et les sections

  • Pensez à donner des noms précis pour faciliter la recherche dans le moteur de recherche
  • Écrivez votre titre avec les espaces habituels entre les mots, (laissez le Wiki s'occuper des " _ ")
  • Do not nest pages in sub-folders, e.g. Topic/FAQ
  • Nommez dans un langage naturel (as opposed to nesting)
  • Utilisez les lettres majuscules seulement pour les initales des titres ou les titres de sections: "Comme Ceci"
    • Exceptions: les noms propres et les titres/chapitres officiels, les guides de documentations qui sont converti en XHTML/XML
    • Exemples: "Rejoignez le projet Foo"; "Configurer une clé USB bootable"; "FAQ sur SELinux"

Comment traduire une page

Aussi longtemps que nous n'avons pas un Wiki multi-langues

Dans ce cas, il n'y a que l'espace anglais [en] qui englobe toutes les langues.

  • Avertissez la Ml (email) afin que l'on sache que vous allez traduire une page Wiki
  • Créer une nouvelle page avec un titre qui sera composé du titre original traduit suivi par -xy. xy qui seront les lettres symboliques de la langue (comme -fr,...),
    • Exemple: Le titre de cette page traduit en italien sera "Come tradurre una voce di Wiki-it", et en allemand "Erstellen einer Wiki Seite-de",
  • Ajoutez un lien dans chaque traduction existante vers votre nouvelle traduction et vice versa. Ces différents noms de langues doivent être écrits dans leur propre langue, ce qui signifie par exemple : English, français, Deutsch, ... Pour les pages anglaises ou françaises, une bannière existe : Multi_language_banner et Bandeau_multi-langues-fr
    Le wiki allemand est à l'adresse : https://wiki.mageia.org/de/ et possède sa propre bannière Vorlage:Mehrsprachen_banner
  • Faites des captures d'écrans aussi ressemblants aux originaux que possible, adaptez le texte si nécessaire,
  • Ajouter la catégorie de la langue si elle existe ( exemple de syntaxe : [[Category:French]] ). Si elle ne l'est pas, posez la question sur la Ml, de même avec les autres catégories.

Astuces et bonnes pratiques

  • Vous pouvez utiliser un site de traduction (par exemple https://www.deepl.com/translator) (disponible gratuitement pour 5000 caractères par mois) en copiant et collant le code source wiki de la page anglaise (accessible en cliquant sur « Modifier »). Cela permet d’avoir en général plus de 80% de la traduction correcte. Mais cela altère parfois des parties qui ne devraient pas être modifiées, comme le nom d’un fichier ou image, et demande donc une relecture plus attentive, notamment pour les parties techniques comme les lignes de commandes. Dans ce cas, il vaut mieux procéder paragraphe par paragraphe.
  • Vous pouvez transformer les onglets en fenêtres indépendantes par clic droit sur l’onglet -> Déplacer vers une nouvelle fenêtre, ce qui est pratique pour lire l’original en même temps que la zone de saisie de la nouvelle page.
  • Le Glossaire-fr permet de trouver une traduction des termes les plus courants. Sinon, s’inspirer de pages déjà traduites, et essayer de garder une cohérence des termes traduits dans la page. En cas de doute sur une terminologie, contacter l’équipe i18n-fr.
  • Pour améliorer la qualité de votre prose, le dictionnaire des synonymes extrêmement pertinent du Crisco à Caen.
  • Grammalecte une extension qui s’intègre à Firefox renforce la qualité de vos textes en apportant des outils de correction grammaticale, orthographique, typographique et de conjugaison de la langue française.

Quand nous aurons le Wiki multi-langues

Cette partie sera écrite après la mise à jour du Wiki lebarhon 12:59, 8 June 2014 (UTC)

Gestion du Wiki

Cette partie sera écrite par un gérant du Wiki lebarhon 13:00, 8 June 2014 (UTC)

  • Comment puis-je archiver une page?
  • Comment puis-je supprimer des images?
  • Comment renommer une page?
  • Concernant l'entretien du Wiki:
    • Conseils sur la façon dont une page a été importée d'ailleurs et comment vérifier sa licence originale
    • À quel moment déplacer ou supprimer une page
    • Que faire avec toutes les pages "Brouillons" (draft en anglais)
    • etc.