Forum Programmation.autre Écriture de documentation informatique en LaTeX

Posté par  .
Étiquettes :
2
7
août
2011

Bonjour,

Je débute en LaTeX, avec lequel je souhaite rédiger de la documentation informatique, plutôt orientée administration système et réseaux. J'ai du mal à trouver des packages adaptés car accoler du vocabulaire informatique au mot « LaTeX » dans google produit des résultats inintéressants, et CTAN propose surtout des choses pour le développement et l'informatique théorique.

Je cherche des macros du même genre que \url pour pouvoir entrer des noms de programmes, de commandes, des noms de domaines, des adresses IP, des sessions shell, etc. Pour pouvoir afficher un fichier de configuration, j'ai trouvé \verbatimtab, mais on ne peut pas y utiliser \emph et autres. Pourriez-vous me fait part des packages et astuces que vous utilisez, et d'éventuels tutoriaux sur le sujet ?

PS : existe-t-il une macro, servant à entrer une ligne de commande du shell, qui saurait automatiquement ajouter des backslashes en fin de ligne et mettre un prompt secondaire en début de ligne suivante, pour que rien ne déborde dans la marge de droite ?

  • # Le paquet listings

    Posté par  . Évalué à 2.

    À mon avis c'est le paquet listings est un bon début pour ce que tu veux faire, tu peux mettre un code source encadré avec numérotation des lignes en choisissant le langage.

  • # Quelques indications

    Posté par  (site web personnel) . Évalué à 4.

    Je débute en LaTeX,

    Dans ce cas c'est important de bien connaître un manuel, par exemple the not too short introduction to latex2e, qui te servira de référence principale (l'avantage de celle que je cite est qu'elle est assez concise), sans ignorer les autres ressources, en général la FAQ du TuG ou le LaTeX companion.

    Je cherche des macros du même genre que \url pour pouvoir entrer des noms de programmes, de commandes, des noms de domaines, des adresses IP, des sessions shell, etc.

    Pour ça j'utilise de commandes maison, très simples, que j'ai plus ou moins recopiées dans groff_mdoc(7) (section 6. Manual Domain), ce qui donne des définitions du genre


    où fa signifie function argument et sert à mettre en relif les arguments de fonctions (par exemple pour écrire le manuel d'une fonction C, ce n'est pas forcément ce qui t'intéresse le plus directement, mais tu vois le genre).

    Les textes avec de nombreux styles sont plus difficile à bien présenter (mal présentés, ils sont plus difficile à lire), alors tu peux t'en tenir dans un premier temps aux italiques et aux caractères inclinés pour marquer ton texte.

    Pour pouvoir afficher un fichier de configuration, j'ai trouvé \verbatimtab, mais on ne peut pas y utiliser \emph et autres. Pourriez-vous me fait part des packages et astuces que vous utilisez, et d'éventuels tutoriaux sur le sujet ?

    Je te recommande le paquet fancy verbatim qui est très flexible et te donne un moyen d'indiquer des changements de style dans un passage verbatim.

    PS : existe-t-il une macro, servant à entrer une ligne de commande du shell, qui saurait automatiquement ajouter des backslashes en fin de ligne et mettre un prompt secondaire en début de ligne suivante, pour que rien ne déborde dans la marge de droite ?

    Pas à ma connaissance.

    Je veux attirer ton attention sur deux points. Le premier, est qu'il est très facile d'écrire de générer des fichiers LaTeX depuis un programme et que cette capacité est à ma connaissance très largement sous-exploitée. Le programme peut-être un simple préprocesseur ou un pretty-printer, par exemple. Agrémenté d'un script de compilation rustique ou d'un vértiable Makefile, cette recette peut faire merveille. Le deuxième point est que le type de documentation que tu veux écrire me semble entrer dans le domaine de prédilection de Docbook, qui te permet d'obtenir une version imprimable (pas forcément très belle, je le reconnais) mais aussi des versions texte ou HTML, et les documents dans cette forme sont très utiles dans le domaine de l'administration.

  • # le site du zero !!

    Posté par  . Évalué à 1.

    Fait un petit tour sur le site du zero, tu trouveras de bonnes bases pour commencer en Latex ;)

    bon courage pour la suite

Suivre le flux des commentaires

Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.