Guide des bonnes pratiques en LaTeX

a marqué ce sujet comme résolu.
Auteur du sujet

Bonjour à tous,

Karnaj a eu l’initiative de recopier mon guide des bonnes pratiques pour qu’il soit migré ici1 et je l’en remercie. J’ai accepté de le publier sur ZdS et, sur les conseils d’Arius, je le propose en bêta-test afin de recueillir des critiques. J'aimerais obtenir un maximum de retour sur celui-ci, sur le fond ainsi que sur la forme, afin de proposer en validation un texte de qualité.

Si vous êtes intéressé, cliquez ci-dessous :

Merci d’avance pour votre aide.


  1. Il ne s’agit pas encore tout à fait d’une migration car mon guide restera sur OpenClassrooms pour le moment (mais il n’y sera pas mis à jour). 

Édité par TD

« LaTeX is to a book what a set of blueprints is to a building » (Paul Dulaney) | Mon planétaire

+0 -0
Banni

Salut, bravo pour cette initiative.

Quelques remarques :

  • à la fin de la section sur les encodages, le lien pointe vers OC. Comme je vois que tu es co-auteur du tuto donné en lien, peut-être envisages-tu de le transférer également ici ? Ou sinon, indiquer que le lien est un site externe.

  • à la fin de la section sur la documentation des packages, tu dis que tous sont en anglais. Il s'avère qu'heureusement quelques-uns sont en français (ou en plusieurs langues). Il s'avère aussi que certains sont exclusivement en polonais (?) comme celui-ci : http://www.ctan.org/pkg/cmyk-hax. Tu dis qu'il faut connaitre un minimum l'anglais. Je dirais qu'il suffit de connaitre quelques mots d'anglais basiques pour se débrouiller, il s'agit de documentation technique (souvent richement illustrée), pas d'un roman. Ne décourageons pas quelqu'un en lui faisant croire qu'il va devoir lire du Shakespeare.

Enfin, ayant souvent lu sur un autre forum des problèmes d'utilisateurs de MikTeX (incomplet, et qui apparemment ne télécharge pas toujours automatiquement les packages manquants), autant mettre tout de suite les utilisateurs de Windows sur la bonne voie en leur conseillant d'installer TeXLive (je crois qu'elle fait plus de 2 Go mais pour la plupart des utilisateurs, c'est pas très lourd à télécharger. Pour les autres, un DVD de TeXLive peut être obtenu contre frais auprès de divers groupes d'utilisateurs TeX). Si je dis que je crois qu'elle fait plus de 2 Go, c'est que sur mon Mac, j'emploie MacTeX qui fait plus de 2 Go, et qui est globalement la TeXLive à laquelle des logiciels spécifique au Mac sont rajoutés.

+0 -0
Auteur du sujet

Salut, bravo pour cette initiative.

C’est avant tout Karnaj qu’il faut remercier.

à la fin de la section sur les encodages, le lien pointe vers OC. Comme je vois que tu es co-auteur du tuto donné en lien, peut-être envisages-tu de le transférer également ici ? Ou sinon, indiquer que le lien est un site externe.

Bien que je sois officiellement co-auteur de l’article, je n’ai en réalité rédigé que le paragraphe traitant de LaTeX. Suite à une remarque en bêta-test (on ne parlait pas encore de v4 et encore moins d’OC à l’époque !), Maelan m’a ajouté comme auteur pour que j’ajoute moi-même ce que je voulais alors que je n’avais rien demandé. Pourquoi n’ai-je pas demandé à être rayé de la liste ? Je ne sais plus. Le fait est que je ne me considère pas vraiment comme un auteur de l’article sur les encodages et que je laisse le choix à Maelan de le migrer ou non.

  • à la fin de la section sur la documentation des packages, tu dis que tous sont en anglais. Il s'avère qu'heureusement quelques-uns sont en français (ou en plusieurs langues). Il s'avère aussi que certains sont exclusivement en polonais (?) comme celui-ci : http://www.ctan.org/pkg/cmyk-hax. Tu dis qu'il faut connaitre un minimum l'anglais. Je dirais qu'il suffit de connaitre quelques mots d'anglais basiques pour se débrouiller, il s'agit de documentation technique (souvent richement illustrée), pas d'un roman. Ne décourageons pas quelqu'un en lui faisant croire qu'il va devoir lire du Shakespeare.

Il est clair que tous les packages ne sont pas documentés exclusivement en anglais. Notamment, tous ceux qui traitent de la composition du français sont généralement documentés dans la langue de Molière. On trouve aussi un certain nombre de documentations en allemand. Plusieurs packages ne sont par ailleurs pas documentés. Le fait est que les packages qui intéresseraient un lecteur de mon guide des bonnes pratiques n’a pas besoin de packages obscurs puisqu’encore en phase d’apprentissage. En disant « connaître un minimum l’anglais », je veux simplement dire pouvoir comprendre des phrases assez simples pour pouvoir se repérer dans le texte, ce qui est suffisant pour aborder une documentation technique (reste le jargon inhérent à LaTeX). Il ne faut cependant pas se voiler la face : tout n’est pas dans le code et les subtilités (parfois très importantes) sont expliquées par du texte. Un bon niveau collège peut suffire, je crois, mais n’oublions pas à qui est destiné LaTeX : les universitaires (au sens large), donc des gens déjà plus ou moins anglophones.

Pour revenir sur la remarque de Shakespeare, je souhaite signaler qu’un certain nombre de documentations comportent une grande part de texte, si bien qu’il s’agit en réalité de véritables livres qui traitent de divers sujets comme la composition typographique (on cite parfois Tschichold au détour d’une page, quand ce n’est pas Bringhurst) et là, il n’y a plus rien de technique (ou plutôt de technologique), mais seulement de l’art. La rédaction est parfois très bonne, dans un anglais tout à fait comparable aux ouvrages imprimés.

Enfin, ayant souvent lu sur un autre forum des problèmes d'utilisateurs de MikTeX (incomplet, et qui apparemment ne télécharge pas toujours automatiquement les packages manquants), autant mettre tout de suite les utilisateurs de Windows sur la bonne voie en leur conseillant d'installer TeXLive (je crois qu'elle fait plus de 2 Go mais pour la plupart des utilisateurs, c'est pas très lourd à télécharger. Pour les autres, un DVD de TeXLive peut être obtenu contre frais auprès de divers groupes d'utilisateurs TeX). Si je dis que je crois qu'elle fait plus de 2 Go, c'est que sur mon Mac, j'emploie MacTeX qui fait plus de 2 Go, et qui est globalement la TeXLive à laquelle des logiciels spécifique au Mac sont rajoutés.

Je suis conscient des problèmes de MikTeX, sans toutefois savoir précisément de quoi il s’agit, ne l’utilisant plus depuis cinq ans (presque jour pour jour d’ailleurs) suite à mon passage sous Linux. Je n’avais d’ailleurs aucun problème à l’époque. Était-ce de la chance ? Peut-être, d’autant plus que je n’avais utilisé aucun tutoriel pour démarrer ni pour installer les programmes nécessaires (juste la page dédiée sur les Tuteurs de l’ENS). Cependant, je souhaite me concentrer sur le code et les notions connexes (particulièrement la documentation et l’encodage des fichiers sources) et rester le plus générique possible quant à la configuration de l’ordinateur du lecteur.

« LaTeX is to a book what a set of blueprints is to a building » (Paul Dulaney) | Mon planétaire

+0 -0

Je pense qu'il manque beaucoup de conseils sur les macros. Il est à mon avis très important, en LaTeX, de chercher à factoriser son code et à donner un sens au code plutôt que de se focaliser sur la syntaxe. Il est aussi fréquent que l'on change de notations, etc. Pour toutes ces raisons, apprendre à utiliser des macros, et même des macros avec arguments optionnels (cf. je ne sais plus quel package, xparse peut-être), ça me semble absolument nécessaire.

Autres conseils en vrac : apprendre à utiliser les spécificités de certains compilateurs (par exemple le fait de pouvoir saisir ses maths en UTF-8 avec XeLaTeX pour rendre la source plus lisible), même chercher (quand c'est possible) à utiliser des outils modernes (Tikz plutôt que xypic, biblatex/biber plutôt que bibtex…), utiliser des macros comme addspace plutôt que des espaces en dur (edit : sauf si c'est propre à Biblatex en fait), peut-être utiliser le package xspace, rajouter des commentaires qui expliquent à quoi sert un package quand on le charge… bon, là je suis plutôt en train de te communiquer mon style personnel, à toi de voir. ^^

Ah et enfin, je crois que tu peux mentionner le package csquote comme exemple de package dépendant de babel. C'est à vérifier quand même.

Merci beaucoup d'apporter ton cours à ZDS, sinon (et donc merci à Karnaj également).

Édité par anonyme

+0 -0
Auteur du sujet

Bonjour les agrumes !

La bêta a été mise à jour et décante sa pulpe à l'adresse suivante :

J’ai supprimé la mention du tutoriel sur les encodages (définitivement inaccessible) et j’ai généralisé la partie sur les demandes d’aide.

Merci d'avance pour vos commentaires.

Édité par TD

« LaTeX is to a book what a set of blueprints is to a building » (Paul Dulaney) | Mon planétaire

+0 -0
Auteur du sujet

Ça doit faire plus de trois semaines que j’ai envoyé mon tutoriel à la validation. Comment avance la relecture ? Je ne souhaite pas presser l’équipe de validation mais juste savoir si mon guide a été pris en charge ou non.

« LaTeX is to a book what a set of blueprints is to a building » (Paul Dulaney) | Mon planétaire

+0 -0
Auteur du sujet

Il y a beaucoup de contenus en attente ? Quel est le délai moyen de publication des contenus qui sortent actuellement ? Comme je souhaite également soumettre un article à la validation, ça me donnera une idée de ce à quoi m’attendre.

« LaTeX is to a book what a set of blueprints is to a building » (Paul Dulaney) | Mon planétaire

+0 -0
Vous devez être connecté pour pouvoir poster un message.
Connexion

Pas encore inscrit ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte