1. Convenções de Documentos
Este manual usa diversas convenções para destacar certas palavras e frases e chamar a atenção para informações específicas.
Em PDF e edições de texto, este manual usa tipos de letras retiradas do conjunto de Fontes
Liberation Fonts. O conjunto de Fontes Liberation Fonts, também é usado em formato HTML, caso o conjunto esteja instalado em seu sistema. Caso ainda não esteja, como forma alternativa, estão disponíveis tipos de letras equivalentes. Nota: O Red Hat Enterprise Linux 5 e versões mais recentes do mesmo, incluem o conjunto Liberation Fonts por padrão.
1.1. Convenções Tipográficas
São usadas quatro convenções tipográficas para realçar palavras e frases específicas. Estas convenções, e circunstâncias a que se aplicam, são as seguintes:
Negrito Espaço Único (Mono-spaced Bold)
Usada para realçar entradas do sistema, incluindo comandos de shell, nomes de arquivos e caminhos. São também usadas para realçar tecla de Maiúsculas/Minúsculas e as combinações de teclas. Por exemplo:
Para ver o conteúdo do arquivo my_next_bestselling_novel em sua pasta de trabalho atual, insira o comando cat my_next_bestselling_novel na janela de solicitação e pressione Enter para executar o comando.
O comando acima inclui um nome de arquivo, um comando de shell e uma tecla cap, todos apresentados em Negrito Espaço Único (Mono-spaced Bold) e todos distintos, graças ao conteúdo.
As combinações de Teclas podem ser diferenciadas da tecla Caps Lock por um hífen, conectando cada parte de uma combinação de teclas. Por exemplo:
Pressione Enter para executar o comando.
Pressione Ctrl+Alt+F1 para mudar para o primeiro terminal virtual. Pressione Ctrl+Alt+F7 para voltar para sua sessão do X-Windows.
A primeira sentença, destaca uma tecla específica a ser pressionada. A segunda destaca dois conjuntos de três teclas, pressionadas simultaneamente.
Caso o código fonte seja discutido, serão apresentados os nomes de classe, métodos, funções, nomes de variantes e valores retornados mencionados em um parágrafo, em Negrito de Espaço Único (Mono-spaced Bold). Por exemplo:
Classes baseadas em arquivo, incluem filesystem para sistemas de arquivo, file para arquivos, e dir para diretórios. Cada classe possui seu conjunto próprio de permissões associadas.
Negrito Proporcional
Esta representa as palavras e frases encontradas no sistema, incluindo os nomes de aplicativos, texto de caixa de diálogo, botões rotulados, caixa de seleção e rótulos de botão de opção, títulos de menus e sub-menus. Por exemplo:
Escolha a partir da barra de menu para obter Preferências de Mouse. Na aba Botões, clique na caixa de seleção Mouse para mão esquerda e clique em Fechar para mudar o botão do mouse anterior da esquerda para a direita (deixando-o assim, mais adequado para o uso do canhoto).
Para inserir um caractere especial em um arquivo gedit, escolha a partir da barra de menu principal. Depois, escolha a opção a partir da barra de menu Mapa de Caracteres , digite o nome do caractere no campo Pesquisar e clique em Próximo. O caractere que você buscou estará em destaque na Tabela de Caracteres. Clique novamente nestes caracteres realçados para colocá-los no campo Texto para cópia e depois clique em Copiar. Agora mude novamente para seu documento e escolha a partir da barra de menu do gedit.
O texto acima inclui nomes de aplicativos, nomes de menu e itens de todo o sistema, nomes de menu específicos do aplicativo, e botões e textos encontrados na Interface Gráfica GUI, todos apresentados em Negrito Proporcional (Proportional Bold) e todos diferenciados de acordo com o contexto.
Observe o símbolo usado para indicar a passagem entre um menu e seus sub-menus. Isto acontece para evitar dificuldades de manuseio do 'Selecione a partir do submenu no menu da barra de menu principal'.
Itálico em Negrito de Espaço Único (Mono-spaced Bold Italic)Itálico em Negrito Proporcional (Proportional Bold Italic)
Sendo o Negrito Espaço Único (Mono-spaced Bold) ou Negrito Proporcional (Proportional Bold), os itálicos extras indicam textos substituíveis ou variáveis. O Itálico denota o texto que você não inseriu literalmente ou textos exibidos que mudam dependendo das circunstâncias. Por exemplo:
Para conectar-se à uma máquina remota usando o ssh, digite ssh nome do usuário@domain.name na janela de comandos. Por exemplo, considre que a máquina remota seja example.com e seu nome de usuário nesta máquina seja john, digite ssh john@example.com.
O comando mount -o remount file-system remonta o sistema de arquivo nomeado. Por exemplo, para remontar o sistema de arquivo /home, o comando é mount -o remount /home.
Para ver a versão de um pacote instalado, use o comando rpm -q package. Ele retornará um resultado como este: package-version-release
Observe as palavras em negrito e itálicas acima — nome de usuário, nome do domínio, sistema de arquivo, pacote, versão e lançamento. Cada palavra é um espaço reservado, tanto para o texto que você inseriu ao emitir um comando ou para o texto exibido pelo sistema.
Além de uso padrão para apresentar o título de um trabalho, os itálicos denotam a primeira vez que um termo novo e importante é usado. Por exemplo:
Quando o Servidor Apache HTTP aceita as requisições, ele despacha os processos filhos ou verificações para que possa manuseá-los. Este grupo de processos filhos ou verificações é conhecido como um server-pool. No Apache HTTP Server 2.0, a responsabilidade de criar e manter estes server-pools foram obtidas de um grupo de módulos chamado Multi-Processing Modules (MPMs). Diferenciando de outros módulos, somente um módulo do grupo MPM pode ser carregado pelo Servidor Apache HTTP.
1.2. Convenções de Pull-Quote
Dois tipos de dados, geralmente com múltiplas linhas, são estabelecidos com base no contexto.
O resultado enviado à um terminal é configurado em Romano de Espaço Único (Mono-spaced Roman) e apresentado assim:
books Desktop documentation drafts mss photos stuff svn
books_tests Desktop1 downloads images notes scripts svgs
As listas de código fonte também são configuradas em Romano de Espaço Único (Mono-spaced Roman), porém são apresentadas e realçadas como a seguir:
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient
{
public static void main(String args[])
throws Exception
{
InitialContext iniCtx = new InitialContext();
Object ref = iniCtx.lookup("EchoBean");
EchoHome home = (EchoHome) ref;
Echo echo = home.create();
System.out.println("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
}
}
E por fim, usamos três estilos visuais para chamar a atenção para informações que possam passar despercebidas.
Nota
Uma nota é uma dica ou símbolo, ou ainda uma opção alternativa para a tarefa em questão. Se você ignorar uma nota, provavelmente não resultará em más consequências, porém poderá deixar passar uma dica importante que tornará sua vida mais fácil.
Importante
Caixas importantes detalham coisas que são geralmente fáceis de passarem despercebidas: mudanças de configuração que somente se aplicam à sessão atual, ou serviços que precisam ser reiniciados antes que uma atualização seja efetuada. Se você ignorar estas caixas importantes, não perderá dados, porém isto poderá causar irritação e frustração.
Aviso
Um Aviso não deve ser ignorado. Se você ignorar avisos, muito provavelmente perderá dados.