Participation à la rédaction
Je tiens à remercier ici Linux-France, et en particulier Nat Makarevitch, pour le soutient et l'hébergement de cette documentation.
Participation à la rédaction
Si vous souhaitez participer à la rédaction de cette documentation, bienvenue ! Comme vous l'avez certainement constaté, beaucoup de travail reste à accomplir... Nous avons également grand besoin de relecteurs, pour corriger l'orthographe et la grammaire, mais aussi pour vérifier la justesse et la clarté de ce qui est fait.
Vous pouvez me contacter à l'adresse : kafka.fr@linux-france.org.
Si vous voulez écrire quelques parties, merci de lire et respecter les contraintes qui suivent. Indiquez-moi également si vous voulez garder l'anonymat, ou si vous accepter que vos noms, e-mail et page web apparaissent dans la documentation.
N'oubliez pas que cette documentation est destinée avant tout aux débutants complets : il est parfois inutile de donner trop de détails techniques. En particulier, prenez soin de bien définir tous les mots techniques que vous utilisez ! Si vous estimez qu'un mot « mérite » de figurer dans le Glossaire en fin de doc, faites-le moi savoir (en proposant une définition aussi courte et précise que possible).
Lorsque vous introduisez un terme technique nouveau, mettez-le en italique, pour qu'il frappe davantage.
Utilisez de préférence des termes français, mais n'hésitez pas à donner une traduction anglaise du terme. Ceci vaut également si vous pensez qu'il est préférable d'utiliser le terme anglais. Les traductions devraient être placées en note de bas de page.
Cette documentation devrait être organisée comme un cour : prenez donc soin d'avoir une progression dans la difficulté, structurez votre « production » de manière didactique et pédagogique. L'actuelle Table des Matières peut être remodelée, si vous pensez que c'est nécessaire !
N'hésitez pas à inclure des références à d'autres parties de la documentation. Notez alors clairement le numéro de la section référencée, ainsi que son titre, pour que je m'y retrouve facilement.
Si vous utilisez un format de fichier avec mise en forme (voir plus bas), respectez les contraintes suivantes :
Format de fichier : j'utilise l'éditeur LyX (http://www.lyx.org) pour écrire la documentation, je préfère donc les fichiers au format LyX... Mais je peux également me débrouiller avec les formats LaTeX, HTML, RTF, StarOffice 5 (sans dessins !), ou texte brut si c'est vraiment nécessaire.
Pour les utilisateurs de LyX ou LaTeX : la classe de document utilisée est « book ». Par ailleurs, lorsque vous souhaitez utiliser des guillemets, utilisez les guillemets en chevrons (« et ») plutôt que les guillemets anglais ('') (menu Layout/Quotes dans LyX). Les tableaux et figures explicatifs (et non pas simplement illustratifs) auxquels il pourrait être fait référence, devraient être intégrés dans des « table floats » et « figures float », avec une légende (pour apparaître dans la Liste des Figures et la Liste des Tableaux).
Images et graphiques : j'utilise XFig, donc je préfère ce format. Les images sont intégrées en tant que PostScript, mais cela prend beaucoup plus de place... Si vous voulez inclure une image, j'accepte tout format reconnu par Gimp 1.0. Mais prévenez-moi à l'avance pour tout transfert de plus de 500Ko !
Indiquez clairement dans votre fichier le numéro de la section concernée, avec son titre.
Lorsque vous considéré qu'une section est terminée, faites suivre son titre par vos initiales entre crochets ('[' et ']'). Si par contre une section est commencée, mais pas encore terminée, faites suivre le titre par vos initiales entre dièses ('#').