Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- admin:wiki:convencoes [2025/08/09 20:29] – [Concisão] formatação de código hrcerq
+++ admin:wiki:convencoes [2025/08/14 01:01] (atual) – [Caixas de código] largura das caixas de código hrcerq
@@ Linha 35: / Linha 35: @@
 > O editor **ed** é o editor de texto original do UNIX.
-Quando [[utils:glossario#p|parâmetros]] :?: de linha de comando forem mencionados, eles também devem ser destacados em monoespaçado. A mesma regra vale para subcomandos de programas de [[utils:glossario#l|linha de comando]] :?:.
+Quando [[utils:glossario#p|parâmetros]] :?: de linha de comando forem mencionados, eles devem ser destacados em monoespaçado. A mesma regra vale para subcomandos de programas de [[utils:glossario#l|linha de comando]] :?:.
 > Ao usar o parâmetro ''-1'', a lista apresentada por __ls__ será forçada a usar uma única coluna.
 > Embora não seja parte do padrão, quase todas as implementações do editor __ed__ possuem o comando ''z'', que pode ser útil para visualizar o arquivo.
+Nomes de menus e opções dentro de menus em aplicações gráficas também devem utilizar essa convenção monoespaçada.
+> Para alterar as preferências, navegue no menu ''Editar'', e selecione a opção ''Preferências''.
+E ainda, ao mencionar nomes de variáveis, comandos, funções ou objetos em programação, deve-se também usar o monoespaçado.
+> A variável global ''%ENV'' permite o acesso a todas as variáveis de ambiente configuradas no sistema.
 Por vezes, usamos termos estrangeiros (geralmente em inglês), que não possuem uma tradução ou não faria sentido traduzir (ou ainda, que poderia soar muito pedante a tradução). Esses termos devem ser destacados em itálico.
@@ Linha 129: / Linha 137: @@
 > FIXME Detalhar quais predicados são aceitos nesse tipo de consulta.
+==== Caixas de código ====
+Para adicionar caixas de código, usando a sintaxe do DokuWiki, é possível recorrer a duas notações diferentes: a marcação ''<code>'', para trechos de código, e a marcação ''<file>'', para indicar que o código (ou mais genericamente, qualquer conteúdo textual) seria o conteúdo de um arquivo.
+Deve-se usar ''<code>'' sempre que se tratar de um comando no terminal ou trechos de código não associados a algum arquivo em particular.
+<code>
+$ echo Olá
+Olá
+</code>
+Por outro lado, sempre que for indicado que o texto estará dentro de algum arquivo, deve-se usar ''<file>''.
+<file>
+# meus atalhos
+alias ls='ls -F'
+alias ll='ll -lh'
+</file>
+Ambas as marcações permitem o uso de destaque de sintaxe, porém, para não entrar em conflito com o estilo usado nesta Wiki, recomenda-se não utilizar esse recurso.
+Além disso, é possível também definir uma aba superior sobre a caixa de código, indicando o nome do arquivo em questão (e inclusive com um //hiperlink// para baixar o arquivo).
+<file - .profile>
+# minhas configurações
+ENV="$HOME/.shrc"
+MANWIDTH=73
+export ENV MANWIDTH
+</file>
+Essa opção funciona em ambas as marcações, porém aqui não a utilizamos para a marcação ''<code>''. Para ''<file>'' utilizamos apenas nos casos em que o arquivo inteiro é apresentado. Para caixas de código que mostram apenas um trecho de um arquivo maior, não se deve usar essa aba superior.
+=== Tamanho do texto ===
+Recomenda-se, sempre que possível, manter o texto das caixas em um limite de 80 caracteres, limite tipicamente aceito para terminais, e que ao mesmo tempo cabe confortavelmente nas caixas de código, sem necessidade de uma barra de rolagem horizontal (que além de esteticamente desagradável prejudica um pouco a navegação pela página).
 ==== Tabelas ====
@@ Linha 156: / Linha 200: @@
 A [[:start|página inicial]] da Wiki possui uma lista de tópicos principais. Essa lista não deve ser alterada sem uma discussão prévia, por serem tópicos mais genéricos, elaborados a partir de páginas que já existiam, capturando a essência dos assuntos.
-Caso se perceba que um novo tópico principal é realmente necessário, ou seja, que os já existentes não cobrem algum assunto de interesse para a Wiki, então uma nova discussão deverá ser iniciada [[https://forum.slackjeff.com.br/viewforum.php?f=26|no fórum]].
+Caso se perceba que um novo tópico principal é realmente necessário, ou seja, que os já existentes não cobrem algum assunto de interesse para a Wiki, então uma nova discussão deverá ser iniciada no canal ''#wiki'' do [[admin:irc:start|IRC]].
 Cada um dos tópicos principais possui sua própria página inicial, a qual deve iniciar por uma explicação resumida do que aquele tópico abrange. Os títulos dessas páginas devem ser o nome por extenso do tópico (por exemplo, "Utilitários"), que deve ser seguido por uma linha destacando o nome de contexto daquele tópico (para mais informações, vide a seção de [[#convencoes_de_contexto|convenções de contexto]], mais adiante).