EagleFaq:NormesFormatage

[ NormesFormatage ] [ In English? ] [ Es En Espanol ] [ De Deutsch ]

Normes de formatage des rubriques FAQ

Cette page présente le format standard d'une Faq, à respecter pour l'ajout de questions / réponses, consulter ReglesDeFormatage pour les formats disponibles dans wikini

en haut ce qui est retenu
au milieu comment c'est utilisé par la suite
en bas les critiques des essais

Ce qui est retenu

Un séparateur au dessus (---- dans le source)
Un "changelog" reprenant soit la référence (n°) de la question dans la FAQ actuelle, soit une nouvelle référence (à partir de 100...) si nouvelle question, la teneur de l'action (new, modif, trad, obso, ...), date (format YYYYMMDD), auteur
quatre signes "=" de chaque côté de la question

Exemple:

[12 modif 20031030 BenoitAudouard] si modif, [101 new 20031030 BenoitAudouard] si nouvelle, ou [15] si pas modifiée... voire on peut tracer les obsolètes...

Les questions sont de ce format

Passer une ligne entre la question et la réponse ainsi qu'à la fin d'une réponse... c'est plus aéré.
Vous pouvez mettre du texte en gras (deux étoiles de chaque côté) pour le faire ressortir, sans trop en abuser.
Pour les paths comme /usr/local/sbin ou les commandes comme startadsl le même format est retenu pour faire simple (deux dièses de chaque côté).
Les liens internet s'écrivent tel quel http://eagle-usb.fr.st, du fait qu'ils sont reconnus par cette version de wikini

[20031030] Je pense que les liens peuvent suivre les normes de formatage "normal" de la syntaxe wiki [[http://le.lien.org/mondoc.html ici le texte du lien]], ca ne pose pas de probleme vu de toute façon, le minimum de filtrage peut suppirmer tout ca facilement. -- FrankJ

Comment c'est utilisé par la suite

le wikini fournit directement du html
les codes de contrôle après un minimum de filtrage peuvent être supprimés facilement pour un mode texte
la structure imposée permet d'avoir une organisation cohérente du document
les liens en haut permettent
. au traducteur de comparer avec la page dans sa langue
. à l'utilisateur de vérifier une page dans une autre langue qui serait plus à jour
. le même nom de page est à conserver pour s'y retrouver...

[20031030] Je pense que pour l'utilisation ultérieure en vue de produire des documents de format différent (HTML, texte brute, ...), le mieux est de passer par le format DocBook. C'est le format qui s'impose dans le monde du libre au niveau des documentations (LDP,....) mais surtout, il permet de produire toute sorte de format à partir du seul source DocBook. Je suis en train d'étudier le problème de convertir en DocBook les Faq de ce wiki automatiquement, ca pourrait résoudre pas mal de problème. -- FrankJ

Critiques des essais

Les questions sont peut-être écrites un peu gros:
voir si

Quatre "égal" c'est bien : c'est du h3 en html

Trois suffiraient : c'est du h4 en html

C'est l'énormité de mes titres avec 5 "égal" dans cette page qui m'y font penser... c'est du h2 en html, la taille dépend beaucoup de l'explorateur utilisé j'ai l'impression -- BenoitAudouard 20031028

Récap formatage d'un path:

Exemple d'un path /usr/local/sbin en interprété wiki -> Exemple d'un path **/usr/local/sbin** source
-> Bien en wiki, pas trop mal en texte -- FrankJ

Exemple d'un path /usr/local/sbin en interprété wiki -> Exemple d'un path __/usr/local/sbin__ source
-> Bof en wiki, nul en texte -- FrankJ

Exemple d'un path /usr/local/sbin en interprété wiki -> Exemple d'un path ///usr/local/sbin// source
-> pas mal en wiki, nul en texte -- FrankJ

Exemple d'un path "/usr/local/sbin" en interprété wiki -> Exemple d'un path "/usr/local/sbin" source
-> bof en wiki, bof en texte -- FrankJ

Exemple d'un path /usr/local/sbin en interprété wiki -> Exemple d'un path /usr/local/sbin source
-> pas super lisible en wiki, pas super lisible en texte (surtout dans les paragraphes) --FrankJ

Exemple d'un path '/usr/local/sbin' en interprété wiki -> Exemple d'un path '/usr/local/sbin' source
-> a la rigueur en wiki, pas trop mal en texte -- FrankJ

Récap formatage d'une commande:

Exemple d'une commande adictrl -i en interprété wiki -> Exemple d'une commande ##adictrl -i## source
-> pas mal en wiki, enlever les dièses en texte... -- BenoitAudouard

Exemple d'une commande adictrl -i en interprété wiki -> Exemple d'une commande **adictrl -i** source
-> Bien en wiki, nul en texte -- FrankJ

Exemple d'une commande adictrl -i en interprété wiki -> Exemple d'une commande __adictrl -i__ source
-> Bof en wiki, nul en texte -- FrankJ

Exemple d'une commande adictrl -i en interprété wiki -> Exemple d'une commande //adictrl -i// source
-> pas mal en wiki, nul en texte -- FrankJ

Exemple d'une commande "adictrl -i" en interprété wiki -> Exemple d'une commande "adictrl -i" source
-> mouaip en wiki, mouaip en texte -- FrankJ

Exemple d'une commande adictrl -i en interprété wiki -> Exemple d'une commande adictrl -i source
-> pas super lisible en wiki, pas super lisible en texte (surtout dans les paragraphes) --FrankJ

Exemple d'une commande 'adictrl -i' en interprété wiki -> Exemple d'une commande 'adictrl -i' source
-> pas trop en wiki, pas trop mal en texte -- FrankJ

??pour voir si d'autres trucs marchent?? (ah ben les points d'interrogation : non) aller dans le BacASable