Vorlage/Paket für typografische Konventionen

Vorlage/Paket für typografische Konventionen

Ich suche nach einer Möglichkeit (vielleicht funktioniert es sofort) oder einem Paket, um eine Seite für Konventionen zu erstellen, die in einem Dokument verwendet werden. Bisher ergab meine Suche nur Ergebnisse zu typografischen Konventionen in LaTeX und nicht, wie man sie erstellt ...

Hier ist ein Beispiel, wie es aussehen könnte (vonHier):

Bildbeschreibung hier eingeben

itemizeIch bin nicht sicher, ob dies ein oder eine Umgebung ist tabular(vielleicht letzteres aufgrund der Mehrzeiligkeit), mit der ich begonnen habe, tabularund dies ist der 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}

Ich frage mich jedoch, ob es bessere Möglichkeiten gibt, dies zu tun.

Antwort1

Nachfolgend finden Sie einige Vorschläge, wie Sie Ihren Code verbessern können. Ich habe alle \spaceddotfillBefehle entfernt und direkt in die Spaltendefinition eingefügt. Anstatt des wiederholten [1em]habe ich verwendet \setlength\extrarowheight{1em}und um sicherzustellen, dass die Tabelle in die Textbreite passt, habe ich die Breite der zweiten Spalte berechnet und \noindentdirekt vor dem Beginn der Tabelle hinzugefügt. Zuletzt habe ich auch \lstinlineaus dem listingsPaket für die Codefragmente verwendet:

Bildbeschreibung hier eingeben

\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}

verwandte Informationen