☰

Шаблон/пакет типографских условных обозначений

tag-icon • tag-icon typography
Шаблон/пакет типографских условных обозначений

Я ищу способ (возможно, он работает из коробки) или пакет для создания страницы для соглашений, используемых в документе. До сих пор мой поиск давал только результаты о типографских соглашениях в LaTeX, а не о том, как их создать...

Вот пример того, как это может выглядеть (изздесь):

введите описание изображения здесь

Не уверен, будет ли это itemizeили tabularокружением (возможно последнее из-за многострочности). Я начал с этого, tabularи вот код:

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

Однако интересно, есть ли лучшие способы сделать это.

решение1

Ниже приведены некоторые предложения по улучшению кода. Я удалил все \spaceddotfillкоманды и добавил их непосредственно в определение столбца. Вместо повторяющихся [1em], я использовал \setlength\extrarowheight{1em}и , чтобы убедиться, что таблица вписывается в textwidth, я вычислил ширину второго столбца и добавил \noindentпрямо перед началом таблицы. Наконец, я также использовал \lstinlineиз listingsпакета для фрагментов кода:

введите описание изображения здесь

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

Связанный контент