WordPress.org

Codex

fr:Codex:Introduction

Page d'accueil du Codex en français - Télécharger WordPress en français
Les utilisateurs francophones se retrouvent sur le site WordPress-Francophone, notamment sur son forum d'entraide.

Contents

Bienvenue !

L'objectif de cette page est de récapituler les bonnes méthodes pour les éditeurs et les volontaires du Codex. Si vous avez des idées pour l'améliorer, envoyez un message via la liste de diffusion de la Documentation de WordPress (anglais).

Règles Générales

  1. Ecrivez WordPress correctement avec la bonne casse. WordPress
  2. Soyez agréable - Pas d'attaque personnelle ou de comportement violent. Restez professionnel, poli et patient.
  3. Diffusez l'information à bon escient, vite et régulièrement.
  4. Modifiez sans état d'âme.
  5. En cas de doute, DEMANDEZ.
  6. Amusez-vous. :)

Méthodes standards

Nouvelles pages

Les nouveaux articles et les nouvelles pages sont les bienvenu(e)s. Cependant, il y a une procédure à suivre :

Consignes pour les nouvelles contributions au Codex :

  1. Si vous écrivez un article ressemblant à un article existant, améliorez la page existante.
  2. Utiliser le bac à sable pour les exercices de mise en forme.
  3. Ajoutez un lien entre un article existant et le votre pour développer les connexions entre les pages. Ne créez pas de page "cul-de-sac"; ce sont des pages sans lien vers d'autres pages du Codex.
  4. Une fois les pages créées, elle sont actives et les liens pointant vers elle fonctionneront. Si les utilisateurs tombent sur une page vide, ils ont perdu leur temps. Créez les pages seulement quand vous avez un contenu suffisamment complet pour les remplir.
  5. Une fois votre page completée et déplacée de vos pages personnelles à la documentation, les liens doivent être placés dans une rubrique de la table des matières et dans les autres documents en relation avec la nouvelle page. Demandez conseil si vous n'êtes pas sur de l'endroit où placer un lien dans la table des matières. Ne placez pas de liens sur la page Main_Page (en anglais) sans la permission de l'équipe de documentation (en anglais).

Utilisez les raccourcis suivants pour classer l'article en fonction de son état :

{{Stub}} 
La catégorie Stub désigne une page incomplète qu'il faut éditer et étendre.
{{Draft}} 
A placer en début de page. Toutes les pages ajoutées sont indexées par des moteurs de recherche. L'indicateur Draft (brouillon) en début de page avertira les utilisateurs qu'il s'agit d'un travail inachevé en cours de réalisation, et que les informations peuvent ne pas être correctes. Cela permet aussi d'avertir les autres de ne pas éditer cette page tant que vous n'avez pas fini de travailler dessus.
[[Category:New page created]] 
Permet de définir la page comme nouvelle et d'attirer l'attention des éditeurs. Ne l'utilisez que lorsque vous êtes prêt à ce que le contenu soit modifié et/ou que la page soit déplacée dans la documentation générale depuis votre page personnelle.
{{Copyedit}} 
Copyedit permet de marquer les articles qui ont besoin d'être retravaillés. Ces articles sont assez complets mais ont besoin d'être repris. Utilisez {{Stub}} pour les articles incomplets.

Titres

Les titres des nouvelles pages doivent commencer par des Majuscules à Chaque Mot.

Tous les titres de section doivent être mis en forme de la sorte. Par exemple, utiliser "Utilisez le Gestionnaire de Liens" plutôt que "Utilisez le gestionnaire de lien". Ce sont des titres complets. Ne pas utiliser "IntroAuxBlogs" mais "Introduction aux Blogs".

Les titres doivent suivre également les règles de Dr. Grammar concernant la mise en majuscules : "Dans les titres, mettre en majuscule la première lettre du premier mot, du dernier et tous les autres mots à l'exception des articles (un, le,...), les préposition de moins de 5 lettres et les conjonctions de coordination. Cette règle s'applique aux titres longs et courts aussi bien pour vos travaux partiels que pour vos publications" (Anson, Schwegler, and Muth. the Longman Writer's Companion 240)

  1. Les titres doivent autant que possible être orientés vers des actions ou des tâches. Ainsi "Utiliser le Gestionnaire de Liens" est préférable à "Le Gestionnaire de Liens". Quels mots-clés seront utilisés lors de la recherche de cette information ?
  2. Les titres ne doivent pas contenir d'espaces inutiles que ce soit en début, en fin ou entre les mots. Essayez aussi d'éviter les symboles tels que "-", "#", "?" et "+".
  3. On préfèrera les titres courts.
  4. Merci d'éviter autant que possible les prépositions dans les titres.
  5. En cas de doute concernant la convenance d'un nom, envoyez un mail sur liste de diffusion wp-docs pour une suggestion.
  6. N'utilisez pas la syntaxe CamelCase pour les titres des pages : Le Codex n'utilise pas le Camel Case comme le font certains wiki. Toutes les pages et par conséquent tous les liens doivent utilisez la syntaxe normale des titres. Par exemple, la page anglaise concernant le Codex porte le titre "About Codex", avec comme lien : [[About Codex]] et non pas la syntaxe CamelCase [[AboutCodex]].

Sous-pages

Ne créez pas d'autres sous-pages, que celles sous votre page utilisateur sans en discuter avant sur la liste de discussion wp-docs. Exemple : Vous pouvez créer la sous-page : User:votre user/Page_Exemple par contre ne créez pas de sous-page Main_Page/Page_Exemple.

Discussions

Utilisez les pages de "Discussion"

Vous avez remarqué quelque chose qui vous semble incorrect ou nécessitant une clarification ? La meilleur façon d'en faire mention est d'utiliser la fonction DISCUSSION. Abstenez-vous svp d'ajouter vos commentaires directement dans l'ARTICLE. Il y a au sommet de chaque page un onglet DISCUSSION. C'est l'endroit prévu pour faire vos commentaires, suggestions ou autres. Merci !

  1. Laisser un message à propos d'un article : Pour laisser un message en rapport avec un article, cliquez sur l'onglet Discussion de l'article et déposez votre message en le signant.
  2. Laisser un message pour un utilisateur: Laissez un message à un utilisateur en modifiant la page User:Talk de l'utilisateur. N'oubliez pas de signer vos commentaires. L'utilisateur recevra un signal visuel à sa prochaine connexion au Codex.
  3. Séparer les commentaires : Merci de placer une ligne horizontale entre chaque commentaire sur les pages de discussion en utilisant 4 tirets ----. Si vous débutez un nouveau sujet de conversation, utilisez le lien "+" à côté du lien "éditer", afin de créer une nouvelle section.
  4. Signez toujours vos commentaires : Pour ajouter votre signature à un commentaire, ajouter quatre ~ (tildes) à la fin de votre commentaire. Ce raccourci permet d'afficher votre nom avec un lien vers votre page utilisateur et d'ajouter l'horodatage de votre commentaire. C'est très pratique dans les pages de discussion. Une méthode alternative consiste à cliquer sur le bouton signature au dessus de la fenêtre d'édition : c'est le deuxième en partant de la droite.

Codex : Intonation, Style et Public

La "voix" du Codex fait autorité, mais c'est aussi une voix de conversation amicale. Le style du Codex doit être instructif en fournissant des explications aussi simples que possible et des conseils techniques au besoin.

En général, les articles s'adressent au lecteur, en le prenant dans le processus. Le pronom "Je" est à éviter, preférrant l'utilisation de formules comme "vous cliquez ici" et "vous ouvrez le fichier modèle". Il ne s'agit pas de l'histoire de ce que vous avez fait ou des personnes qui vous ont aidés. Il s'agit d'apporter aux utilisateurs les informations nécessaires à la mise en place et au fonctionnement rapide de leur blog WordPress.

Les listes à puces et numérotés doivent être utilisées pour mettre en avant les étapes importantes d'un processus. Les taches compliquées sont découpées en petites étapes, guidant novices et experts rapidement à la solution.

Tous n'ont pas les mêmes capacités et connaissances en HTML, XHTML, CSS, et PHP. Les Articles des sections Advanced Topics (en anglais) et Developer Documentation (en anglais) sont destinés aux utilisateurs expérimentés. WordPress Lessons (en anglais) sont faites pour les débutants, utilisant le vocabulaire d'un volontaire de support technique assis à côté de l'utilisateur, et le guidant pas à pas. Le reste du Codex est destiné aux utilisateurs entre le niveau débutant et intermédiaire et doit être écrit en langage simple avec les liens nécessaires au Glossaire (en anglais).

Conventions

  1. Exemples de noms de site: Toujours utiliser example.com, example.org ou example.net lorsque vous avez besoin d'énoncer un domaine comme exemple. C'est la norme RFC2606
  2. Admin: Pour dénommer un administrateur de manière générale utilisez admin
  3. Utiliser des noms de personnes en exemple: Pour dénommer un utilisateur non-administrateur ou une personne, utilisez "Jean" comme prénom, "Dupont" comme nom.
  4. Casse de WordPress: WordPress s'écrit avec DEUX Majuscules: WordPress.

Pages connexes

Retour Page d'accueil