Esse capítulo descreve as duas linguagens de marcação que você vai encontrar quando for contribuir para o projeto de documentação do FreeBSD. Cada seção descreve a linguagem de marcação, e detalha a marcação que você provavelmente vai querer usar ou que já está utilizando.
Estas linguagens de marcação contém um grande número de elementos, e as vezes pode ser confuso escolher qual elemento usar em uma situação específica. Esta seção apresenta os elementos que provavelmente você vai precisar e fornece exemplos de como utilizá-los.
Esta não é uma lista detalhada de elementos, uma vez que ela apenas ratifica a documentação de cada linguagem. O objetivo desta seção é listar os elementos mais úteis para você. Se você tiver alguma dúvida sobre qual a melhor forma de marcar um pedaço específico do seu documento, por favor, envie a sua dúvida para a lista de discussão do projeto de documentação do FreeBSD.
No restante deste documento, quando descrevermos um elemento como inline significará que o elemento pode ocorrer dentro de um bloco de elementos, que ele não acarretará em uma quebra de linha. Um elemento block, por comparação, irá causar uma quebra de linha (e outros processamentos) quando for encontrado.
O HTML, Linguagem de Marcação de Hypertexto,
é a linguagem de marcação escolhida para a
World Wide Web
. Maiores informações
podem ser encontradas em
http://www.w3.org/.
O HTML é utilizado para a marcação das
páginas do web site do FreeBSD. Ele não deveria ser
utilizado (geralmente) para marcar outros tipos de documentos
já que o DocBook
oferece uma maior
variedade de elementos. Consequentemente, você só
irá encontrar páginas em HTML se estiver escrevendo
para o web site.
O HTML já passou por algumas versões, 1, 2, 3.0, 3.2 e a última, 4.0 (disponível nas duas variantes, strict e loose).
Os HTML DTD's estão disponíveis na
coleção de ports
na pasta
textproc/html
. Eles
são automaticamente instalados como parte do
port
textproc/docproj
Existem vários IPF's para o HTML, os quais dependem da versão (também conhecida como nível) do HTML que você quer declarar compatível com seu documento.
A maioria dos documentos HTML no web site do
FreeBSD estão de acordo com a versão
loose
do HTML 4.0.
Um documento HTML é normalmente dividido em duas partes. A primeira é chamada de head, a qual contém meta-informações sobre o documento, tais como o seu título, o nome do autor, o documento pai e assim por diante. A segunda parte, o body é contém o conteúdo que vai ser exibido para o usuário.
Estas seções são indicadas pelos
elementos head
e body
,
respectivamente. Esses elementos estão contidos dentro
de um elemento html
de alto-nível.
Título do Documento
</title>
</head>
<body>
…
</body>
</html>O HTML permite a denotação de cabeçalho em seu documento, de até seis níveis diferentes.
O maior e mais proeminente cabeçalho é o
h1
, depois vem o h2
,
assim por diante até h6
.
O conteúdo dos elementos é o texto do cabeçalho.
h1
, h2
, e
outras Tags de Header.Uso:
Geralmente, uma página HTML deveria ter um
cabeçalho de primeiro nível
(h1
). Este poderia conter muitos
cabeçalhos de segundo nível
(h2
), os quais por sua vez podem conter
muitos cabeçalhos de terceiro nível. Cada
elemento h
deve ter o mesmo elemento, sendo que os elementos mais acima
na hierarquia estarão subtraídos de um. Deve-se evitar
buracos na numeração.n
hn
Uso:
O HTML suporta elementos formados de um único
parágrafo p
.
Um bloco de citação é uma citação estendida de outro documento que não deveria aparecer no parágrafo atual.
blockquote
Uso:
Você pode apresentar ao usuário três tipos de listas, ordenadas, desordenadas e de definição.
Tipicamente, cada entrada em uma lista ordenada, é numerada enquanto nas listas desordenadas serão processadas por um bullet point. Listas de definição são compostas de duas partes para cada entrada a primeira é o termo a ser definido, e a segunda, é a definição em si.
As Listas ordenadas, desordenadas e de
definição, são indicadas pelos
elementos ol
, ul
e
dl
, respectivamente.
Listas ordenadas e desordenadas contém itens de
lista, indicados pelo elemento li
. Um
item de lista pode conter texto, podendo inclusive conter
um ou mais elementos p
.
Listas de definição contém o termo
a ser definido (dt
) e a
descrição do termo (dd
).
A definição de um termo só pode conter
elementos inline
. A
descrição do termo pode conter elementos do
tipo block
.
ul
e ol
Uso:
dl
Uso:
Você pode indicar que o texto deve ser apresentado exatamente como esta no arquivo. Tipicamente, isto significa que o texto será mostrado em fonte fixa, múltiplos espaços não serão fundidos em um e que as quebras de linha no texto serão significativas.
Para fazer isto, envolva o conteúdo com o
elemento pre
:
pre
Você pode usar pre
para
marcar uma mensagem de email;
Tenha em mente que o <
e o
&
continuam sendo reconhecidos como
caracteres especiais em um texto pré-formatado.
É por isto que nos exemplos tivemos que utilizar
<
ao invés de
<
. Para manter a consistência,
o >
também foi utilizado
no lugar do >
. Fique atento para
caracteres especiais que podem aparecer em textos copiados
de origens não formatadas, como por exemplo, de uma
mensagem de email ou do código fonte de um
programa.
A maioria dos navegadores de modo texto (tal como o Lynx) não apresentam tabelas de maneira muito eficiente. Se você quiser que o seu conteúdo seja apresentado em forma de tabelas, você deve considerar outra marcação para evitar problemas.
Marque a informação tabular com o elemento
table
. Uma tabela consiste de uma ou
mais linhas (tr
), cada uma contendo uma
ou mais células de dados (td
).
As células podem conter outros elementos de bloco,
como parágrafos ou listas. Também pode
conter outra tabela (este aninhamento pode ser repetido
indefinidamente). Se a célula contém apenas
um parágrafo, então não é
necessário incluir o elemento p
.
table
Uso:
Uma célula pode se estender por muitas linhas
e colunas. Para indicar isto, coloque o atributo
rowspan
e/ou colspan
,
com valores que indiquem o número de linhas ou
colunas a serem ocupados.
rowspan
Uso:
colspan
Uso:
rowspan
e
colspan
juntosUso:
Você tem dois níveis de ênfase
disponíveis em HTML, em
e
strong
. O em
é
para uma ênfase simples e o strong
indica uma ênfase mais forte.
Em geral, em
é apresentada em
itálico e strong
é
apresentada em negrito. Mas nem sempre é assim, e
você não deve contar com isso.
em
e strong
Uso:
Uma vez que o HTML inclui marcação de
apresentação, você também pode
indicar que um conteúdo deve ser apresentado em
negrito ou itálico. Os elementos são
b
e i
respectivamente.
Se você tiver conteúdo que deve ser
apresentado em fonte fixa (typewriter), use
tt
(de “teletipo”).
tt
Uso:
Você pode indicar que o conteúdo deve ser apresentado em uma fonte maior ou menor. Existem três maneiras de fazer isto:
Use big
e
small
em torno do texto que você deseja mudar o
tamanho. Estas tags podem ser aninhadas, assim
<big><big>Este é muito
maior</big></big>
é
possível.
Use font
com o atributo
size
ajustado para
+1
ou -1
respectivamente. Isto tem o mesmo efeito que
big
ou small
.
Entretanto esta forma está ultrapassada.
Use font
com o atributo
size
com um número entre
1
e 7
.
O tamanho da fonte padrão é
3
. Esta forma está
ultrapassada.
big
, small
, e
font
Todos os fragmentos fazem a mesma coisa.
Os links também são elementos in-line.
Para incluir um link para outro documento na WWW você deve saber o URL do documento ao qual deseja se ligar.
O link é indicado com a
, e o
atributo href
contém o URL do
documento de destino. O conteúdo do elemento se torna o
link, e geralmente é indicado para o usuário
de alguma maneira (sublinhado, mudança de cor, o
formato do cursor do mouse muda quando está sobre
ele, etc.
<a href="...">
Uso:
Este link irá levar o usuário ao topo do documento escolhido.
Para fazer um link a um ponto dentro de outro documento (ou dentro do mesmo documento), é necessário que o autor do documento inclua âncoras ao qual você possa se ligar.
Âncoras são indicadas com
a
e o atributo name
ao invés de href
.
<a name="...">
Uso:
Para fazer um link a uma determinada parte de um
documento, faça um link normal para aquele documento,
mas inclua o nome da âncora após o
símbolo #
.
Suponha que o exemplo para1
esteja
em um documento chamado foo.html
.
Se você for incluir um link para uma âncora
dentro do mesmo documento você pode omitir o URL do
documento, e usar apenas o nome da âncora (precedido
por #
).
Suponha que o exemplo para1
esteja neste documento
Este, e outros documentos, podem ser obtidos em ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/
Para perguntas sobre FreeBSD, leia a
documentação antes de contatar
<questions@FreeBSD.org>.
Para perguntas sobre esta documentação, envie e-mail para
<doc@FreeBSD.org>.