NAWAK Consignes pour les contributions

NAWAK : Consignes pour les contributions

par Jean-Christophe

Pour le système de gestion de contenu NAWAK, les pages source doivent respecter certains prérequis afin de contenir les bonnes données au bon endroit. C'est ce qu'explique cette doc.

/!\ Note : Le site de Léa-Linux n'utilise plus NAWAK depuis 2005. Pour y contribuer il faut appliquer les consignes de FAQ contribution.

Comment rédiger vos contributions pour quelles soient publiées le plus vite possible.

Règles de base

Ce paragraphe regroupe les règles à respecter au minimum pour nous soumettre un article.

Composition des fichiers

Les fichiers doivent suivre quelques règles précises afin que la génération du site puisse se faire de façon optimale, car les données présentes dans l'entête sont utilisées lors de la génération du site, ainsi que la façon dont est écrit le plan du fichier (tags <Hn>).

Et s'il vous plaît, essayez de vous relire pour virer le maximum de fautes d'orthographe !

Les fichiers doivent suivre quelques règles précises afin que la génération du site puisse se faire de façon optimale, car les données présentes dans l'entête sont utilisées lors de la génération du site, ainsi que la façon dont est écrit le plan du fichier (tags <Hn>).

Et s'il vous plaît, essayez de vous relire pour virer le maximum de fautes d'orthographe !

Vous trouverez dans les sources (lea-contribution-modele.html) un squelette de document pour une contribution.

HTML

Les articles doivent être écrits en HTML ; essayez de les valider en HTML 4.01 transitional (ou mieux, XHTML) avec http://validator.w3.org/.

Les tags HTML doivent être en minuscules ; ils doivent tous être fermés. Cela signifie qu'un <tag> ouvrant doit avoir un </tag> fermant correspondant, et que les tags simples doivent se terminer par un / : <br /> ou <hr />...

Conventions typographiques

Lignes de commandes, noms de fichiers...)

Les noms de fichiers comme /etc/passwd, et les commandes comme su -c "rm -Rf /tmp/*" doivent être entourés des tags <code> et </code>.

Extraits de fichiers de configuration, listings...

Les fichiers de logs, ou de configuration mis en ligne dans un article doivent être entourés des tags <div class='code'> et </div>. Cela les affiche dans un cadre jaune.

Autres styles de cadres

D'autres classes que code sont également disponibles : Style "aparte" : fonte plus petite, pour des remarques qui ne sont pas en relation directe avec le sujet. Style "note" : pour faire ressortir des remarques. Style "warning" : pour mettre en garde Style "exemple" : ajoute automatiquement "Exemple :" devant le bloc. Style "syntaxe" : ajoute automatiquement "Syntaxe :" devant le bloc.

Styles "en ligne"

Outre le style code (<code>le_code</code>), vous disposez aussi du style warning. Celui-ci s'obtient avec les tags suivants : <span class='warning'>votre avertissement</span>.

Autres

Si vous le pouvez, respectez les conventions suivantes :

Touches : lorsque vous parlez d'une touche, mettez-la en gras, casse fixe et entre crochets : <b>[<tt>la_touche</tt>]</b>. Exemple : [Ctrl]-[Alt]-[F1]. à compléter...

Autres règles

Entête

Tags META

L'entête doit contenir des tags spécifiques, sous la forme de "tags meta" :

<meta name="le_nom" content="la_valeur">

Les tags META

name	content	exemple
Keywords	les mots clef décrivant le site, la page. Les mots de l'exemple suivant sont ajoutés automatiquement aux mots que vous ajoutez éventuellement ici pour décrire votre page.	<meta name="Keywords" content="linux, debutant, newbie, aide, help, install, installation, distribution, slackware, slakware, mandrake, redhat, red hat, debian, suse, corel, 3dfx, voodoo, banshee, rush, tv, bttv, miro, pctv, plug, play, plug and play, module, modules, kernel, noyau, trucs, son, oss, alsa, driver, compiler, compilation, x, x window, x windows, scanner, sane, scsi, glossaire, faq, tutoriel, tutorial, shell, commandes, commande" />
Description	Une description de votre page en quelques mots	<meta name="Description" content="Tutoriel pour compiler le noyau de Linux" />
author	L'auteur de la page. Ce champ se retrouve dans la page générée (en bas à gauche)	<meta name="AUTHOR" content="Jean-Christophe Cardot" />
created	date de création de la page. Ce champ se retrouve dans la page générée (en bas à gauche). Le contenu se construit de la manière suivante : année sur 4 chiffres, suivie du mois sur 2 chiffres, puis le jour sur deux chiffres. Enfin un point virgule et huits chiffres quelconques.	<meta name="CREATED" content="20000124;22230000" />
changedby	La dernière personne a avoir modifié la page, de préférence ses initiales. Ce champ se retrouve dans la page générée (en bas à gauche)	<meta name="CHANGEDBY" content="JCC" />
changed	Date de dernière modification de la page. Ce champ se retrouve dans la page générée (en bas à gauche). Le contenu se construit de la même façon que le champ created.	<meta name="CHANGED" content="20000124;22230000" />
ressources	Le nom du fichier dont le contenu va être inséré dans le cadre "ressources". Si votre page se nomme toto.htm, ce fichier doit se nommer de préférence _ress_toto.htm (optionnel).	<meta name="ressources" content="_ress_contribs.htm" />
merci	Si vous souhaitez faire apparaître des remerciements dans le pied de page, cette variable optionnelle, si elle est définie, y sera copiée.	<meta name="merci" content="Merci à BooK pour ses suggestions." /> ou <meta name="merci" content="Merci à \074A HREF=\042mailto:taz98@altern.org\042\076 Jicé\074/a\076 pour l'aide apportée." />

Dans l'exemple précédent, vous voyez que vous pouvez définir des liens, etc. dans la variable "merci". Il suffit de remplacer les caractères selon la table suivante :
 

remplacer	par
<	\074
>	\076
"	\042

(ce sont les codes ASCII en octal des caractères correspondants)

TITLE

Le tag <title> de l'entête de votre fichier contient le titre, de préférence court (2 ou 3 mots courts maximum), car lors de la génération, il est repris dans plusieurs endroits (page générée, carte du site, première page du site, etc.) où la présentation demande des libellés courts sous peine d'être confuse.

Exemple

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta name="GENERATOR" content="Mozilla/4.61 [en] (X11; I; Linux 2.2.13-7mdk i586) [Netscape]" />
  <meta name="Description" content="Le shell et les commandes Linux" />
  <meta name="KeyWords" content="linux, debutant, newbie, aide, help, install, installation, 3dfx, voodoo, banshee, rush, tv, bttv, miro, pctv, plug, play, plug and play, module, modules, kernel, noyau, trucs, son, oss, alsa, driver, compiler, compilation, x, x window, x windows, scanner, sane, scsi, glossaire, faq, tutoriel, tutorial, shell, commandes, commande" />
  <meta name="Author" content="Jean-Christophe Cardot" />
  <meta name="created" content="19991102;00000000" />
  <meta name="changedby" content="JCC" />
  <meta name="changed" content="20000110;00000000" />
  <meta name="ressources" content="_ress_shell.htm" />
  <meta name="merci" content="Merci à Thierry Stoehr pour ses remarques constructives." />
  <title>Shell et Commandes</title>
</head> 

Corps du fichier

Peu de contraintes dans le corps du fichier, si ce n'est quelques petites règles à respecter :

Le début de la page

Il doit impérativement commencer comme suit :

<body>
<p class="leatitre">Votre titre (assez court s.v.p.)</p>
<p class="leapar">par Votre nom (+ éventuellement un lien vers votre adresse)</p>
<p class="leadesc">Une courte description de votre contribution.</p>
<hr />

Merci de respecter cette contrainte pour nous accélérer le travail de publication. Attention: Certains logiciels (ie: netscape) pas sympas enlèvent les informations class des tags que vous entrez lors de l'édition de vos fichiers ; soyez sympa, avant de nous les envoyer, vérifiez vos débuts de page.

Couleurs par défaut (tag BODY)

Ne mettez aucune couleur par défaut dans votre fichier : la génération s'en charge, et le fichier source doit être le plus simple possible. Ainsi, avant d'envoyer votre page pour publication, vérifiez que le tag BODY est le plus simple possible : <BODY>.

Couleurs des caractères (tag FONT)

A faire :

Les titres commencent impérativement au niveau 2. Ils ne doivent contenir aucune indication : ni de couleur, ni de police, ni de style. En effet, ceci est géré par une feuille de style susceptible de changer n'importe quand sans aucun préavis ;). Une exception toutefois : vous pouvez choisir le style une autre couleur/police au sein d'un titre pour signifier quelque chose de particulier (important, code, etc.); mais n'en abusez pas s.v.p.

A ne pas faire :

Comme nous utilisons des feuilles de style (CSS:Cascading Style Sheet) sur l'ensemble du site, il ne faut préciser aucune couleur : ni de fond, ni de caractère. Soit jamais les tags suivants : <FONT COLOR="#000000"> ou <FONT COLOR="#FFFFFF"> Attention : Certains logiciels de composition de pages web (Netscape composer par exemple) insèrent sans votre consentement ces tags. Vérifiez leur absence en éditant le source, et supprimez les éventuellement, ainsi que le tag </FONT> correspondant.

Cibles pour le plan (tags A NAME)

La génération va créer un plan cliquable de votre fichier en recherchant les paragraphes de style "titre". Afin que lorsqu'un visiteur clique dans le plan il soit dirigé vers le bon titre, faites précéder vos titres d'un tag <a name="cible"></a> (nommé cible ou target dans Netscape composer). Attention de bien mettre un nom différent à chaque fois ! Exemple : <h2><A NAME="introduction"></a>Introduction</h2>

Largeur de la page

Essayez de ne pas faire de pages trop larges : nos visiteurs n'ont pas tous un écran 24 pouces en 1600*1200 !!! :-) Donc, essayez d'afficher votre page dans une fenêtre de Netscape de largeur réduite, et faites en sorte qu'il n'y ait pas d'ascenseur horizontal. Quelques trucs :

1. Essayez de ne pas trop indenter votre texte,
2. Essayez de ne pas utiliser le type formatté (tag <PRE>) ; préférez lui le type casse fixe (tag <tt>).
3. Si vous utilisez quand mâme le type formatté (tag <PRE>), ne faites pas de lignes trop longues.

Ouf !!!

Ben oui je suis ch*** ! ;-) Mais bon, si vous voulez que la publication de vos pages aille vite, autant me faciliter la tâche, non ?

Je suis déjà assez en retard en général, et il vaut mieux que j'écrive de nouvelles pages, plutôt que de corriger les vôtres !

Retour à la page NAWAK

Copyright

© 2000-2003 Jean-Christophe Cardot