Diferenças

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

--- admin:wiki:convencoes [2025/08/14 00:10] – [Tipografia] monoespaçado em programação hrcerq
+++ admin:wiki:convencoes [2025/08/14 01:01] (atual) – [Caixas de código] largura das caixas de código hrcerq
@@ Linha 137: / 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 164: / 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).