Modèle / package de conventions typographiques

Nov 08 2020

Je cherche un moyen (peut-être que cela fonctionne hors de la boîte) ou un package pour créer une page pour les conventions utilisées dans un article. Jusqu'à présent, ma recherche ne donnait que des résultats sur les conventions typographiques dans LaTeX et non sur la façon de les créer ...

Voici un exemple à quoi cela pourrait ressembler (à partir d' ici ):

Je ne sais pas si ce serait itemizeun tabularenvironnement ou un environnement (peut-être ce dernier en raison de la multiligne) avec lequel j'ai commencé tabularet voici le code:

\documentclass{article}

% surround the \dotfill by a bit of blank space
\newcommand{\spaceddotfill}{\phantom{i}\dotfill\phantom{e}}

\begin{document}
    \begingroup
    \setlength\tabcolsep{0pt}
    \begin{tabular}{p{3.2cm}p{8.8cm}}
        \textsf{package}\spaceddotfill & Paketbezeichner verwenden zur Darstellung die Schriftart \textsf{Sans Serif}. \\[1em]
        \texttt{file}\spaceddotfill & Datei- und Programmnamen verwenden zur Darstellung die Schriftart \texttt{Typewriter}. \\[1em]
        \texttt{\textbackslash{}macro}\spaceddotfill & Makros, respektive Kommandos, werden mit einem umgekehrten Schrägstrich (backslash) eingeleitet und verwenden zur Darstellung die Schriftart \texttt{Typewriter}.\\[1em]
        \texttt{environment}\spaceddotfill & Umgebungen verwenden zur Darstellung die Schriftart \texttt{Typewriter}. \\[1em]
        \texttt{option}\spaceddotfill & Optionen verwenden zur Darstellung die Schriftart \texttt{Type\-writer}. \\[1em]
        \textit{defval}\spaceddotfill & Standardwerte verwenden zur Darstellung die Schriftart \textit{Italics}. \\[1em]
        \textit{$\langle meta \rangle$}\spaceddotfill & Metadaten, also Platzhalter für Informationen jeglicher Art, verwenden zur Darstellung die Schriftart \textit{Italics} und sind zusätzlich noch in spitzen Klammern eingeschlossen. \\[1em]
        \ttfamily$\{$\textit{$\langle mustarg \rangle$}$\}$\spaceddotfill & Pflichtparameter werden in geschweiften Klammern einge\-schlossen und verwenden zur Formatierung der Daten die Darstellung \textit{$\langle meta \rangle$}. \\[1em]
        {[\textit{$\langle optarg \rangle$}]}\spaceddotfill & Optionale Parameter werden in eckigen Klammern einge\-schlossen und verwenden zur Formatierung der Daten die Darstellung \textit{$\langle meta \rangle$}. \\[1em]
    \end{tabular}
    \endgroup
\end{document}

Vous vous demandez s'il existe de meilleures façons de le faire.

Réponses

1 leandriis Nov 08 2020 at 05:35

Ce qui suit contient quelques suggestions sur la façon dont on pourrait améliorer votre code. J'ai supprimé toutes les \spaceddotfillcommandes et je les ai ajoutées directement dans la définition de colonne. Au lieu de répéter [1em], j'ai utilisé \setlength\extrarowheight{1em}et pour m'assurer que le tableau correspond à la largeur du texte, j'ai calculé la largeur de la deuxième colonne et ajouté \noindentjuste avant le début du tableau. Enfin, j'ai également utilisé \lstinlinedu listingspackage pour les fragments de code:

\documentclass{article}
\usepackage{array}
% surround the \dotfill by a bit of blank space
\newcommand{\spaceddotfill}{\phantom{i}\dotfill\phantom{e}}
\usepackage{listings}
\lstset{basicstyle=\itshape}
\begin{document}
 
    \begingroup
    \setlength\extrarowheight{1em}
    \setlength\tabcolsep{0pt}
    \noindent
    \begin{tabular}{p{3.2cm}<{\spaceddotfill}p{\dimexpr\textwidth-3.2cm}}
        \textsf{package} & Paketbezeichner verwenden zur Darstellung die Schriftart \textsf{Sans Serif}. \\
        \texttt{file} & Datei- und Programmnamen verwenden zur Darstellung die Schriftart \texttt{Typewriter}. \\
        \texttt{\textbackslash{}macro} & Makros, respektive Kommandos, werden mit einem umgekehrten Schrägstrich (backslash) eingeleitet und verwenden zur Darstellung die Schriftart \texttt{Typewriter}.\\
        \texttt{environment} & Umgebungen verwenden zur Darstellung die Schriftart \texttt{Typewriter}. \\
        \texttt{option} & Optionen verwenden zur Darstellung die Schriftart \texttt{Type\-writer}. \\
        \textit{defval} & Standardwerte verwenden zur Darstellung die Schriftart \textit{Italics}. \\
        \lstinline|<meta>| & Metadaten, also Platzhalter für Informationen jeglicher Art, verwenden zur Darstellung die Schriftart \textit{Italics} und sind zusätzlich noch in spitzen Klammern eingeschlossen. \\
        \lstinline|{<mustarg>}| & Pflichtparameter werden in geschweiften Klammern einge\-schlossen und verwenden zur Formatierung der Daten die Darstellung \lstinline|<meta>|. \\
        \lstinline|[<optarg>]| & Optionale Parameter werden in eckigen Klammern einge\-schlossen und verwenden zur Formatierung der Daten die Darstellung \lstinline|<meta>|. \\
    \end{tabular}
    \endgroup
\end{document}