Documentation 0.1

Common Content

Edição 0

Dude McDude

My Org Best Div in the place

Aviso Legal

Copyright © 2009 Red Hat, Inc.. This material may only be distributed subject to the terms and conditions set forth in the Open Publication License, V1.0, (the latest version is presently available at http://www.opencontent.org/openpub/).
Fedora and the Fedora Infinity Design logo are trademarks or registered trademarks of Red Hat, Inc., in the U.S. and other countries.
Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat Inc. in the United States and other countries.
All other trademarks and copyrights referred to are the property of their respective owners.
Documentation, as with software itself, may be subject to export control. Read about Fedora Project export controls at http://fedoraproject.org/wiki/Legal/Export.

(preface title goes here)

1. Convenções do Documento

Este manual utiliza várias convenções para destacar certas palavras ou frases, e chamar a atenção para partes específicas de informação.
Nas edições em PDF e papel, este manual utiliza caracteres retirados da Fonte Liberation. A Fonte Liberation também é utilizada nas edições HTML se estiver instalada no seu sistema. Caso contrário, uma alternativa equivalente será utilizada. Nota: O Red Hat Enterprise Linux 5 e posteriores incluem a Fonte Liberation por omissão.

1.1. Convenções tipográficas

Quatro convenções tipográficas são utilizadas para chamar a atenção para palavras e frases específicas. Estas convenções, e as circunstâncias em que se aplicam, são as seguintes.
Negrito Mono-espaçado
Utilizado para destacar entrada de dados, incluindo comandos no terminal, nomes de ficheiros e caminhos. Também é utilizado para destacar teclas especiais e combinações de teclas. Por exemplo:
Para ver o conteúdo do ficheiro o_meu_proximo_romance_top_de_vendas no seu directório actual de trabalho, insira cat o_meu_proximo_romance_top_de_vendas no terminal e carregue em Enter para executar este comando.
O parágrafo acima inclui um nome de ficheiro, um comando de terminal e uma tecla especial, todos apresentados em Negrito mono-espaçado e todos distinguíveis graças ao contexto.
Combinações de teclas podem ser distinguidas de tecla especiais pelo hífen ligando cada parte da combinação de teclas. Por exemplo:
Carregue em Enter para executar o comando.
Carregue em Ctrl+Alt+F1 para alternar para o primeiro terminal virtual. Carregue em Ctrl+Alt+F7 para regressar à sessão X-Windows.
A primeira frase destaca uma tecla especial específica a ser pressionada. A segunda destaca dois conjuntos de três teclas, cada conjunto a ser pressionado simultaneamente.
Se código-fonte é referenciado, nomes de classes, métodos, funções, nomes de variáveis e valores retornados mencionados num parágrafo serão apresentados como acima, em Negrito Mono-espaçado. Por exemplo:
Classes relativas a ficheiros incluem filesystem para o sistema de ficheiros, file para ficheiros e dir para directórios. Cada classe tem associado o seu próprio conjunto de permissões.
Negrito Proporcional
Este modo é utilizado com palavras ou frases encontradas no sistema, incluindo nomes de aplicações; texto em caixas de diálogo; rótulos de botões; rótulos de botões de escolha múltipla (check-box) e de escolha simples (radio); títulos de menus e sub-menus. Por exemplo:
Escolha Sistema > Preferências > Rato a partir da barra de menu principal para lançar a aplicação Preferências do Rato. No separador Botões, seleccione a opção Canhoto e carregue em Fechar para mudar o botão primário do rato da esquerda para a direita (tornando-o mais adequado para utilização pela mão esquerda).
Para inserir um caracter especial num documento do gedit, seleccione Aplicações > Acessórios > Mapa de Caracteres a partir da barra de menu principal. Depois, seleccione a opção Pesquisar > Procurar… a partir da barra de menus do Mapa de Caracteres, digite o nome do caracter no campo Pesquisar e carregue em Próximo. O caracter que procurava aparece destacado na Tabela de Caracteres. Faça um duplo-clique sobre o caracter pretendido para o colocar no campo Texto a copiar e carregue no botão Copiar. Mude novamente para o seu documento e seleccione Editar > colar a partir da barra de menus do gedit.
O texto acima inclui nomes de aplicações; nomes dos menus e itens de todo o sistema; nomes de menus específicos de aplicações; assim como botões e textos encontrados nas interfaces gráficas (GUI), todos apresentados em Negrito Proporcional e todos distinguíveis pelo contexto.
Repare no símbolo > utilizado para indicar a passagem entre menus e sub-menus. Isto evita a dificuldade, difícil de seguir, da abordagem 'Seleccione Rato a partir do sub-menu Preferências do menu Sistema existente na barra de menus principal'.
Itálico Negrito Mono-espaçado ou Itálico Negrito Proporcional
Quer se utilize Negrito Mono-espaçado ou Negrito Proporcional, a adição de Itálicos indicam texto variável ou substituível. O itálico indica texto que não foi literalmente inserido ou texto mostrado que varia dependendo das circunstâncias. Por exemplo:
Para ligar-se a uma máquina remota utilizando ssh, digite ssh username@domain.name numa consola. Se a máquina remota for example.com e o seu nome de utilizador é john, digite ssh john@example.com.
O comando mount -o remount file-system remonta o sistema de ficheiros indicado. Por exemplo, para remontar o sistema de ficheiros /home, o comando é mount -o remount /home.
Para ver a versão de um pacote instalado, utilize o comando rpm -q package. Este comando retorna um resultado como o seguinte: package-version-release.
Observe as palavras acima em negrito e itálicas — username, domain.name, file-system, package, version e release. Cada palavra pode ser substituída, tanto por texto que se insere quando se executa um comando ou por texto que é mostrado pelo sistema.
Para além da utilização normal para apresentar o título de uma obra, o modo itálico define a primeira utilização de um novo e importante termo. Por exemplo:
Quando o Servidor HTTP Apache aceita pedidos, ele cria processos filhos ou threads para responder aos mesmos. Este grupo de processos filho ou threads é conhecido como um server-pool. No Servidor HTTP Apache 2.0, a responsabilidade de criar e manter estes server-pools foi abstraída para um grupo de módulos designados Multi-Processing Modules (MPMs). Ao contrário de outros módulos, apenas um módulo do grupo MPM pode ser carregado pelo Servidor HTTP Apache.

1.2. Convenções de citações

Dois tipos de dados, normalmente com múltiplas linhas, são destacados visualmente do texto circundante.
Dados enviados para um terminal são definidos em Roman Mono-espaçada e apresentados assim:
books        Desktop   documentation  drafts  mss    photos   stuff  svn
books_tests  Desktop1  downloads      images  notes  scripts  svgs
As listagens de código-fonte também são apresentadas em Roman Mono-espaçada, contudo são apresentadas e destacadas como se pode ver 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"));
   }
   
}

1.3. Notas e Avisos

E para terminar, utilizamos três estilos visuais para chamar a atenção para informações que de outra forma podiam passar despercebidas.

Nota

Uma nota é uma dica ou atalho, ou ainda uma abordagem alternativa para a tarefa em questão. Ignorar uma nota, provavelmente, não trará consequências negativas, no entanto, poderá deixar passar uma dica importante que tornará sua vida mais fácil.

Importante

Caixas importantes chamam a atenção para coisas que são geralmente fáceis de passarem despercebidas: mudanças de configuração que somente se aplicam à sessão actual, ou serviços que precisam ser reiniciados antes que uma actualização seja efectuada. Ignorar estas caixas importantes, não provocará perda de dados, mas poderá provocar irritação e frustração.

Aviso

Um Aviso não deve ser ignorado. Ignorar avisos pode levar, quase de certeza, à perda de dados.

2. Nós precisamos da sua opinião!

Quando submeter um relatório de erro, não se esqueça de mencionar o identificador do manual: Common_Content
Se tiver uma sugestão para melhorar a documentação, tente ser o mais específico possível na sua sugestão. Se encontrou um erro, por favor, inclua o número da secção e algum texto circundante, para que possamos encontrá-lo facilmente.