O Projeto de Documentação do FreeBSD estendeu o DocBook DTD com elementos e entidades adicionais. Essas adições servem para tornar algumas das marcações mais fáceis ou mais precisas.
Ao longo deste documento, o termo “DocBook” é usado para indicar o DocBook DTD estendido do FreeBSD.
A maioria dessas extensões não é exclusiva do FreeBSD, foi apenas identificado que elas eram melhorias úteis para este projeto. Se alguém de qualquer um dos outros *nix (NetBSD, OpenBSD, Linux,…) estiverem interessados em colaborar em um conjunto de extensão DocBook padrão, entre em contato com a Equipe de Engenharia de Documentação <doceng@FreeBSD.org>
.
Os elementos adicionais do FreeBSD não estão (atualmente) na Coleção de Ports. Eles são armazenados na repositório Subversion do FreeBSD, como head/share/xml/freebsd.dtd.
Os elementos específicos do FreeBSD usados nos exemplos abaixo estão claramente marcados.
Esta tabela mostra algumas das entidades mais úteis disponíveis no FDP. Para obter uma lista completa, consulte os arquivos *.ent
em doc/share/xml
.
Entidades de Nome do FreeBSD | ||
&os; | FreeBSD | |
&os.stable; | FreeBSD-STABLE | |
&os.current; | FreeBSD-CURRENT | |
Entidades de Página de Manual | ||
&man.ls.1; | ls(1) | Uso: &man.ls.1; é a página de manual para o <command>ls</command>. |
&man.cp.1; | cp(1) | Uso: A página de manual para <command>cp</command> é &man.cp.1;. |
&man. | link para a página de manual command na seção sectionnumber | As entidades são definidas para todas as páginas de manual do FreeBSD. |
Entidades das Listas de Email do FreeBSD | ||
&a.doc; | Lista de discussão do projeto de documentação do FreeBSD | Uso: Um link para a &a.doc;. |
&a.questions; | Lista de discussão de assuntos gerais do FreeBSD | Uso: Um link para a &a.questions;. |
&a. | link para listname | Foram criadas entidades para todas as listas de email do FreeBSD. |
Entidades de Link de Documento do FreeBSD | ||
&url.books.handbook; a | ../../../../doc/en_US.ISO8859-1/books/handbook | Uso: Um link para o capítulo <link xlink:href="&url.books.handbook;/advanced-networking.html">Rede Avançado</link> do Handbook. |
&url.books. | caminho relativo parabookname | As entidades são definidas para todos os livros FreeBSD. |
&url.articles.committers-guide; | ../../../../doc/en_US.ISO8859-1/articles/committers-guide | Uso: Um link para o artigo <link xlink:href="&url.articles.committers-guide;">Guia dos Committer's</link>. |
&url.articles. | caminho relativo para articlename | As entidades são definidas para todos os artigos do FreeBSD |
Outras Entidades de Sistema Operacional | ||
&linux; | Linux® | O sistema operacional Linux®. |
&unix; | UNIX® | O sistema operacional UNIX®. |
&windows; | Windows® | O sistema operacional Windows®. |
Entidades Diversas | ||
&prompt.root; | # | O prompt de usuário root . |
&prompt.user; | % | Um prompt para um usuário sem privilégios. |
&postscript; | PostScript® | A linguagem de programação PostScript®. |
&tex; | TeX | A linguagem de composição tipográfica TeX. |
&xorg; | Xorg | Xorg, Sistema X Window de código aberto. |
All FreeBSD documents are available for download at https://download.freebsd.org/ftp/doc/
Questions that are not answered by the
documentation may be
sent to <freebsd-questions@FreeBSD.org>.
Send questions about this document to <freebsd-doc@FreeBSD.org>.