Mongueurs de Perl :: Articles :: Rédiger un article

Après nous avoir rejoint, vous êtes invité à rédiger des articles sur Perl ; vous serez aidé par les membres du groupe de travail Articles.

Choisir un sujet

Tout sujet concernant de près ou de loin Perl est le bienvenu ; GNU/Linux Magazine France (GLMF) est un magazine très technique et il ne faut pas avoir peur de traiter un sujet pointu. Le but est de montrer tous les aspects de Perl, sa puissance, sa facilité d'emploi et la richesse de ses bibliothèques : pourquoi n'écririez-vous pas un article sur le dernier module que vous venez de découvrir avec plaisir ou sur celui que vous manipulez depuis plusieurs années ? Si un sujet vous intéresse, c'est qu'il peut intéresser les lecteurs et donc faire l'objet d'un article.

Le site de Diamond Éditions propose un moteur de recherche indexant les articles parus dans GLMF et Linux Pratique. Bien pratique pour ne pas refaire un article déjà paru.

Consultez aussi le programme de publication des articles en cours, qui contient une liste d'idées d'articles à écrire. Vous êtes invité à vous déclarer auprès du coordinateur pour cela ; il fera en sorte de vous octroyer une place dans le dépôt (un nom de fichier).

Le format

Le schéma des articles envoyés à GLMF est le suivant :

un titre (avec le mot Perl dedans, car nous, Mongueurs, savons qu'il s'agit de Perl, mais pas forcément le lecteur !),
un éventuel sous-titre,
le chapeau : deux à trois phrases de présentation de l'article (ces phrases seront mises en grosse police en dessous du titre), c'est là qu'il faut donner envire de lire au lecteur de GLMF,
le corps de l'article, structuré en parties et sous-parties,
une conclusion,
un cartouche sur l'auteur et son appartenance aux Mongueurs de Perl.

N'hésitez pas à jeter un œil à un GLMF à l'occasion...

Le format des fichiers est plutôt à la discrétion de l'auteur, sachant que le format cible pour GLMF est le HTML, en encodage iso-8859-1. Oubliez les encodages iso-8859-15 (supportant l'euro et certaines ligatures comme le oe) et UTF-8. Les formats propriétaires (.doc etc) ne sont pas les bienvenus ... Pour des raisons de facilité de relecture, nous préférons très largement les formats de fichier à base de texte : POD, HTML (propre SVP), XML/DocBook, TeX / LaTeX, etc, voire texte brut. Dans tous les cas, les caractères accentués (éèêà) doivent être lisibles facilement par un humain (pas de é et autres en HTML). Les espaces insécables ( ) sont par contre nécessaires (en francais, ils précèdent les doubles ponctuations comme « : » ).

Les articles peuvent contenir des images : elles peuvent permettre d'illustrer une explication, de rendre la lecture plus agréable, etc. Les fichiers des images doivent être placés dans un répertoire de même nom que l'article (privé de son extension). Pour les schémas, l'auteur de l'article place le fichier source de l'image (par exemple format xfig, sketch) ainsi qu'une sortie vectorielle en EPS (Encapsuled PostScript) ; pour publication sur le web, prévoyez une version bitmap de type JPEG ou PNG (les GIF sont exclues). Pour une capture d'écran, seule la version bitmap est a priori envisageable. Notez que le format JPEG est plus adapté pour les photographies, tandis que les formats indexés comme PNG sont plus adaptés pour les copies d'écran.

Pour ce qui est de la longueur de l'article, GLMF est assez ouvert. Disons que le bon nombre de page dans le magazine se situe entre 3 et 10. GLMF compte (et rémunère) selon le nombre de caractères imprimables, c'est-à-dire tous les caractères sauf les espacements (blancs, retour à la ligne etc) : sont donc pris en compte les mots, la ponctuation et le code. Utilisez la commande bin/authors.pl pour connaître la taille de votre article. Pour abréger, on parle souvent de kc (comme "kilo-caractères"), 12 kc étant donc 12 000 caractères imprimables. Une page dans GLMF fait entre 3 et 4 kc.

En pratique, la longueur dépend déjà du type d'article :

les brèves font en moyenne moins de 2 kc
les perles font en moyenne moins de 6 kc
les comptes-rendus de conférences font en moyenne 12 kc
les articles techniques peuvent aller jusqu'à environ 30 kc

Rédaction en pod

POD (Plain Old Documentation) est le format préféré pour la rédaction d'articles (voir perlpod(1) pour plus de détails sur le format). Les articles en HTML sont générés à partir du source POD. Voici quelques indications :

Attention à ne pas laisser de ligne blanche avant la première directive pod, car Pod::POM semble alors ignorer celle-ci.
La coloration de code s'active en encadrant un bloc verbatim entre =begin filter et =end filter. Les filtres disponibles sont : perl, html, shell, kate (moteur générique mais pas totalement stable, passer le format en option).
Les directives =meta foo bar permettent de donner des informations associées à l'article. La principale est title, qui contient le titre de l'article.
N'oubliez pas S<> pour les espaces insécables.

Conseil de formatage (Pod ou autre)

Des lignes irrégulières ne facilitent pas la relecture. Il est plus agréable que le gris typographique du source soit proche du résultat final. Aussi est-il préférable que la longueur des lignes varie peu. On peut par exemple indiquer à certains éditeurs textuels comme vim ou emacs de couper automatiquement à 80 colonnes (ou 72, 76 peu importe).

vim -c 'set textwidth=80' (ou ajouter set textwidth=80 à votre fichier .vimrc)
auto-fill-mode sous emacs.

Outils disponibles

Deux outils sont disponibles dans le fichier bin/aliases. Il s'agit d'un alias et d'une fonction bash : taille, qui calcule la taille des fichiers selon l'algorithme cité ci-dessus et headline, qui renvoie le plan (niveau 1 et 2) d'un article écrit en POD.

Envoi à GLMF

En ce qui concerne la rémunération, la publication de ces articles est bien-sûr payée par GLMF. Nous touchons des droits d'auteur (ce qui ne rentre pas en conflit avec les contrats de travail classiques et ne pose pas de problème quant au cumul de contrats). Le tarif exact pratiqué par GLMF pourra être indiqué par mail à tout membre du groupe de travail (comptez entre 200 et 800 euros par article selon sa taille).

Le coordinateur se charge de faire l'interface entre les auteurs et la rédaction de GLMF. Lorsqu'un article sera prêt à être envoyé, les auteurs devront communiquer au coordinateur leur prénom, nom, adresse postale complète et numéro de sécurité sociale (informations nécessaires pour établir la note de droits d'auteurs). Le coordinateur se chargera d'envoyer l'article au format HTML accompagné de ces informations à la rédaction de GLMF. L'auteur recevra sous 2 à 3 mois un contrat de transfert de droits à retourner signé, il recevera ensuite son chèque (en euros exclusivement).

Il n'y a pas de problème pour écrire des articles à plusieurs auteurs. Il faudra juste indiquer au coordinateur le pourcentage de travail de chacun. Les auteurs devront donc se mettre d'accord et me transmettre un pourcentage pour chacun d'eux : 50/50% 30/70% etc. Tout est envisageable pour GLMF : ils font le détail, ils envoient deux décharges de droits. Et deux chèques.

Le cas des Perles

Les perles de Mongueurs sont une rubrique mensuelle dans Linux Magazine. Elles sont gérées comme les articles.

Lors de la création de la Perle pour publication, le coordinateur des Perles (Philippe Bruhat) va sélectionner quelques Perles parmis les "publiables" et construire le fichier pod associé. Celui-ci pourra alors être relu avant envoi à GLMF.

Au niveau de la rétribution des Perles, le modus operandi est que c'est l'auteur/rédacteur de la perle qui est rétribué. Autrement dit, si vous envoyez une idée de Perle ou un bout de code intéressant à perles@mongueurs.net et que cette idée est reprise, augmentée et complétée pour faire une Perle, c'est l'auteur de ce travail qui est payé. Si vous rédigez une Perle, c'est vous qui êtes payé.