Forum général.général Syntaxe de document troff

Posté par (page perso) .
Tags :
2
16
juin
2012

Bonjour,

Je travaille depuis des lustres sur une macro troff que j'aspire à publier. Je réfléchis actuellement sur la syntaxe que l'utilisateur final utilisera. J'aimerais ne pas avoir à en changer ensuite, aussi, plutôt que d'avancer tête baissée, je vous soumet ici le brouillon, et pose deux questions:

  • La syntaxe est-elle cohérente et facile à retenir ?
  • Est-elle suffisamment explicite tout en étant peu verbeuse ?

Voici la syntaxe, et son explication en anglais (car la syntaxe est basée sur l'anglais):

Format and layout:
.RV: recto verso
.RI: remove idem
.RO: remove op. cit.
.RM: remove margin macro for references (don't print reference in a marginal note).

Metadata:
.DA "author": author name
.DT "title": title of text
.DS "subject": subject of the text
.DK "keywords": list of keywords
.DF "filename": name of the file

Heading:
.H1, .H2, .H3, .H4: headings.
.H0 "head": titre imprimé en haut de la page actuelle.
.H- "head": titre imprimé en haut de chacune des pages suivantes (je ne suis pas convaincu par celui-là...).

Summary:
.S1: summary of H1.
.S2: summary of H2
...

Paragraph:
.PP: default paragraph.
.PQ: quote paragraph.
.PI [bullet]: list paragraph.
.PL: left indent paragraph.
.PR: right align paragraph.
.PC: code paragraph.

Margin:
.MN [no]: marginal note. Sans argument, un numéro est préfixé à la note.
.MT: Print text at the top of the margin.
.MB: Print text at the bottom of the margin.
.ME: End of MN, MT, or MB.

Typography:
.TD: Use micro-typography to decrease the width of a paragraph.
.TI: Use micro-typography to increase the width of a paragraph.

Appendix:
.AI: Index of references.
.AB "bibliography.ref": print a bibliography.
.AT: table of content.

Semantic information (inline elements) (j'hésite à utiliser ce niveau de structuration, désagréable à taper, mais pratique pour créer des index ou pour un export en xml. La liste n'est pas exhaustive, toutes les idées sont les bienvenues):
.A "acronym definition"
.C "command"
.D "date"
.E "error"
.H "lastname firstname [l|f|lf|fl]": human being. Le troisième argument optionnel indique comment imprimer le nom: nom seul, prénom seul, nom puis prénom, prénom puis nom. Par défaut, seul le nom est imprimé.
.N "name": ville, logiciel...
.Q "citation": citation dans un paragraphe.
.T "title"
.U "url"
.I "image"
.W "word": word to index and print.
.X "word": word to index but not to print.

Le format de deux lettres majuscule est le format historique utilisé par troff. En un sens, il me convient, car il est peu verbeux, se tape rapidement, et reste compatible avec les anciennes versions de troff (que plus personne n'utilise, et avec lesquelles ma macro ne sera pas compatible). Mais peut-être qu'il vaut mieux s'en affranchir aujourd'hui, pour, par exemple, des intitulés à trois lettres, plus explicites.

Qu'en pensez-vous ? Est-ce cohérent, facile à retenir, explicite et peu verbeux à la fois ?

  • # oui

    Posté par . Évalué à 3.

    Est-ce cohérent, facile à retenir, explicite et peu verbeux à la fois ?

    oui, c'est compréhensible

Suivre le flux des commentaires

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