Welche Formatierungskonvention gilt in wissenschaftlichen Texten (Aufsätzen, Vorschlägen) für das Folgende?
- Betriebssysteme: Android; Linux; Microsoft Windows
- Software (Suite), zB: LibreOffice; Microsoft Office
- Komponenten: Writer (LibreOffice); Word (MS Office)
- Plattformen, zB: Apache Solr; Cytoscape; Java-Plattform
- Frameworks, zB: PostgreSQL; MySQL
- Bibliotheken, zB: jQuery (JS); Matplotlib (Python); NetworkX (Python); NumPy (Python)
- Auszeichnungssprachen, zB: HTML
- Programmiersprachen, zB: C; Java; JavaScript; PHP; PSQL; Python; R
- Laufzeitumgebung: node
- Paketmanager: npm
- Stylesheets, zB: CSS
- Datenstrukturen, zB: JSON; XML
Ich bin nicht sicher, wo ich die Grenze ziehen soll: also alle programmatischen Erwähnungen formatieren oder einige allgemeine ausschließen (HTML?).
Außerdem ist die bevorzugte Verwendung für diese Stylings Teletyp: \texttt{}
oder (perhttps://tex.stackexchange.com/a/620961/171556) Kapitälchen: \textsc{}
?
Ich habe das hier gefunden, was eine gewisse Orientierung bietet:
- O'Reilly-Typografie und Schriftkonventionen:https://oreillymedia.github.io/production-resources/styleguide/#typography_and_font_conventions
Antwort1
Anstatt Elemente mit \texttt{}
oder zu markieren \textsc{}
, empfehle ich die Verwendung einer semantischen Auszeichnung, sodass Sie die Formatierung problemlos ändern können, wenn Sie feststellen, dass Sie etwas anderes möchten oder brauchen.
Im Grunde genommen geht es dabei darum, eine Reihe einfacher Wrapper in der Präambel zu erstellen, wie zum Beispiel
\NewDocumentCommand \os {m} {\textsf{#1}}
\NewDocumentCommand \suite {m} {\texttt{#1}}
\NewDocumentCommand \suitecomp {m} {\texttt{#1}}
\NewDocumentCommand \langacro {m} {\textsc{\texttt{#1}}}
und so weiter. Sie verwenden dann diese Wrapper anstelle von explizitem Markup in Ihrem Dokument,
\os{Linux} distributions package \suite{LibreOffice}, which includes \suitecomp{Writer} and \suitecomp{Calc}.
Die Dokumentation zum doc
Paket kann hilfreich sein, ebenso wie die Fülle anPakete zum Satz der Paketdokumentation auf CTAN.