Format des fichiers sur www.linux-france.org

Gilles Lamiral

Mardi 20 août 2002 $Revision: 1.8 $
Format des fichiers sur www.linux-france.org

Vous trouverez la dernière version du présent document à l'adresse:
http://www.linux-france.org/prj/lfoyer/

Les formats des fichiers sont l'objet d'une discussion sur la liste de diffusion mlfo des contributeurs. Voici une proposition qui tente de concilier l'ensemble des points de vues.

1. Obligations

2. Interdictions

3. Recommandations


1. Obligations

Aucune obligation.

2. Interdictions

Aucune interdiction.

3. Recommandations

Lire les règles et conventions de Nat.

Les documents sont lisibles directement en ligne. le format est alors de l'ASCII ou du HTML.

Une version imprimable est disponible par document. (ASCII, HTML, PDF, PostScript). Imprimable signifie que l'impression du document est correcte au format A4 en noir et blanc (pas de ligne tronquée, pas de couleur invisible). Outils: a2ps, ps2pdf, dvi2pdf, sgmltools, tidy, lynx etc.

Les sources sont dans l'un des formats ASCII, SGML (DTD HTML, linuxdoc, DocBook), (La)TeX(Info), troff. Ce qui compte est que les sources restent éditables avec un éditeur quelquonque (du type vi, emacs, notepad) sans trop de difficultés, qu'ils puissent être convertible dans d'autres formats d'édition de façon reversible, même dans 5 ans.

L'usage de préprocesseur peut s'avérer utile. Utiliser ceux qui sont rapides, libres, multi-plateformes, stables, simples (exemple: m4).

Donner le mode d'emploi pour regénérer votre documentation avec des exemples concrets, les liens vers les outils utilisés ou le moyen de les trouver.

Avoir en tête que certains contributeurs travaillent avec du vieux matériel (Intel 386, sparc, vic20), ne peuvent pas toujours utiliser vos outils, ou ne veulent pas les utiliser.

Avoir en tête que votre document peut être traduit, lu n'importe où, n'importe quand, par n'importe qui. (Inclure date, provenance, clarté).