Comment bien utiliser ce forum pour la contribution ? [À relire]

Bovino · 07/01/2009, 17h56

Bonjour,

Ce forum est dédié à vos contributions pour la conception Web de manière générale et non un forum technique.

Ce forum est destiné à recevoir vos contributions, sous forme de Question/Réponse (QR) pour les FAQ, ou bien de codes pour les pages Sources ou d'articles pour les pages Cours. Afin de faciliter le travail de l'équipe, qui doit se charger d'intégrer ces QR et sources aux pages correspondantes, il vous est demandé de respecter certaines règles.
Elles ne sont pas bien compliquées, et permettront que tout se passe pour le mieux

Utilisez un préfixe afin de spécifier le langage, la technologie ou le domaine auquel elle se rattache (Ceux-ci sont visible à l'édition d'un nouveau sujet) ;
Utilisez un TAG afin de préciser le type de contribution ([FAQ], [SRC], [Article] ou [Tutoriel], etc.) ;
Formulez correctement le titre de votre sujet afin qu'il soit clair

Enfin si c'est une contribution de type FAQ ou Source,veuillez utiliser le format suivant :

FAQ:

Citation:

Question ? (Version: XXX)
Réponse à la question

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

agrémentée d'un bout de code le cas échéant

Source :
Citation:
Titre
Description de la source

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

Code si besoin est

Petit exemple d'un titre d'un sujet pour une contribution FAQ pour JavaScript :

Citation:

[JavaScript] [FAQ] Titre correctement formulé

Le respect de ces consignes est très important pour le traitement de vos contributions dans de cours délais

Cas particulier des Q/Rs FAQ et Sources

Quand et que poster ?
La première des règles est d'abord de vérifier que ce que vous souhaitez proposer n'est pas déjà présent dans la FAQ ou sur la page Sources.

Plusieurs cas de figure se présentent :

Si votre contribution est complètement absente de nos pages, postez sans crainte vous serez accueilli(e) à bras ouverts (si vous respectez les instructions qui suivent, bien sûr ).
Si jamais vous trouvez une entrée dans la FAQ ou la page source qui correspond à ce que vous souhaitez poster :
- S'il s'agit exactement de la même chose alors désolé, cela ne sert à rien de le reproposer. Vous pouvez toutefois vérifier que la réponse (pour la FAQ) ou le code (pour les sources) déjà publié est correct, afin de nous aider à améliorer la qualité du contenu que nous publions !
- Si vous effectuez la même chose, mais avec une méthode différente, alors ouvrez un post pour proposer votre seconde méthode. La vôtre plaira sans doute plus à certains. Acceptez toutefois en engageant la discussion que votre méthode soit confrontée à celle déjà publiée.

Une fois ces préliminaires effectués, suivez les instructions ci-dessous selon que votre contribution est une QR ou un source.

Poster une QR

Pour une nouvelle QR
Créez un nouveau topic sur le forum. Donnez-lui comme titre le titre de votre QR, éventuellement une version raccourcie si le titre est trop long.
Agrémentez le titre du tag [QR].
Exemple: [QR] Comment remplacer un smiley par une image ?

Votre post doit respecter une certaine structure : tout le texte de votre QR doit être contenu dans des balises [quote]. La citation ainsi créée doit commencer par le titre de votre QR, en couleur bleue.
Le texte en dehors de ces balises doit vous servir pour vos remarques ou précisions éventuelles. Vous devez également y indiquer, en début de post, la section dans laquelle vous pensez classer cette QR.
Si aucune section ne vous semble convenir, vous pouvez en proposer une nouvelle. Cette section sera acceptée ou non, suivant si l'équipe considère qu'elle est amenée à recevoir suffisamment d'autres QR par la suite.
Si du code proposé comme solution à la question n'est pas de vous, c'est également l'endroit où le signaler afin de publier la QR avec les nom(s) d'auteur(s) adéquat(s)

Voici un exemple de post possible pour une QR que vous pourrez retrouver dans la FAQ :

Citation:

Voici une proposition de QR pour remplacer le symbole d'un smiley par l'image correspondante

Section: Divers scripts utiles

Citation:

[QR] Comment remplacer un smiley par une image?

Pour remplacer dans un élément de type p toutes les occurrences de ":-)" par l'image image.jpg, on utilise le code suivant :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

monElement.innerHTML = monElement.innerHTML.replace(/\:\-\)/g, " <img src='image.jpg' />");

Il peut être nécessaire de mettre l'image en cache pour que celle ci s'affiche correctement, en utilisant le code suivant, au chargement de la page :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
Image1 = new Image()
Image1.src = "image.jpg"

Ici incluez d'autres remarques, éventuellement des liens vers des références ou d'autres QR

Si votre code est long ou séparé en plusieurs fichiers, n'hésitez pas à proposer un zip en téléchargement ou, encore mieux, une page Web mettant en œuvre votre code.

Pour une mise à jour de QR
Si vous pensez qu'une QR nécessite une mise à jour, parce qu'elle contient une erreur (orthographique ou technique) ou que vous possédez une autre méthode que ce qui est déjà en ligne, postez un nouveau message dans ce forum.
Votre message doit reprendre le titre de la QR à mettre à jour, avec les tags [QR] et [MAJ].

Vous expliquerez votre méthode ou les corrections à apporter à la QR.
Si vous proposez une nouvelle méthode pour répondre à la question de la QR, une discussion sera éventuellement ouverte au sujet de votre méthode, afin de déterminer si elle doit être intégrée ou non.
Éventuellement, votre premier post pourra être édité pour y inclure la QR complète dans sa nouvelle version, selon la structure définie au paragraphe précédent.

Poster une source

Pour une nouvelle source
Créez un nouveau topic sur le forum. Donnez-lui comme titre le titre de votre source, éventuellement une version raccourcie si le titre est trop long.
Agrémentez le titre du tag [SRC].
Exemple: [SRC] Fonction inArray pour chercher dans un tableau

Tout comme pour une QR, les informations que vous fournissez et qui sont destinées à être publiées doivent apparaître dans une citation.
Vous inclurez comme informations :

Le titre de la source, en bleu comme pour les QR
Le ou les auteurs de la source
La page de l'auteur (facultatif)
URL d'un zip à télécharger (vous pouvez aussi joindre le zip à votre post)
Le code de votre source s'il n'est pas trop conséquent pour être publié
Un ou plusieurs renvois éventuels vers la FAQ
Un descriptif de votre source s'il n'y a qu'un zip joint, des explications devant accompagner votre code sinon
Des remarques complémentaires (problèmes compatibilité avec les navigateurs etc.)

Voici un exemple de post pour une source :

Citation:

Un petit code pour ajouter à l'objet Array une fonction renvoyant true si l'élément passé en paramètre est dans le tableau.

Citation:

Fonction inArray pour chercher dans un tableau

auteur : Olivier_

Pas de zip

Contenu :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
Array.prototype.inArray = function(val) {
   for(var i = 0; i < this.length; i++) {
      if(this[i] == val)
return true;
   }
   return false;
}

Ensuite on peut l'appeler sur n'importe quel tableau.

Remarques : Pas de problème de compatibilité connu

Cet exemple ne montre bien sûr pas tous les cas d'informations possibles, mais j'imagine que les autres ne poseront pas problème

Pour une mise à jour de source
Le processus est identique à celui d'une mise à jour de QR.
Précisez juste les tags [SRC] à la place de [QR], et [MAJ].

Voilà, ce sont là toutes les règles que nous souhaitions que vous respectiez, afin que le travail soit agréable pour tous et que nos ressources grandissent d'autant plus

Ah une dernière chose :
S'il vous plaît, vérifiez ou faites vérifier l'orthographe de vos QR/Sources, cela évitera du travail supplémentaire à l'équipe.
Nous ne demandons pas nécessairement une orthographe parfaite, mais au minimum un français correct dans son style et sa syntaxe !

Outils de la discussion
Afficher une version imprimable Envoyer un lien vers cette page par email