Em textos científicos (artigos; propostas) qual é a convenção para formatação dos seguintes?
- sistemas operacionais: Android; Linux; Microsoft Windows
- software (suite), por exemplo: LibreOffice; Microsoft Office
- componentes: Escritor (LibreOffice); Palavra (MS Office)
- plataformas, por exemplo: Apache Solr; Citoscape; Plataforma Java
- frameworks, por exemplo: PostgreSQL; MySQL
- bibliotecas, por exemplo: jQuery (JS); Matplotlib (Python); RedeX (Python); NumPy (Python)
- linguagens de marcação, por exemplo: HTML
- linguagens de programação, ex.: C; Java; JavaScript; PHP; SQL; Pitão; R
- ambiente de execução: nó
- gerenciador de pacotes: npm
- folhas de estilo, por exemplo: CSS
- estruturas de dados, por exemplo: JSON; XML
Não tenho certeza de onde traçar o limite: ou seja, estilizar todas as menções programáticas ou excluir algumas mais comuns (HTML?).
Além disso, o uso preferido para esses estilos é teletipo: \texttt{}
ou (porhttps://tex.stackexchange.com/a/620961/171556) SmallCaps: \textsc{}
?
Encontrei isto que oferece algumas orientações:
- Tipografia O'Reilly e convenções de fontes:https://oreillymedia.github.io/production-resources/styleguide/#typography_and_font_conventions
Responder1
Em vez de marcar itens usando \texttt{}
ou \textsc{}
, recomendo usar marcação semântica para que você possa modificar facilmente a formatação se desejar ou precisar de algo diferente.
Basicamente, isso envolve a criação de vários wrappers simples em seu preâmbulo, como
\NewDocumentCommand \os {m} {\textsf{#1}}
\NewDocumentCommand \suite {m} {\texttt{#1}}
\NewDocumentCommand \suitecomp {m} {\texttt{#1}}
\NewDocumentCommand \langacro {m} {\textsc{\texttt{#1}}}
e assim por diante. Você então usa esses wrappers, em vez de marcação explícita, em seu documento,
\os{Linux} distributions package \suite{LibreOffice}, which includes \suitecomp{Writer} and \suitecomp{Calc}.
A documentação do doc
pacote pode ser útil, assim como a abundância depacotes para composição de documentação de pacotes no CTAN.