Help:Style (Português)/Formatting and punctuation (Português)

From ArchWiki
Status de tradução: Esse artigo é uma tradução de Help:Style/Formatting and punctuation. Data da última tradução: 2020-06-13. Você pode ajudar a sincronizar a tradução, se houver alterações na versão em inglês.

Artigos relacionados

As seguintes direções definem como diferentes partes do conteúdo de um artigo devem ser destacadas por meio de formatação e pontuação.

Regras gerais

Essas regras gerais sempre sobrepõem #Casos específicos. Para casos não cobertos neste guia, Wikipédia:Livro de estilo é a referência autoritária.

  • Não misture mais do que um método de realce exceto onde explicitamente permitido por essas regras.
    Essa regra também se aplica nos casos em que alguma formatação já está definida por regras de CSS, por exemplo negrito em termos de lista de definição. Se a formatação CSS predefinida não for permitida no item afetado (ex.: negrito em #Nomes e caminhos de arquivos), então você tem que usar uma marcação wiki compatível e diferente junto (ex.: lista de marcadores em vez de uma lista definição).
  • Não use métodos de realce diferentes daqueles definidos neste manual; isso inclui, mas não se limita a, sublinhar, piscar, palavra toda maiúscula, cores, asteriscos, sinal de exclamação, emoticons, tags HTML com um atributo style.

Primeiras instâncias

  • A primeira aparição relevante de um termo ou nome em um artigo (ex.: nomes de executáveis) pode ser realçada (veja abaixo) se foi considerado digno de atenção em particular, considerando o tópico do artigo ou seção específica. A primeira aparição "relevante" pode não ser a primeira aparição absoluta do nome: sua escolha é deixada para o editor.
  • A forma preferível de realçar o nome é usar um link para um artigo intimamente relacionado no wiki ou a uma página externa, como o Wikipédia; se não houver links pertinentes possíveis, negrito pode ser usado como uma solução alternativa.
Nomes de pacotes e grupos de pacotes devem usar Template:Pkg, Template:AUR ou Template:Grp.
  • Se o nome já foi introduzido pelo artigo ou por um título de seção, sua primeira aparição relevante no corpo só pode ser usada como um link âncora, mas não simplesmente realçada em negrito, exceto no caso de #Listas de nome/termo.
  • Realce da primeira instância pode ser aplicado somente aos #Casos específicos que permite-o explicitamente.

Links

  • Nenhuma formatação deve ser aplicada aos textos âncoras de links.

Listas de nome/termo

  • É permitido, mas não obrigatório, manter uma formatação consistente nas listas de nomes ou termos, mesmo se normalmente nem todos os itens precisariam estar formatados. Isso pode envolver, por exemplo, termos todos em maiúsculos, os quais não devem ser italicizados, ou nomes em uma lista onde a maioria dos itens são formatados de acordo com #Primeiras instâncias.
    "Lista" deve ser recuada em um sentido amplo, de forma que, por exemplo, também todas palavras iniciais de uma série de parágrafos subsequentes poderia ser considerados como formando uma lista de termos.

Casos por formatação/pontuação

Os casos marcados por 1 são afetados pelas #Primeiras instâncias. Casos marcados por m se aplicam a texto monoespaçado.

Itálico

Use a sintaxe MediaWiki ''texto itálico'' em vez de tags <i>.

Negrito

Use a sintaxe MediaWiki '''texto em negrito''' em vez de tags <b>.

Monoespaço

Use Template:ic {{ic|texto monoespaçado}} em vez de tags <code> para texto fora de blocos de código.

Sinais de aspas

Use aspas duplas comuns "texto citado" em vez de aspas simples 'texto citado' ou aspas tipográficas “texto citado”.

Casos específicos

#Regras gerais sempre sobrepõem as seguintes regras.

Expansões de acrônimo/abreviação

Use itálico.

Exemplo
  • Pacman é o gerenciador de pacotes (package manager) do Arch Linux.
  • O cat (catenate, concatenar) é o utilitário padrão do Unix que concatena e lista arquivos.

Linhas de CLI

Use monoespaço. Devem ser comandos exemplos em linha, e não apenas menções a #Nomes de executável/aplicativo. Também textos e saídas console que podem ser razoavelmente de úteis colar em um terminal.

Exemplos
  • É fortemente recomendado que você digite man comando para ler a página man de algum comando.
  • Você pode usar o comando ip link para descobrir os nomes de suas interfaces.
  • Se você obtiver um erro ping: unknown host, primeiro verifique se há algum problema com seu cabo de rede ou com a potência do sinal de rede sem fio.
  • Digite sim para escolher Sair (ou pressione Q) para sair sem fazer mais alterações.
  • Execute pacman -Syu com privilégios de root.

Parâmetros de configuração, variáveis, opções, propriedades...

Use monoespaço. Também afeta opções de comando, grupos de usuários, endereços IP, variáveis de ambiente e variáveis em geral.

Quando ambas formas curta e longa de uma opção de comando têm que ser representadas, use o símbolo "/" sem espaços para separá-las, como, por exemplo, -a/--anything.

Exemplos
  • Por padrão, a disposição de teclado está definido para us.
  • [...] sendo que disposição pode ser fr, uk, dvorak, be-latin1, etc.
  • Desde v197, o udev não mais atribui nomes de interface de rede em conformidade com o esquema de nomes wlanX e ethX.
  • Neste exemplo, a interface Ethernet é enp2s0f0.
  • Se você não tem certeza, sua interface Ethernet provavelmente inicia com a letra "e" e é improvável ser lo ou iniciar com a letra "w".
  • Atualmente, você pode incluir um máximo de três linhas de nameserver.
  • Você precisará criar uma partição de inicialização de BIOS extra com tamanho 1007 KB e código de tipo EF02.
  • Todos os arquivos devem ter permissões 644 e ser de root:root.
  • A opção -i pode ser omitida se você deseja instalar todo pacote a partir do grupo base-devel sem perguntar.
  • A adição de seu usuário a grupos (sys, disk, lp, network, video, audio, optical, storage, scanner, power, etc.) não é necessário para a maioria dos casos de uso com systemd.
  • Se você está atrás de um servidor de proxy, você precisará exportar as variáveis de ambiente http_proxy e ftp_proxy.
  • Para usar outros locales para outras variáveis LC_*, execute locale para ver as opções disponíveis e adicioná-las ao locale.conf. Não é recomendado definir a variável LC_ALL. Veja Locale (Português)#Configurando o locale do sistema para um exemplo avançado.
  • [...] isso equivale ao que você incluiu no vetor DAEMONS.
  • Se você está em uma rede privada, é seguro usar endereços IP em 192.168.*.*, com uma máscara de sub-rede de 255.255.255.0 e um endereço de broadcast de 192.168.*.255. O gateway geralmente é 192.168.*.1 ou 192.168.*.254.
  • Ao fornecer o argumento -net nic para o QEMU, ele vai, por padrão, atribuir à máquina virtual uma interface de rede com o endereço de nível de enlace 52:54:00:12:34:56.

Daemons/serviços, módulos de kernel

Use monoespaço.

Exemplo
  • O dhcpcd.service inicia o daemon para todas as interfaces de rede.
  • Alguns nomes de unit contém um sinal @ (ex.: nome@texto.service).

Nomes de executável/aplicativo

Use itálico, mas apenas para nomes totalmente minúsculos. Afetado por #Primeiras instâncias.

Note que essa regra se aplica a executáveis apenas quando eles representam o aplicativo/arquivo em si, e não quando usados em #Linhas de CLI. Em especial, preste atenção a executáveis que geralmente são executados sem argumentos. Veja Help:Estilo#Ortografia.

Exemplos
  • Descomente o locale selecionado em /etc/locale.gen e gere-o com o utilitário locale-gen.
  • Descomente o locale selecionado em /etc/locale.gen e gere-o com locale-gen.
  • Desde v197, o udev não mais atribui nomes de interface de rede com o esquema de nomes wlanX e ethX.
  • A mídia de instalação do Arch Linux inclui as seguintes ferramentas de particionamento: fdisk, gdisk, cfdisk, cgdisk, parted.
  • Se o pacman falhar na verificação de seus pacotes, verifique o horário do sistema com cal.
  • Defina uma senha de root com passwd.

Conteúdo de arquivo

Use monoespaço para conteúdo que pode ser lido ou escrito em um arquivo ou que razoavelmente pode ser útil para ser copiado ou colado em um editor de texto.

Exemplos
  • No fim da string, digitenomodeset e pressione Enter. Alternativamente, tente video=SVIDEO-1:d que, se funcionar, não desabilitará a configuração de modo de kernel.
  • Remova o # na frente do locale que você deseja do /etc/locale.gen.

Extensões de arquivo

Use itálico.

Exemplo
  • Pacman é escrito na linguagem de programação C e usa o formato de pacote .pkg.tar.xz.

Nomes e caminhos de arquivos

Use monoespaço. Também nomes de dispositivos e nomes com caracteres curinga são afetados. #Extensões de arquivo, porém, são tratadas diferentemente.

Exemplos
  • Para testar se você inicializou no modo UEFI, verifique se o diretório /sys/firmware/efi foi criado.
  • Todos os arquivos e diretórios aparecem sob o diretório raiz /, mesmo se eles estiverem armazenados em dispositivos físicos diferentes.
  • Edite /etc/resolv.conf, substituindo os endereços IP de seus servidores de nomes e seu nome de domínio local.
  • Antes de instalar, você pode desejar editar o arquivo mirrorlist e colocar seu espelho ("mirror") preferido primeiro.
  • Para que módulos de kernel carreguem durante o boot, coloque um arquivo .conf com um nome baseado no programa que os usa em /etc/modules-load.d/.
  • Cada partição é identificada como um sufixo numérico. Por exemplo, sda1 especifica a primeira partição da primeira unidade, enquanto sda designa toda a unidade.

Palavras genéricas usadas em uma forma inadequada ou questionáveis

Use "aspas duplas comuns".

Exemplo
  • Palavras/letras quando referencias como meras "entidades de texto".

Texto de GUI/TUI

Use itálico. Por exemplo, para entradas de menu. Ao representar navegação de menus, uso o símbolo ">", ainda em itálico, para separar os itens.

Exemplos
  • Então, selecione Boot Arch Linux a partir do menu e pressione Enter para começar a instalação.
  • Ao usar o Gparted, selecione a opção para criar uma nova tabela de partição fornece uma tabela de partição msdos por padrão. Se você tem intenção de seguir o conselho de criar uma tabela de partição GPT, então você precisa escolher Avançado e então selecionar gpt a partir do menu suspenso.
  • Digite sim para escolher Sair (ou pressione Q) para sair sem fazer mais alterações.
  • Para os plugins serem atualizados, você deve marcar para ter seus repositórios de atualização habilitados em Janela > Preferências > Instalar/Atualizar > Locais de software disponíveis.

Parte importante de conteúdo de arquivo/linha de comando

Use negrito. Já que o conteúdo é código em si, quando referenciado fora de um template, monoespaço deve ser preservado.

Exemplo
  • # ln -s /usr/src/linux-$(uname -r)/include/generated/uapi/linux/version.h /usr/src/linux-$(uname -r)/include/linux/
Você pode substituir $(uname -r) com algum kernel que não está sendo usado no momento.

Teclas do teclado

Use monoespaço.

Exemplo
  • Você tem que pressionar uma tecla (geralmente Delete, F1, F2, F11 ouF12) durante o processo de inicialização.

Nomes de pacote e grupo

Use itálico. Afetado por #Primeiras instâncias.

Exemplo
  • O pacote wireless_tools fornece, então, um conjunto básico de ferramentas para gerenciar as conexões de rede sem fio.

Pseudo-variáveis no conteúdo de arquivo/linha de comando

Use itálico. Ao mencionar uma variável fora do template, monoespaço deve ser preservado.

Certifique-se de que as variáveis não contêm espaços: deve-se usar sublinhado em lugar de espaço.

Garanta a consistência de nomenclatura com o resto do artigo, que já pode usar uma pseudo-variável. Por exemplo, não introduza uma nova variável layoutteclado, se layout_teclado já é usada.

Exemplo
  • # loadkeys layout_teclado
[...] sendo layout_teclado pode ser fr, uk, dvorak, be-latin1 etc.
  • Levante a interface com ip link set interface up.
  • Você pode conectar à rede com:
# wifi-menu nome_interface
sendo nome_interface a interface de seu dispositivo de conexão sem fio.

Citações

Para citações em linha, use "aspas duplas comuns". Para citações em bloco, use recuo por meio de caractere de dois pontos no início da linha sem qualquer pontuação ou formatação adicional.

Exemplos
O projeto X.Org fornece uma implementação de código aberto do X Window System (ou "sistema de janela X"). O trabalho de desenvolvimento está sendo feito junto com a comunidade freedesktop.org. A X.Org Foundation é a corporação sem fins lucrativos cuja diretoria fornece esse esforço e cujos membros lideram esse trabalho.

Referências a títulos, cabeçalhos...

Use "aspas duplas comuns". Ao referenciar títulos de seção, porém, use links de âncora ([[#Seção]]).

Exemplo
  • A coluna "dm-crypt +/- LUKS" denota recursos de dm-crypt para ambos modos de criptografia LUKS ("+") e simples ("-"). Se um recurso específico exige usar LUKS, isso é indicado por "(com LUKS)". Da mesma forma, "(sem LUKS)" indica uso de LUKS é contraproducente para atingir o recurso e o modo simples deve ser usado.

Nomes de repositório

Use itálico para nomes de repositório. Afetado por #Primeiras instâncias.

Exemplo
  • Para habilitar o repositório testing, você tem que descomentar a seção [testing] no /etc/pacman.conf.
  • Se você habilitou o repositório testing, você deve também habilitar o repositório community-testing.

Palavras ou declarações estressadas/fortes

Use itálico para palavras cuja importância em dar o significado para uma sentença não seria reconhecido sem isso; geralmente elas são pronunciadas em uma forma destacada ao ler em voz alta.

Porém, atenção especial é necessária, pois palavras como "não", "apenas", "exatamente", "fortemente", "antes"... podem ser realçadas em negrito.

O mesmo vale para declarações muito importantes que não podem estar em um Atenção ou Nota (templates especiais do wiki), pois eles são partes essenciais da seção em si.

Exemplos
  • Escolha o melhor ambiente para as suas necessidades.
  • Esse comando pode sincronizar a base dados de repositório e atualizar os pacotes do sistema.
  • Se a tela não apagar e o processo de inicialização ficar travado.
  • [...] então, por favor, digite-o exatamente como você o vê.
  • Se você quiser, você pode torná-lo o único espelho disponível se livrando de todos os outros.
  • Particionamento pode destroir dados. Recomenda-se fortemente a ter cuidado e a fazer backup de quaisquer dados críticos antes de proceder.
  • Mantenha-se atualizado com as alterações no Arch Linux que exijam intervenção manual antes de atualizar seu sistema.
  • Ao realizar uma atualização de sistema, é essencial que os usuários leiam as informações de saída pelo pacman e usem o senso comum.
  • Isso significa que não há suporte a atualizações parciais.

Termos técnicos

Use itálico, exceto para termos todos em maiúsculo (geralmente acrônimos). Afetado por #Primeiras instâncias.

Exemplos
  • Você é incentivado a digitar man comando para ler a página man de qualquer comando.
  • Esse artigo lida com os utilitários chamados de centrais em um sistema GNU/Linux.
  • Partições primárias podem ser inicializadas e estão limitadas a quatro partições por disco ou volume RAID.
  • Essa já é uma partição separada por padrão, em virtude de ser montada como tmpfs pelo systemd.
  • Você tem que pressionar uma chave (geralmente Delete, F1, F2, F11 ou F12) durante o fase de POST (Power On Self-Test ou "autoteste de inicialização").

Palavras/letras quando referenciados como meras "entidades de texto"

Use "aspas duplas simples".

Exemplos
  • Quando, porém, atenção especial é necessária, palavras como "não", "somente", "exatamente", "fortemente", "antes"... pode ser realçada em negrito.
  • Se você não tem certeza, sua interface Ethernet provavelmente deve iniciar com a letra "e" e é improvável de ser lo ou iniciar com a letra "w".