[ anterior ] [ Nota de Copyright ] [ Conteúdo ] [ próximo ]

Manual Debiandoc-SGML - Capítulo 4
Texto marcado inline e marcação do estilo de caracteres


Texto ordinário (chamado "texto inline" neste documento) pode conter elementos para formação especial e referência cruz. Texto inline aparece em capítulo, apêndice e títulos de seções, em aviso de copyright, dentro de parágrafos e em outros lugares parecidos.


4.1 Estilo do Caracter

Existem um número de elementos para denotar certas partes especiais de texto. Para todos eles um texto especial pdoe ser marcado explicitamente, usando uma tag final <element>, a tag final para fechamento para elementos </> ou barra / que finaliza a forma mais abreviada de marcação de elementos (see Marcação SGML e metacaracteres, Capítulo 1).

<em> - ênfase
Indica que o texto contido é mais importante ou mais significante que o resto.

Normalmente isto será representado por itálicos se disponível, ou texto icentivado ou sublinhado, ou em formatos de texto planos colocando o texto entre asteriscos como *este*.

<strong> - mais ênfase
Indica que o texto contido é ainda mais importante ou ainda mais significante que o resto.

Tipicamente isto será representado por negrito se disponível ou em formato texto plano com texto entre asterisco como *este*.

<var> - variável metasintática
Indica que o texto contido é uma variável matasintática. Ou seja, ele é uma peça de objeto da sintáxe que é usado para ter uma valor real substituido.

Normalmente isto será representado por itálicos, em em formato texto plano com sinais de maior e menor como <este>. Se muitas variáveis metasintáticas são mostradas uma após as outras eles devem cada uma ser seguidas de seu próprio elemento <var>.

<package> - nome do pacote
Indica que o texto contido é o nome de um pacote Debian.

Isto é normalmente feito usando uma fonte com largura fixa; em formato texto plano quotas são usadas em torno do elemento.

<prgn> - nome do programa ou arquivo conhecido
Indica que o texto contido é o nome de um programa, um arquivo conhecido (normalmente sem o caminho), uma função ou alguma coisa parecida que tem um nome no computador.

Em formatos de saída onde o sublinhado de caracter e vários estilos de fontes estão disponíveis este é normalmente representado com uma fonte de largura fixa. Em texto plano, estes nomes não são especialmente marcados, ocorre a introdução de quotas no fluxo do texto.

<file> - arquivo completo ou nome de diretório
Indica que o texto contido é o caminho completo de um arquivo, buffer, diretório, etc.

Iste é normalmente feito usando uma fonte com largura fixa; em formato texto plano, quotas podem ser usadas em torno do elemento.

<tt> - código ou fragmento de saída, comando string
Indica que o texto contido é um string geral que vem de fora do computador. Ele deve ser usado para comandos ou fragmentos de çodigo que devem ser mostrados na linha de comando ou palavras (veja Exemplos, Seção 5.2 para uma alternativa), e assim por diante. Ele é frequentemente necessário para introduzir variáveis metasintáticas nestas strings, em que elas devem fazer parte do elemento <tt> ao invés de elementos dentro dela.

Isto é normalmente feito usando uma fonte com largura fixa; em formatos texto plano quotas podem ser usadas ao redor do elemento.

<qref id="refid"> - Referência quieta
Produz uma "referência quieta" para identificação de referência nomeada (see Referências Cruzadas, Seção 4.2). Isto deve ser usada onde uma referência cruzada pode ser útil mas não intrusiva, mas onde não é essencial.

Em formatos onde referências cruzadas podem ser feitas não intrusivamente fazendo uma região do texto um hyperlink sem introduzir textos inline este elemento causará seu texto contido se tornar um hyperlink para o alvo da referência cruzada. Em outros formatos este elemento não tem nenhum efeito.


4.2 Referências Cruzadas

Existem um número de elementos para introduzir referências cruzadas ou para outras partes do mesmo documento ou para outros documentos.

As referências cruzadas para documentos internos são baseadas no esquema de identificação de referências. Cada capítulo, apêndice, seção, subseção etc. Pode ter um atributo id passando sua referência de identificação - por exemplo <chapt id="spong"> especifica que o capítulo ou apêndice iniciado tem a referência de identificação spong. Esta referência de identificação pode então ser referida em outras partes do documento usando elementos especiais de referência cruzada.

O identificador de referência poderá também ser usado para gerar nomes de arquivos e referências para formatos tal como HTML que produzem diversos arquivos de saída; se nenhuma identificação de referência é especificada então o capítulo, apêndice ou números de seções serão usadas. É uma boa idéia identificar no mínimo suas referências de apêndice ou capítulos assim aqueles nomes de arquivos não serão alterados se você alterar a ordem daqueles capítulos, seções ou apêndices em seu documento.

<ref id="refid"> - referências cruzadas no documento completo
Isto gera uma referência cruz dentro do mesmo documento para o capítulo, apêndice ou seção com id refid.

O elemento <ref> não tem nenhum conteúdo; o capítulo, apêndice ou número de seção e titulo e seu número de página ou tudo que é apropriado para o formato de saída será inserido no texto no ponto onde a tag aparece.

Sintaticamente a referência cruzada é um substantivo de frase, satisfatório para usuários como (veja <ref id="...">) ou informações mais adiante em <ref id="...">..

<manref name="name" section="section"> - manpage
Gera uma referência cruz para uma manpage para name na seção seção. Esta tag não possui nenhum conteúdo; texto descrevendo a página, tipicamente name(section), será insrido no ponto onde <manref> aparece.

<email> - endereço de email
Indica que o texto contido é um endereço de email. O conteúdo da tag deve ser simplesmente o texto do endereço de email; marcação de estilo de carecteres e referências cruzadas são proibidas. Normalmente a tag final </email> não pode ser omitida, mas ele pode ser deixado fora quando aparece em uma <author> como o final de <author>, implicado pelo inicio do próximo elemento, implicando no final do endereço de email.

Em muitos formatos isto gerará uma referência cruzada que pode (por exemplo) ser usada para enviar endereço de e-mail para o endereço citado. Em outros será simplesmente uma marcação para um texto especial, incluindo sinais de maior e menor < > em torno dele.

<ftpsite> - nome de site FTP anônimo

<ftppath> - caminho dos arquivos FTP site
<ftpsite> indica que o conteúdo do elemento é um nome DNS de uma site FTP anônimo, e <ftppath> que é um caminho no site. Ambos elementos não podem conter qualquer marcação de estilo de caracteres ou referência cruz.

Tipicamente ambos elementos serão feitos em fonte fixa; se possível, o <ftppath> será feito em um hyperlink funcional para o site <ftpsite>.

<ftppath> deve sempre ser precedido por um <ftpsite> no mesmo capítulo, ou apêndice, mas uma vez que um site foi nomeado vários caminhos podem ser definidos.

<httpsite> - Nome de site HTTP

<httppath> - caminho para o site HTTP
<httpsite> indica que o conteúdo do elemento é um nome DNS de um site HTTP, e <httppath> que é o caminho naquele site. Ambos elementos não podem conter qualquer estilo de caracter ou referência cruz.

Normalmente ambos elementos serão feitos em fonte fixa; Se possível, <httppath> será feita em um hyperlink funcional para os arquivos nomeados no diretório mais recente. <httpsite>.

<httppath> deve sempre ser procedida de um <httpsite> no mesmo capítulo ou apêndice, mas uma vez que o site foi nomeado varios caminhos podem aparecer.

<url id="id" name="name"> - URL
Gera uma referência cruz para a URL com a identificação id e usa o name para ser mostrado no documentono ao invés da id. Esta tag não contem qualquer conteúdo.

Normalmente este elemento será criado em fonte fixa; Se possível, id será feito em um hyperlink funcional usando name como identificação.


4.3 Footnotes

Footnotes pode aparecer em muitos textos inline, e são indicados por <footnote>...</footnote>. O texto de footnote será removido e colocado em outro lugar (onde depende do formato), e troca com uma referência ou hyperlink para footnote.

O conteúdo do footnote deve conter um ou mais parágrafos; o inicio do primeiro parágrafo não precisa ser marcado explicitamente. Elementos de marcação inline como um estilo de caracter não fazem efeito no conteúdo do footnotes definido dentro dele - o footnote é um trecho limpo.

Footnote pode ser aninhado, mas é raramente uma boa idéia.


[ anterior ] [ Nota de Copyright ] [ Conteúdo ] [ próximo ]
Manual Debiandoc-SGML
22 November 1999
Ian Jackson ijackson@gnu.ai.mit.edu
Ardo van Rangelrooij ardo@debian.org