Каково общепринятое форматирование следующих разделов научного текста (статьи, предложения)?
- операционные системы: Android; Linux; Microsoft Windows
- программное обеспечение (пакет), например: LibreOffice; Microsoft Office
- компоненты: Writer (LibreOffice); Word (MS Office)
- платформы, например: Apache Solr; Cytoscape; платформа Java
- фреймворки, например: PostgreSQL; MySQL
- библиотеки, например: jQuery (JS); Matplotlib (Python); NetworkX (Python); NumPy (Python)
- языки разметки, например: HTML
- языки программирования, например: C; Java; JavaScript; PHP; PSQL; Python; R
- среда выполнения: узел
- менеджер пакетов: npm
- таблицы стилей, например: CSS
- структуры данных, например: JSON; XML
Я не уверен, где провести границу: то есть оформить все программные упоминания или исключить некоторые общие (HTML?).
Кроме того, является ли предпочтительным использование этих стилей телетайп: \texttt{}
или (в соответствии сhttps://tex.stackexchange.com/a/620961/171556) Маленькие заглавные буквы: \textsc{}
?
Я нашел вот это, которое дает некоторые рекомендации:
- Типографика и соглашения по шрифтам O'Reilly:https://oreillymedia.github.io/production-resources/styleguide/#типографика_и_шрифты_условия
решение1
Вместо того, чтобы размечать элементы с помощью \texttt{}
или \textsc{}
, я бы рекомендовал использовать семантическую разметку, чтобы вы могли легко изменить форматирование, если захотите или вам понадобится что-то другое.
По сути, это подразумевает создание набора простых оберток в вашей преамбуле, например:
\NewDocumentCommand \os {m} {\textsf{#1}}
\NewDocumentCommand \suite {m} {\texttt{#1}}
\NewDocumentCommand \suitecomp {m} {\texttt{#1}}
\NewDocumentCommand \langacro {m} {\textsc{\texttt{#1}}}
и т. д. Затем вы используете эти оболочки, а не явную разметку, в вашем документе,
\os{Linux} distributions package \suite{LibreOffice}, which includes \suitecomp{Writer} and \suitecomp{Calc}.
Документация по doc
пакету может оказаться полезной, как и обилиепакеты для набора документации пакета на CTAN.