Planète 4D's GuideLines
ou
Les Règles à (essayer de) suivre lors de la rédaction des articles
version 2.1 - le comité de rédaction - 30/03/2001
NOTE IMPORTANTE - Janvier 2005
Ces "guidelines" vont être modifiées à partir du numéro 10 de Planète 4D. L'esprit restera bien entendu le même : Planète 4D est un magazine pédagogique, nous préférons que les articles expliquent et détaillent tel ou tel aspect de la programmation et souhaitons éviter la publication de code "pour le code".
Afin de faciliter la mise en page, des styles utilisables avec Word® ou certains de ses clones sont fournis (pour les encadrés, les légendes d'illustration, le corps de l'article, le code 4D, etc.).
Enfin, le passage sur les conditions financières est obsolète et doit être revu
|
Préambule
Ces règles ne doivent en aucun cas être considérées comme des carcans limitant votre ingéniosité. Il s'agit juste d'obtenir une certaine homogénéité.
Avant de vous lancer dans la rédaction d'un article, contactez un membre du comité de rédaction (par mail ou par téléphone), vous éviterez ainsi de travailler sur un sujet déjà en cours de traitement.
A/ Format de fichiers des articles et des copies d'écran
B/ Le code 4D
C/ Le texte de l'article
D/ La base exemple
E/ "L'Esprit rédactionnel"
F/ Conditions juridico-financières
A/ Format de fichiers des articles et copies d'écran
Vous enverrez, si possible, des fichiers au format RTF, sinon du Word. Ils seront compactés en .sit ou .zip.
Les images doivent être incluses dans l'article, mais aussi enregistrées dans des fichiers séparés afin d'être importées dans la mise en page dans XPress. Vous éviterez donc de copier-coller directement dans Word. Le format PICT ou BMP en RVB est le seul accepté. Ne mettez pas de suffixe aux images. Haut page
B/ Le code 4D
C'est sur cette partie qu'il est surtout souhaitable d'avoir une certaine homogénéité formelle.
1/ Le "plan" du code d'une méthode est le suivant:
Commentaires généraux: Nom de la méthode, ce qu'elle fait ou ne fait pas, ...
Déclaration/Typage des locales: Brève explication (sauf pour les évidentes, genre $i)
Code de la méthode
2/ Chaque ligne doit être commentée.
Les commentaires sont placés au-dessus de la ligne de code commentée, pas à côté (pour limiter la largeur à cause de la mise en page), même si le commentaire est très bref:
Écrire ceci...
` duplication des ressources
BLOB VERS DOCUMENT($2;$toutesLesRessources;*)
... au lieu de cela:
BLOB VERS DOCUMENT($2;$toutesLesRessources;*) ` duplication des ressources
Bien sûr, la règle du "chaque ligne" est à moduler. Il faut au minimum commenter les lignes importantes, qui constituent le cur du code, même si elles sont détaillées dans le texte de l'article.
Si une ligne, à elle seule, nécessite beaucoup d'explications, elle sera sans doute détaillée dans l'article et son commentaire sera probablement un simple résumé du pourquoi du comment.
3/ Seul le code "important" est inclus dans l'article
Les méthodes utilitaires "usuelles" (ie: caractère séparateur selon la plateforme, booléen du genre isMacOS, ...) n'ont pas besoin de voir leur code listé dans le cur de l'article. Une simple ligne de commentaire rappelant leur fonction suffit.
Selon les cas, nous publierons le code intégral de l'article en annexe ; ces méthodes y apparaîtront alors.
4/ Le code est dans le style usuel "standard" de 4D:
Il faut donc bien mettre les gras (commandes 4D), italiques (méthodes), soulignés (constantes), ou mixtes (plug-in).
"Standard" de 4D, c'est-à-dire noir et blanc, Geneva 9 (Mac OS) et XXXXX (Windows).
Haut page
C/ Le texte de l'article
L'article lui-même sera saisi dans le style prévu à cet effet
Les "objets" 4D qui apparaissent dans l'article seront facilement identifiables car ils reprendront le style du code 4D lui-même:
- Tables: [Table]
- Commandes : Gras majuscules
- Fonctions: Gras minuscules
- Barres de menus et menus: Gras.
- Méthodes (toutes catégories): Italiques
- Champs: [Table]Champ
- Variables: Geneva 9/xxxx du code. Ou, carrément, du Monaco ?
L'important est de mettre en relief les objets en essayant de mettre le moins de guillemets possibles
Prenez le temps de vérifier votre orthographe, et/ou d'utiliser un correcteur orthographique/grammatical. Ne vous tracassez pas trop en revanche pour les formulations et autres tournures de phrases. Tous les articles sont lus, relus, et corrigés (et vous en resterez bien sûr le signataire). Votre "parrain" du comité de rédaction vous aidera si besoin pour la rédaction, sur le plan technique et/ou sur le plan rédactionnel pur. Perdre du temps sur l'orthographe est toujours un peu pénible. Haut page
D/ La base exemple
A priori, chaque article sera accompagné d'une base de test, qui sera placée sur le ftp de planete4d et librement téléchargeable. La base de test sera écrite en version 2003 de 4D.
"A priori" parce que certains articles courts n'ont pas besoin d'être accompagnés de base d'exemple. Pour les articles plus complets il faut une base de test pour les lecteurs. Cette base est réalisée par le rédacteur de l'article.
Le code fourni dans l'article est au minimum celui trouvé dans la base d'exemple. "Au minimum" parce que dans la base de test, les méthodes utilitaires dont on a parlé plus haut seront complètes... et commentées ! :-)
Haut page
E/ "L'Esprit rédactionnel"
Rester cool, sans en rajouter.
Bien réfléchir au public visé: du débutant complet au vieux routard de 4D. Dans tous les cas, ne pas hésiter à s'aider de copies d'écrans, de schémas, dessins et autres supports.
Penser à respecter le lecteur et les opinions contraires (par exemple, éviter de dire que "Faire comme ci est idiot et complètement nul, il faut faire comme ça"). Un mot encore : même si vous avez passé du temps (ce qui est probable...) à rédiger votre article, ne vous offusquez surtout pas des remarques que nous serons amenés à faire. Il est rare qu'un article soit parfait du premier coup, il faut souvent y revenir 2-3 fois. On peut trouver quelques passages trop (ou pas assez) longs, pas assez (ou trop) expliqués pour le public visé, ... Haut page
F/ Conditions juridico-financières
Tarifs
Pour le numéro 1, 1000 FF pour 20 000 signes* publiés.
Pour le numéro 2, 1100 FF.
Depuis le numéro 3, 1200 FF.
(*) les signes (code compris) sont comptés dans BBEdit®
Cette tarification va être modifiée, c'est pourquoi elle est barrée
Planète 4D n'est pas encore en mesure d'indémniser les rédacteurs.
Statut du rédacteur
Paiement en AGESSA (droits d'auteur) pour les personnes sans carte de presse.
Délais de paiement
Le paiement se fait lors de la publication. On peut envisager de verser un accompte ou de payer lorsque l'article est considéré comme terminé, si le rédacteur le souhaite.
Clauses de propriété
Pendant 3 ans, l'auteur ne peut pas proposer le même article à une autre publication sans l'autorisation de l'éditeur de Planète 4D. Cela ne l'empêche pas de traiter le même sujet, d'une autre manière. Pendant 3 ans, l'éditeur de Planète 4D peut librement publier l'article, en français ou en d'autres langues, sur support papier, sur Internet, CD-ROM et DVD ou tout support de son choix. Haut page
Document mis à jour 7 février 2005
|