[RFR] ddp://manuals.sgml/debiandoc-sgml-doc-pt-br/inline.sgml
Olá colegas,
Segue em anexo a tradução para revisão, juntamente com o original em inglês.
Antecipadamente grato,
--
Marcelo G. Santana(darkstar) GNU/Linux User number #208778
JID:marcelo.santana@jabber.org GNU Privacy Guard ID: 5BECD54C
Blog:Tempestade de Idéias - http://marcelosantana.wordpress.com
Projeto Debian Brasil - http://www.debianbrasil.org
<chapt id="inline">
<heading>Marked-up inline text and character style markup</heading>
<p>
Ordinary text (called `inline text' in this document) may contain
a elements for special formatting and cross-referencing. Inline
text appears in chapter, appendix and section titles, in the
copyright summary, inside paragraphs and in other similar places.
</p>
<sect>
<heading>Character style</heading>
<p>
There are a number of elements for denoting special significance
of certain pieces of text. For all of them the end of the
special text must be marked up explicitly, by using an explicit
end tag <tt><<var>element</var>></tt>, the abbreviated end
tag for closing the innermost element <tt></></tt> or the
slash <tt>/</tt> which finishes the most abbreviated form of
element markup (see <ref id="markup">).
</p>
<p>
<taglist>
<tag>
<tt><em></tt> - emphasis
</tag>
<item>
<p>
Indicates that the contained text is more important or
more significant than that surrounding it.
</p>
<p>
Typically this will be represented by italics if
available, or emboldened or underlined text, or in plain
text formats with no character highlighting available by
surrounding the text with asterisks like *this*.
</p>
</item>
<tag>
<tt><strong></tt> - more emphasis
</tag>
<item>
<p>
Indicates that the contained text is even more important
or even more significant than that surrounding it.
</p>
<p>
Typically this will be represented by bold if available or
in plain text formats with no character highlighting
available by surrounding the text with asterisks like
*this*.
</p>
</item>
<tag>
<tt><var></tt> - metasyntactic variable
</tag>
<item>
<p>
Indicates that the contained text is a metasyntactic
variable. Ie, it is the name of an object or piece of
syntax which when actually used would have a real value
substituted.
</p>
<p>
Typically this will be represented by italics, or in plain
text formats by surrounding the text with angle brackets
like <this>. If several metasyntactic variables
appear one after the other they should each be given their
own <tt><var></tt> element.
</p>
</item>
<tag>
<tt><package></tt> - package name
</tag>
<item>
<p>
Indicates that the contained text is the name of a Debian
package.
</p>
<p>
This will usually be rendered using a fixed-width font; in
plain-text formats quotes may be used around the element.
</p>
</item>
<tag>
<tt><prgn></tt> - name of a program or well-known file
</tag>
<item>
<p>
Indicates that the contained text is the name of a
program, a well-known filename (usually without paths), a
function or some similar thing which has a name in the
computer.
</p>
<p>
In output formats where character highlighting and various
font styles are available this is usually represented by
using a fixed-width font. In plain text output formats
quotes may be used around the element.
</p>
</item>
<tag>
<tt><file></tt> - full file or directory name
</tag>
<item>
<p>
Indicates that the contained text is the full pathname of
a file, buffer, directory, etc.
</p>
<p>
This will usually be rendered using a fixed-width font; in
plain-text formats quotes may be used around the element.
</p>
</item>
<tag>
<tt><tt></tt> - code or output fragment, command string
</tag>
<item>
<p>
Indicates that the contained text is a general string
which came out of or is going in to a computer. It should
be used for command strings or code fragments that should
be displayed inline and wordrapped (see also <ref
id="examples"> for an alternative), and so forth. It is
frequently necessary to introduce metasyntactic variables
into these strings, in which case they should be made part
of the <tt><tt></tt> element rather than elements
alongside it.
</p>
<p>
This will usually be rendered using a fixed-width font; in
plain-text formats quotes may be used around the element.
</p>
</item>
<tag>
<tt><qref id="<var>refid</var>"></tt> - quiet reference
</tag>
<item>
<p>
Produces a `quiet reference' to the named reference id
(see <ref id="xref">). This should be used where a
cross-reference would be useful if not intrusive, but
where it is not essential and should be left out if it
would need to intrude on the text.
</p>
<p>
In formats where cross-references can be made
non-intrusively by making a region of text a hyperlink
without introducing in-line text this element will cause
its contained text to become a hyperlink to the target of
the cross-reference. In other formats this element will
not have any effect.
</p>
</item>
</taglist>
</p>
</sect>
<sect id="xref">
<heading>Cross-references</heading>
<p>
There are a number of elements for introducing cross-references
either to other parts of the same document or to other
documents.
</p>
<p>
The intra-document cross-references are based on a scheme of
reference identifiers. Each chapter, appendix, section,
subsection etc. may have an <tt>id</tt> attribute giving its
reference id - for example <tt><chapt id="spong"></tt>
specifies that the chapter or appendix being started has
reference id <tt>spong</tt>. This reference id can then be
referred to in other parts of the document using the special
cross-referencing elements.
</p>
<p>
The reference identifier will also be used for generating
filenames and reference tokens for formats such as HTML which
produce several output files; if no reference ids are specified
then the chapter, appendix and section numbers will be used. It
is a good idea to give at least all your chapter and appendix
reference ids so that the filenames will not change if you
change the order of the chapters, appendices or sections in your
document.
</p>
<p>
<taglist>
<tag>
<tt><ref id="<var>refid</var>"></tt> - intra-document
cross reference
</tag>
<item>
<p>
This generates a cross-reference within the same document
to the chapter, appendix or section with id
<var>refid</var>.
</p>
<p>
The <tt><ref></tt> element does not have any
contents; the chapter, appendix or section number and
title and its page number or whatever is appropriate for
the output format will be inserted into the text at the
point where the tag appears.
</p>
<p>
Syntactically the cross reference is a noun phrase,
suitable for uses like <tt>(see <ref
id="<var>...</var>">)</tt> or <tt>further info is in
<ref id="<var>...</var>">.</tt>.
</p>
</item>
<tag>
<tt><manref name="<var>name</var>"
section="<var>section</var>"></tt> - manpage
</tag>
<item>
<p>
Generates a cross-reference to the manpage for
<var>name</var> in section <var>section</var>. This tag
does not have any contents; text describing the page,
typically <tt><var>name</var>(<var>section</var>)</tt>,
will be inserted at the point where
<tt><manref></tt> appears.
</p>
</item>
<tag>
<tt><email></tt> - email address
</tag>
<item>
<p>
Indicates that the contained text is an email address. The
contents of the tag should be just the text of the email
address itself; character style markup and
cross-references are forbidden. Usually the end tag
<tt></email></tt> may not be omitted, but it may be
left out when it appears in an <tt><author></tt> as
the end of the <tt><author></tt>, implied by the
start of the next element, will imply the end of the email
address.
</p>
<p>
In some formats this will generate a true cross-reference
which might (for example) be used to send email to the
address quoted. In others it will just mark the text
specially, usually including angle brackets <tt><</tt>
<tt>></tt> around it.
</p>
</item>
<tag>
<tt><ftpsite></tt> - anonymous FTP site name
</tag>
<tag>
<tt><ftppath></tt> - path on most recently named FTP site
</tag>
<item>
<p>
<tt><ftpsite></tt> indicates that the content of the
element is the DNS name of an anonymous FTP site, and
<tt><ftppath></tt> that it is a pathname on that
site. Both elements may not contain any character style
markup or cross-references.
</p>
<p>
Typically both elements will be rendered in a fixed width
font; if possible, the <tt><ftppath></tt> will be
made into a functional hyperlink to the named file or
directory on the most recent <tt><ftpsite></tt>.
</p>
<p>
<tt><ftppath></tt> must always have been preceded by
a <tt><ftpsite></tt> in the same chapter or
appendix, but once one site has been named several paths
may be appear.
</p>
</item>
<tag>
<tt><httpsite></tt> - HTTP site name
</tag>
<tag>
<tt><httppath></tt> - path on most recently named HTTP site
</tag>
<item>
<p>
<tt><httpsite></tt> indicates that the content of
the element is the DNS name of an HTTP site, and
<tt><httppath></tt> that it is a pathname on that
site. Both elements may not contain any character style
markup or cross-references.
</p>
<p>
Typically both elements will be rendered in a fixed width
font; if possible, the <tt><httppath></tt> will be
made into a functional hyperlink to the named file or
directory on the most recent <tt><httpsite></tt>.
</p>
<p>
<tt><httppath></tt> must always have been preceded
by a <tt><httpsite></tt> in the same chapter or
appendix, but once one site has been named several paths
may be appear.
</p>
</item>
<tag>
<tt><url id="<var>id</var>"
name="<var>name</var>"></tt> - URL
</tag>
<item>
<p>
Generates a cross-reference to the URL with the indicated
<var>id</var> and uses the optional <var>name</var> in the
document as reference indicator. This tag does not have
any contents.
</p>
<p>
Typically this element will be rendered in a fixed width
font; if possible, <var>id</var> will be made into a
functional hyperlink using <var>name</var> as place
holder.
</p>
<p>
Do not put this tag between <file> and </file>.
This is known to break relative link in PDF format.
</p>
</item>
</taglist>
</p>
</sect>
<sect id="footnotes">
<heading>Footnotes</heading>
<p>
Footnotes may appear in most inline text, and are indicated by
<tt><footnote><var>...</var></footnote></tt>. The
text of the footnote itself will be removed and placed elsewhere
(where depends on the format), and replaced with a reference or
hyperlink to the footnote.
</p>
<p>
The contents of the footnote should be one or more paragraphs;
the start of the first paragraph need not be marked explicitly.
Inline markup elements such as character style do not take
effect on the contents of footnotes defined inside them - the
footnote gets a `clean slate'.
</p>
<p>
Footnotes may be nested, but this is rarely a good idea.
</p>
</sect>
<sect id="comment">
<heading>Comment</heading>
<p>
Comments may appear in most inline text, and are indicated by
<tt><comment editor="foo"><var>...</var></comment></tt>.
The text of the comment itself will be removed and placed elsewhere
(where depends on the format), and replaced with a reference or
hyperlink to the footnote if -m option is used to enable this.
</p>
<p>
The contents of the comment should be one or more paragraphs;
the start of the first paragraph need not be marked explicitly.
</p>
</sect>
</chapt>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:("../debiandoc-sgml.en.sgml" "book" "chapt")
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<chapt id="inline">
<heading>Texto incorporado com marcação e marcação do estilo de caracteres</heading>
<p>
Texto comum (chamado "texto incorporado" neste documento) pode
conter elementos para formatação especial e referência cruzada. Texto
incorporado aparece em capítulo, apêndice e títulos de seção, em aviso
de copyright, dentro de parágrafos e em outros lugares similares.
</p>
<sect>
<heading>Estilo do Caracter</heading>
<p>
Existe uma série de elementos para determinar um significado especial
de certas partes do texto. Para todos eles o fim do texto especial
deve ser marcado explicitamente, usando uma tag final explicita
<tt><<var>element</var>></tt>, a tag final abreviada para
fechamento de elementos mais próximo <tt></></tt> ou a
barra <tt>/</tt> que finaliza a maioria das formas abreviadas de
marcação de elemento (veja <ref id="markup">).
</p>
<p>
<taglist>
<tag>
<tt><em></tt> - ênfase
</tag>
<item>
<p>
Indica que o texto contido é mais importante ou mais
significante que o resto.
</p>
<p>
Normalmente esse será representado por itálico se
disponível, ou texto em negrito ou sublinhado, ou
em formatos de texto simples sem nenhum caracter de
destaque disponível delimitando o texto com
asteriscos como *este*.
</p>
</item>
<tag>
<tt><strong></tt> - mais ênfase
</tag>
<item>
<p>
Indica que o texto contido é ainda mais importante ou
ainda mais significante que o resto.
</p>
<p>
Normalmente isto será representado por negrito se
disponível ou em formatos de texto simples sem nenhum
caracter de destaque disponível delimitando o texto com
asteriscos como *este*.
</p>
</item>
<tag>
<tt><var></tt> - variável meta-sintática
</tag>
<item>
<p>
Indica que o texto contido é uma variável meta-sintática.
Ou seja, é o nome de um objeto ou peça da sintaxe que
quando atualmente usada terá um valor real substituído.
</p>
<p>
Normalmente isto será representado por itálico, ou em
em formatos de texto simples delimitando o texto com sinais
maior e menor como <este>. Se várias variáveis
meta-sintáticas aparecem uma após as outras, a cada uma deve
ser atribuído o seu próprio elemento <tt><var></tt>.
</p>
</item>
<tag>
<tt><package></tt> - nome do pacote
</tag>
<item>
<p>
Indica que o texto contido é o nome de um pacote Debian.
</p>
<p>
Isto normalmente será renderizado usando uma fonte com
largura fixa; em formatos de texto simples aspas podem ser
usadas em torno do elemento.
</p>
</item>
<tag>
<tt><prgn></tt> - nome de um programa ou arquivo conhecido
</tag>
<item>
<p>
Indica que o texto contido é o nome de um programa,
um nome de arquivo conhecido (normalmente sem o caminho),
uma função ou alguma coisa semelhante que tenha um nome
no computador.
</p>
<p>
Em formatos de saída onde o destaque de caracter e vários
estilos de fontes estão disponíveis esse é normalmente
representado pelo uso de uma fonte de largura fixa.
Em formatos de saída de texto simples aspas podem ser
usadas em torno do elemento.
</p>
</item>
<tag>
<tt><file></tt> - arquivo completo ou nome de diretório
</tag>
<item>
<p>
Indica que o texto contido é o caminho completo de um
arquivo, buffer, diretório, etc.
</p>
<p>
Isto normalmente será renderizado usando uma fonte de largura
fixa; em formatos de texto simples aspas podem ser usadas
em torno do elemento.
</p>
</item>
<tag>
<tt><tt></tt> - código ou fragmento de saída, string
de comando
</tag>
<item>
<p>
Indica que o texto contido é uma string geral que
vem de fora ou entrará em um computador. Ele deve
ser usado para strings de comandos ou fragmentos de código
que devem ser exibidos incorporados e com quebra de linha
automática (veja <ref id="examples"> para uma alternativa),
e assim por diante. É freqüentemente necessário para
introduzir variáveis meta-sintáticas nestas strings, no caso
em que elas devam fazer parte do elemento <tt><tt></tt>
ao invés de elementos juntamente com elas.
</p>
<p>
Isto normalmente será renderizado usando uma fonte de largura
fixa; em formatos de texto simples aspas podem ser usadas
em torno do elemento.
</p>
</item>
<tag>
<tt><qref id="<var>refid</var>"></tt> - Referência discreta
</tag>
<item>
<p>
Produz uma "referência discreta" para a id de referência
chamada (veja <ref id="xref">). Isto deve ser usado
onde uma referência cruzada for útil se não intrusiva,
mas onde não for essencial deve ser retirada, se necessitar
interferir no texto.
</p>
<p>
Em formatos onde referências cruzadas podem ser feitas
não intrusivamente fazendo uma região do texto um
hyperlink sem introduzir textos incorporados, este elemento
fará com que o texto contido se torne um hyperlink para
o alvo da referência cruzada. Em outros formatos este
elemento não terá nenhum efeito.
</p>
</item>
</taglist>
</p>
</sect>
<sect id="xref">
<heading>Referências Cruzadas</heading>
<p>
Existe uma série de elementos para se introduzir
referências cruzadas, quer para outras partes do mesmo
documento ou para outros documentos
</p>
<p>
As referências cruzadas entre documentos são baseadas em um
esquema de identificadores de referências. Cada capítulo,
apêndice, seção, subseção etc. Pode ter um atributo <tt>id</tt>
passando sua id de referência - por exemplo
<tt><chapt id="spong"></tt> especifica que o capítulo
ou apêndice iniciado tem id de referência <tt>spong</tt>.
Esta id de referência pode então ser referida em outras partes
do documento usando elementos especiais de referência cruzada.
</p>
<p>
O identificador de referência poderá também ser usado para
gerar nomes de arquivos e chaves de referências para formatos tal
como HTML que produzem diversos arquivos de saída; se nenhuma
id de referência for especificada então o capítulo, apêndice ou
números das seções serão usados. É uma boa idéia definir, pelo
menos, todas as ids dos seus capítulos e apêndices pois assim os
nomes dos arquivos não mudarão se você mudar a ordem dos capítulos,
seções ou apêndices em seu documento.
</p>
<p>
<taglist>
<tag>
<tt><ref id="<var>refid</var>"></tt> -
referências cruzadas entre documentos
</tag>
<item>
<p>
Isto gera uma referência cruzada dentro do mesmo documento
para o capítulo, apêndice ou seção com id <var>refid</var>.
</p>
<p>
O elemento <tt><ref></tt> não tem nenhum conteúdo;
o capítulo, apêndice ou número de seção e título e seu
número de página ou qualquer coisa que seja apropriada
para o formato de saída será inserido no texto no ponto
onde a tag aparece.
</p>
<p>
Sintaticamente a referência cruzada é um expressão substantiva,
adequada para para usos como <tt>(veja <ref
id="<var>...</var>">)</tt> ou <tt>informações
adicionais estão em <ref id="<var>...</var>">.</tt>.
</p>
</item>
<tag>
<tt><manref name="<var>name</var>"
section="<var>section</var>"></tt> - manpage
</tag>
<item>
<p>
Gera uma referência cruzada para a manpage para
<var>name</var> na seção <var>section</var>. Esta tag
não possui nenhum conteúdo; texto descrevendo a página,
tipicamente <tt><var>name</var>(<var>section</var>)</tt>,
será inserido no ponto onde <tt><manref></tt>
aparece.
</p>
</item>
<tag>
<tt><email></tt> - endereço de email
</tag>
<item>
<p>
Indica que o texto contido é um endereço de email.
O conteúdo da tag deve ser apenas o texto do endereço de
email em si; marcação de estilo de caracteres e
referências cruzadas são proibidas. Normalmente a tag
final <tt></email></tt> não pode ser omitida, mas
ela pode ser deixada de lado quando aparece em um
<tt><author></tt> como o final de
<tt><author></tt>, implícito pelo início do próximo
elemento, que implicará no fim do endereço de email.
</p>
<p>
Em alguns formatos isto irá gerar uma verdadeira referência
cruzada que poderia (por exemplo) ser usada para enviar
e-mail para o endereço citado. Em outros, apenas marcará o
texto especialmente, normalmente incluindo sinais de maior
e menor <tt><</tt> <tt>></tt> em torno dele.
</p>
</item>
<tag>
<tt><ftpsite></tt> - nome de site FTP anônimo
</tag>
<tag>
<tt><ftppath></tt> - caminho no site FTP nomeado mais
recentemente
</tag>
<item>
<p>
<tt><ftpsite></tt> indica que o conteúdo do
elemento é um nome DNS de uma site FTP anônimo, e
<tt><ftppath></tt> que é um caminho nesse site.
Ambos os elementos não podem conter nenhuma marcação
de estilo de caracteres ou referências cruzadas.
</p>
<p>
Normalmente ambos os elementos serão renderizados com uma
fonte de largura fixa; se possível, o <tt><ftppath></tt>
será feito em um hyperlink funcional para o arquivo nomeado
ou diretório no <tt><ftpsite></tt> mais recente.
</p>
<p>
<tt><ftppath></tt> deve sempre ser precedido
de um <tt><ftpsite></tt> no mesmo capítulo,
ou apêndice, mas uma vez que um site tenha sido nomeado
vários caminhos podem ser definidos.
</p>
</item>
<tag>
<tt><httpsite></tt> - Nome do site HTTP
</tag>
<tag>
<tt><httppath></tt> - caminho no site HTTP nomeado mais
recente
</tag>
<item>
<p>
<tt><httpsite></tt> indica que o conteúdo do
elemento é um nome DNS de um site HTTP, e
<tt><httppath></tt> que é o caminho neste site.
Ambos os elementos não podem conter nenhuma marcação
de estilo de caracteres ou referências cruzadas.
</p>
<p>
Normalmente ambos os elementos serão renderizados com uma
fonte de largura fixa; se possível, o <tt><httppath></tt>
será feito em um hyperlink funcional para o arquivo
nomeado ou diretório no <tt><httpsite></tt> mais recente.
</p>
<p>
<tt><httppath></tt> deve sempre ser precedido
de um <tt><httpsite></tt> no mesmo capítulo
ou apêndice, mas uma vez que um site tenha sido nomeado
vários caminhos podem aparecer.
</p>
</item>
<tag>
<tt><url id="<var>id</var>"
name="<var>name</var>"></tt> - URL
</tag>
<item>
<p>
Gera uma referência cruzada para a URL com a <var>id</var>
indicada e usa o <var>name</var> opcional no
documento como indicador de referência. Esta tag não
contém nenhum conteúdo.
</p>
<p>
Normalmente este elemento será renderizado com uma fonte
de largura fixa; se possível, <var>id</var> será feito em
um hyperlink funcional usando <var>name</var> como identificação.
</p>
<p>
Não ponha essa tag entre <file> e </file>.
É sabido que isso quebra o vínculo relativo em formato PDF.
</p>
</item>
</taglist>
</p>
</sect>
<sect id="footnotes">
<heading>Notas de Rodapé</heading>
<p>
Notas de rodapé podem aparecer na maioria dos textos incorporados, e
são indicadas por <tt><footnote><var>...</var></footnote></tt>.
O texto da nota de rodapé em si será removido e colocado em outro
lugar (onde depende do formato), e substituído por uma referência ou
hyperlink para a nota de rodapé.
</p>
<p>
O conteúdo da nota de rodapé deve conter um ou mais parágrafos;
o início do primeiro parágrafo não precisa ser marcado
explicitamente. Elementos de marcação incorporados, assim como
estilos de caracter, não fazem efeito no conteúdo da nota de
rodapé definido dentro dela - a nota de rodapé gera um
"trecho limpo".
</p>
<p>
A notas de rodapé podem ser aninhadas, mas raramente é uma boa idéia.
</p>
</sect>
<sect id="comment">
<heading>Comentários</heading>
<p>
Comentários podem aparecer na maioria dos textos incorporados,
e são indicados por <tt><comment editor="foo"><var>...
</var></comment></tt>.
O texto do comentário em si será removido e colocado em outra parte
(onde depende do formato), e substituído por uma referência ou
hyperlink para a nota de rodapé se a opção -m for usada para
habilitar isso.
</p>
<p>
Os conteúdos do comentário deve conter um ou mais parágrafos;
O início do primeiro parágrafo não precisa ser marcado explicitamente.
</p>
</sect>
</chapt>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:("../debiandoc-sgml.pt_BR.sgml" "book" "chapt")
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
Reply to: