From owner-svn-doc-all@freebsd.org Thu Sep 6 01:10:34 2018 Return-Path: Delivered-To: svn-doc-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id BCA9BFD4925; Thu, 6 Sep 2018 01:10:33 +0000 (UTC) (envelope-from ebrandi@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 6FE237D5FC; Thu, 6 Sep 2018 01:10:33 +0000 (UTC) (envelope-from ebrandi@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 6A4EE2D714; Thu, 6 Sep 2018 01:10:33 +0000 (UTC) (envelope-from ebrandi@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w861AX6i099064; Thu, 6 Sep 2018 01:10:33 GMT (envelope-from ebrandi@FreeBSD.org) Received: (from ebrandi@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w861AX1j099061; Thu, 6 Sep 2018 01:10:33 GMT (envelope-from ebrandi@FreeBSD.org) Message-Id: <201809060110.w861AX1j099061@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: ebrandi set sender to ebrandi@FreeBSD.org using -f From: Edson Brandi Date: Thu, 6 Sep 2018 01:10:33 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52225 - in head/pt_BR.ISO8859-1/books/fdp-primer: . doc-build docbook-markup editor-config examples manpages overview po-translations psgml-mode see-also structure stylesheets the-webs... X-SVN-Group: doc-head X-SVN-Commit-Author: ebrandi X-SVN-Commit-Paths: in head/pt_BR.ISO8859-1/books/fdp-primer: . doc-build docbook-markup editor-config examples manpages overview po-translations psgml-mode see-also structure stylesheets the-website tools translations w... X-SVN-Commit-Revision: 52225 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 06 Sep 2018 01:10:34 -0000 Author: ebrandi Date: Thu Sep 6 01:10:32 2018 New Revision: 52225 URL: https://svnweb.freebsd.org/changeset/doc/52225 Log: pt_BR.ISO8859-1/books/fdp-primer: converted to .po * content synchronized with en_US document (rev 52151) * book.xml converted to .po * .po file was translated to pt_BR * pt_BR.po and book.xml file has been set to UTF-8 encoding * chapter.xml files in all sub directory under fdp-primer has been set with fbsd:nokeywords yes since it doesnt have $FreeBSD$ tag * information about volunteers who translated and/or revised the document was added to the header of the .po file. Reviewed by: dbaio Approved by: gabor (mentor, implicit) Obtained from: The FreeBSD Brazilian Portuguese Documentation Project Differential Revision: https://reviews.freebsd.org/D16997 Added: head/pt_BR.ISO8859-1/books/fdp-primer/docbook-markup/ head/pt_BR.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/editor-config/ head/pt_BR.ISO8859-1/books/fdp-primer/editor-config/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/manpages/ head/pt_BR.ISO8859-1/books/fdp-primer/manpages/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/po-translations/ head/pt_BR.ISO8859-1/books/fdp-primer/po-translations/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/pt_BR.po (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/working-copy/ head/pt_BR.ISO8859-1/books/fdp-primer/working-copy/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/xhtml-markup/ head/pt_BR.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/xml-primer/ head/pt_BR.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml (contents, props changed) Modified: head/pt_BR.ISO8859-1/books/fdp-primer/Makefile head/pt_BR.ISO8859-1/books/fdp-primer/book.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/chapters.ent head/pt_BR.ISO8859-1/books/fdp-primer/doc-build/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/examples/appendix.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/overview/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/see-also/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/structure/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/the-website/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/tools/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/translations/chapter.xml (contents, props changed) head/pt_BR.ISO8859-1/books/fdp-primer/writing-style/chapter.xml (contents, props changed) Modified: head/pt_BR.ISO8859-1/books/fdp-primer/Makefile ============================================================================== --- head/pt_BR.ISO8859-1/books/fdp-primer/Makefile Thu Sep 6 00:52:24 2018 (r52224) +++ head/pt_BR.ISO8859-1/books/fdp-primer/Makefile Thu Sep 6 01:10:32 2018 (r52225) @@ -1,14 +1,13 @@ # # The FreeBSD Documentation Project # The FreeBSD Brazilian Portuguese Documentation Project -# +# # $FreeBSD$ # -# Original revision: r38826 -# -MAINTAINER=doc@FreeBSD.org +MAINTAINER=ebrandi@FreeBSD.org + DOC?= book FORMATS?= html-split html @@ -16,25 +15,29 @@ FORMATS?= html-split html INSTALL_COMPRESSED?= gz INSTALL_ONLY_COMPRESSED?= -# +# # SRCS lists the individual XML files that make up the document. Changes # to any of these files will force a rebuild # # XML content -SRCS= book.xml -SRCS+= overview/chapter.xml -SRCS+= psgml-mode/chapter.xml -SRCS+= see-also/chapter.xml -SRCS+= sgml-markup/chapter.xml -SRCS+= sgml-primer/chapter.xml -SRCS+= stylesheets/chapter.xml +SRCS= book.xml +SRCS+= overview/chapter.xml +SRCS+= tools/chapter.xml +SRCS+= working-copy/chapter.xml SRCS+= structure/chapter.xml SRCS+= doc-build/chapter.xml -SRCS+= the-website/chapter.xml -SRCS+= tools/chapter.xml +SRCS+= the-website/chapter.xml +SRCS+= xml-primer/chapter.xml +SRCS+= xhtml-markup/chapter.xml +SRCS+= docbook-markup/chapter.xml +SRCS+= stylesheets/chapter.xml SRCS+= translations/chapter.xml -SRCS+= writing-style/chapter.xml +SRCS+= po-translations/chapter.xml +SRCS+= manpages/chapter.xml +SRCS+= writing-style/chapter.xml +SRCS+= editor-config/chapter.xml +SRCS+= see-also/chapter.xml SRCS+= examples/appendix.xml @@ -44,11 +47,15 @@ IMAGES_LIB+= callouts/2.png IMAGES_LIB+= callouts/3.png IMAGES_LIB+= callouts/4.png IMAGES_LIB+= callouts/5.png +IMAGES_LIB+= callouts/6.png +IMAGES_LIB+= callouts/7.png +IMAGES_LIB+= callouts/8.png +IMAGES_LIB+= callouts/9.png # Entities -SRCS+= chapters.ent +SRCS+= chapters.ent URL_RELPREFIX?= ../../../.. -DOC_PREFIX?= ${.CURDIR}/../../.. +DOC_PREFIX?= ${.CURDIR}/../../.. .include "${DOC_PREFIX}/share/mk/doc.project.mk" Modified: head/pt_BR.ISO8859-1/books/fdp-primer/book.xml ============================================================================== --- head/pt_BR.ISO8859-1/books/fdp-primer/book.xml Thu Sep 6 00:52:24 2018 (r52224) +++ head/pt_BR.ISO8859-1/books/fdp-primer/book.xml Thu Sep 6 01:10:32 2018 (r52225) @@ -1,8 +1,33 @@ - - %chapters; -]> + + + + + + + + + + + + + + + + + + + +]> + + + Primer do Projeto de Documentação do FreeBSD para Novos Colaboradores - Original revision: r38826 + Projeto de Documentação do FreeBSD ---> - - - &a.ptbr.p.fdpp; para novos colaboradores + 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 DocEng + + + + + - Projeto de documentao do - FreeBSD - - 1998 - 1999 - 2000 - 2001 - 2002 - 2003 - 2004 - 2005 - 2006 - 2007 - 2008 - 2009 - DocEng - + + Copyright - $FreeBSD$ + Redistribution and use in source (XML DocBook) and 'compiled' forms (XML, HTML, PDF, PostScript, RTF and so forth) with or without modification, are permitted provided that the following conditions are met: - $FreeBSD$ + + + Redistributions of source code (XML DocBook) must retain the above copyright notice, this list of conditions and the following disclaimer as the first lines of this file unmodified. + - &legalnotice; + + Redistributions in compiled form (transformed to other DTDs, converted to PDF, PostScript, RTF and other formats) must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + + + + THIS DOCUMENTATION IS PROVIDED BY THE FREEBSD DOCUMENTATION PROJECT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FREEBSD DOCUMENTATION PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + + - Obrigado por tornar-se parte do Projeto de - Documentao do FreeBSD. A sua - contribuio extremamente - valiosa. + Obrigado por fazer parte do Projeto de Documentação do FreeBSD. A sua contribuição é extremamente valiosa. - Este &a.ptbr.p.fdpp; cobre tudo o que voc precisa - saber para comear a contribuir com o Projeto de - Documentao do FreeBSD, desde as ferramentas e - softwares que voc estar utilizando (tanto - os obrigatrios quanto os recomendados) - filosofia por trs do projeto de - documentao. + Este primer cobre tudo o que você precisa saber para começar a contribuir com o Projeto de Documentação do FreeBSD, ou FDP, incluindo ferramentas, softwares, e a filosofia por trás do Projeto de Documentação. - Este documento um trabalho em andamento, e - no est completo. As sesses que - sabemos estarem incompletas esto indicadas com um - * no seu nome. + Este documento é um trabalho em andamento. Correções e adições são sempre bem vindas. - Prefcio + Prefácio - - <foreignphrase>Prompt</foreignphrase> do interpretador de - comandos (<foreignphrase>shell</foreignphrase>) + + Prompts do Shell - A tabela seguinte mostra o - prompt padro do sistema - e o prompt do super - usurio. Os exemplos iro utilizar estes - prompts para indicar com qual - usurio o exemplo foi executado. + Esta tabela mostra o prompt padrão do sistema e o prompt do super usuário. Os exemplos usam estes prompts para indicar com qual +usuário o exemplo foi executado. - + - Usurio - Prompt + Usuário + Prompt - Usurio normal - &prompt.user; + Usuário normal + % root - &prompt.root; + # @@ -135,159 +135,7296 @@ - Convenes Tipogrficas + Convenções Tipográficas - A tabela seguinte descreve as convenes - tipogrficas utilizadas neste livro. + Esta tabela descreve as convenções tipográficas utilizadas neste livro. - Propsito + Propósito Exemplos - Nome de um comando. - Utilize ls -a para listar - todos os arquivos. + Nome dos comandos. + Utilize ls -l para listar todos os arquivos. - - Nome de um arquivo. - Edite o seu arquivo .login - . - + + Nome dos arquivos. + Edite .login. + - - Sada - (output) - de um programa na tela do computador. - Voc tem email. - + + Saída de um programa na tela do computador. + You have mail. + - O que voc digita, quando contrastado com a - sada (output) do - programa na tela do computador. - &prompt.user; su -Password: + O que o usuário digita, quando contrastado com a saída do programa na tela do computador. + + % date +"The time is %H:%M" +The time is 09:18 - Referncia a uma pgina de - manual. - Utilize o &man.su.1; para assumir outro nome de - usurio. + Referência a uma página de manual. + Utilize su1 para assumir outro nome de +usuário. - Nome de usurio e de grupos de - usurios - Apenas o root pode fazer - isso. + Nome de usuário e de grupos de usuários + Apenas o root pode fazer isso. - nfase - Voc deve fazer - isso. + Ênfase + O usuário deve fazer isso. - Variveis da linha de comando; Substitua - com o nome real ou com a varivel. - Para deletar um arquivo, digite rm - nome_do_arquivo - + Texto que o usuário deve substituir com o texto real. + + Para buscar por uma palavra chave nas páginas de manual, digite man -k keyword - Variveis de ambiente - O $HOME o seu - diretrio home. + Variáveis de ambiente + $HOME aponta para o diretório inicial do usuário. - - + + - Notas, dicas, informaes importantes, - avisos e exemplos + Notas, Dicas, Informações Importantes, Avisos e Exemplos - Ao longo do texto aparecero notas, avisos e - exemplos. + Notas, avisos e exemplos aparecem ao longo do texto. - Notas so representadas desta forma, e - contm informaes para as quais - voc deveria ficar atento, pois podem afetar o que - voc faz. + Notas são representadas desta forma, e contêm informações para as quais se deve ficar atento, pois podem afetar o que o usuário faz. - Dicas so representadas desta forma, e - contm informaes que voc pode - achar teis, ou que mostram uma maneira mais - fcil de fazer alguma coisa. + Dicas são representadas desta forma, e contêm informações úteis para o usuário, como as que mostram uma maneira mais fácil de fazer alguma coisa. - Informaes importantes so - representadas desta forma. Normalmente elas destacam passos - extras que voc pode precisar realizar. + Informações importantes são representadas desta forma. Normalmente elas destacam passos extras que o usuário pode precisar realizar. - Avisos so representados deste modo, e - contm informaes de alerta para - voc sobre possveis danos se voc - no seguir as instrues. Estes danos - podem ser fsicos: para o seu equipamento ou para - voc; ou, podem ser no-fsicos: tal - como a deleo inadvertida de arquivos - importantes. + Avisos são representados deste modo, e contêm informações de alerta sobre possíveis danos se não seguir as instruções. Estes danos podem ser físicos, para o equipamento ou para o usuário, ou podem ser não-físicos, tal como a deleção inadvertida de arquivos importantes. - Uma amostra de exemplo + Uma Amostra de Exemplo - Os exemplos so representados deste modo, e - normalmente contm exemplos que voc deve - analisar, ou ento, mostram como deveriam ser os - resultados de uma determinada ao. + Os exemplos são representados deste modo, e normalmente contêm exemplos passo a passo, ou mostram os resultados de uma determinada ação. Agradecimentos - Meu muito obrigado a Sue Blake, Patrick Durusau, Jon - Hamilton, Peter Flynn, e Christopher Maden, por terem gasto - parte do seu tempo lendo os primeiros rascunhos deste - documento e por terem oferecido muitos comentrios e - crticas construtivas para este trabalho. + Meu muito obrigado a Sue Blake, Patrick Durusau, Jon Hamilton, Peter Flynn, e Christopher Maden, por terem gasto parte do seu tempo lendo os primeiros rascunhos deste documento e por terem oferecido muitos comentários e críticas construtivas para este trabalho. - &chap.overview; - &chap.tools; - &chap.xml-primer; - &chap.xml-markup; - &chap.stylesheets; - &chap.structure; - &chap.doc-build; - &chap.the-website; - &chap.translations; - &chap.writing-style; - &chap.psgml-mode; - &chap.see-also; + + + + Visão Geral + + Seja bem vindo ao Projeto de Documentação do FreeBSD.(FDP). Documentação de boa qualidade é +muito importante para o sucesso do FreeBSD, e nós valorizamos muito suas contribuições. + + Este documento descreve como o FDP é organizado, como escrever e como submeter documentos, e como utilizar de forma efetiva as ferramentas que estão disponíveis. + + Todos são bem vindos para se juntar ao FDP. A vontade de contribuir é o único requisito de adesão. + + Este primer mostra como: + + + + Identificar quais partes do FreeBSD são mantidas pelo FDP. + + + + Instalar as ferramentas e arquivos de documentação necessários. + + + + Realizar alterações na documentação. + + + + Enviar de volta alterações para revisão e inclusão na documentação do FreeBSD. + + + + + Quick Start + + Algumas etapas preparatórias devem ser seguidas antes de editar a documentação do FreeBSD. Primeiro, se registre na lista de email do projeto de documentação do FreeBSD. Alguns membros do time também interagem no IRC, canal #bsddocs na rede EFnet. Estas pessoas podem ajudar com questões e problemas envolvendo documentação. + + + + Instale o meta-port textproc/docproj e o Subversion. Este meta-port instala todo software necessário para editar e compilar a documentação do FreeBSD. O pacote Subversion é necessário para obter uma cópia de trabalho da documentação e para gerar patches. + + # pkg install docproj subversion + + + + Obtenha uma cópia local da árvore de documentação do FreeBSD em ~/doc (see ). + + % svn checkout https://svn.FreeBSD.org/doc/head ~/doc + + + + Configure o editor de texto: + + + + Defina a quebra de linha para 70 caracteres. + + + + Defina a parada de tabulação para 2. + + + + Substitua cada grupo de 8 espaços por um tab. + + + + Configurações específicas por editor são informados em . + + + + Atualize a árvore de trabalho local: + + % svn up ~/doc + + + + Edite os arquivos de documentação que precisam de alterações. Se um arquivo precisar de grandes mudanças, consulte a lista de discussão para obter informações. + + Referencias pra uso de tag e entidade podem ser encontradas em and . + + + + Após alteração, cheque por eventuais problemas rodando + + % igor -R filename.xml | less -RS + + Revise a saída e edite o arquivo para corrigir os problemas informados e, em seguida, execute novamente o comando para verificar os problemas restantes. Repita até que todos os erros sejam resolvidos. + + + + Sempre realize testes de compilação antes de submeter algo. Execute make no diretório de nível superior da documentação alterada e assim será gerado a documentação no formato HTML com divisões. Por exemplo, pra compilar a versão Inglês do Handbook em HTML, execute make no diretório en_US.ISO8859-1/books/handbook/. + + + + Quando as alterações estiverem completas e testadas, gere um arquivo diff: + + % cd ~/doc +% svn diff > bsdinstall.diff.txt + + Dê ao arquivo diff um nome. No exemplo acima, foram feitas alterações na parte bsdinstall do Handbook. + + + + Submeta o arquivo diff file pela web para o sistema de Relatórios de Problema. Se estiver usando o formulário web, insira um Sumário com [patch] descrição curta do problema. Selecione o Componente Documentation. No campo de Descrição, insira uma breve descrição das alterações e quaisquer detalhes importantes sobre elas. Use o botão [ Add an attachment ] para anexar o arquivo diff. Finalmente, pressione o botão [ Submit Bug ] para enviar seu diff para o sistema de relatório de problemas. + + + + + + Conjunto de Documentação do FreeBSD + + O FDP é responsável por quatro categorias de documentação do FreeBSD. + + + + Handbook: O handbook almeja ser um compreensivo recurso de referência online para os usuários do FreeBSD + + + + FAQ: O FAQ utiliza um formato curto de pergunta e resposta para abordar dúvidas que são frequentemente realizadas nas listas de discussão e fóruns dedicados ao FreeBSD. Este formato não permite respostas longas e detalhadas. + + + + Páginas de Manual: As páginas de manual do sistema de língua inglesa geralmente não são escritas pelo FDP, pois fazem parte do sistema base. Contudo, o FDP pode reformular partes das páginas de manual existentes para torná-las mais claras ou para corrigir imprecisões. + + + + Web site: Esta é a presença principal do FreeBSD na web, visite https://www.FreeBSD.org/ e muitos mirrors ao redor do mundo. O site é tipicamente o primeiro contato de um usuário novo com o FreeBSD. + + + + As equipes de tradução são responsáveis por traduzir o manual e o site para diferentes idiomas. As páginas do manual não são traduzidas no momento. + + Código fonte do site do FreeBSD, Handbook, e FAQ estão disponíveis no repositório de documentação em https://svn.FreeBSD.org/doc/. + + Código fonte das páginas de manual estão disponíveis em um repositório diferente localizado em https://svn.FreeBSD.org/base/. + + As mensagens de commit de documentação podem ser visualizadas com svn log. As mensagens de commit também são arquivadas em http://lists.FreeBSD.org/mailman/listinfo/svn-doc-all. + + Endereço web para ambos os repositórios disponíveis em e . + + Muitas pessoas tem escrito tutoriais e artigos how-to sobre FreeBSD. Alguns são armazenados como parte dos arquivos FDP. Em outros casos, o autor decidiu manter a documentação separada. O FDP esforça-se para fornecer links para o máximo possível dessas documentações externas. + + + + + + + Ferramentas + + Várias ferramentas são utilizadas para gerenciar a documentação do FreeBSD e renderizá-la para diferentes formatos. Algumas dessas ferramentas são necessárias e devem ser instaladas antes de trabalhar com os exemplos nos capítulos a seguir. Algumas são opcionais, adicionando recursos ou tornando a tarefa de criar documentação mais simples. + + + Ferramentas Obrigatórias + + Instale o textproc/docproj pela Coleção de Ports. Este meta-port instala todos os aplicativos necessários para trabalhar com a documentação do FreeBSD. Informações adicionais específicas de alguns componentes serão informadas abaixo. + + + <acronym>DTD</acronym>s e <acronym>Entidades</acronym> + + A documentação do FreeBSD utiliza diversas Definições de Tipos de Documento (DTDs) e conjuntos de entidades XML. Estes são todos instalados pelo port textproc/docproj. + + + + XHTML DTD (textproc/xhtml) + + + XHTML é a linguagem markup escolhida pela Web, e é utilizada em todo o site do FreeBSD. + + + + + DocBook DTD (textproc/docbook-xml) + + + O DocBook é projetado para escrever documentação técnica. A maior parte da documentação do FreeBSD é escrita no DocBook. + + + + + Entidades ISO 8879 (textproc/iso8879) + + + Entidades do padrão ISO 8879:1986 utilizado por muitos DTDs. Inclui símbolos matemáticos nomeados, caracteres adicionais no conjunto de caracteres latinos (acentos, diacríticos e assim por diante) e símbolos Gregos. + + + + + + + + Ferramentas Opcionais + + Essas ferramentas não são necessárias, mas podem facilitar o trabalho na documentação ou adicionar recursos. + + + Software + + + + + Vim (editors/vim) + + + Um editor de texto popular que trabalha com XML and documentos derivados, como DocBook XML. + + + + + Emacs ou XEmacs (editors/emacs ou editors/xemacs) + + + Ambos editores incluem um modo especial para editar documentos marcados como XML DTD. Esse modo inclui comandos para reduzir a quantidade de digitação necessária e ajudar a reduzir a possibilidade de erros. + + + + + + + + + + + A Área de Trabalho + + A área de trabalho é uma cópia da árvore de documentação do repositório do FreeBSD baixada no computador local. As alterações são feitas na cópia de trabalho local, testadas e enviadas como patches para serem submetidas no repositório principal. + + Uma cópia completa da árvore de documentação pode ocupar 700 megabytes de espaço em disco. Tenha um gigabyte de espaço total para ter sobra para arquivos temporários e versões de teste dos diversos formatos de saída. + + O Subversion é utilizado para gerenciar os arquivos de documentação do FreeBSD. Ele é obtido pela instalação do pacote Subversion: + + # pkg install subversion + + + Documentação e Páginas de Manual + + A documentação do FreeBSD não é formada apenas por livros e artigos. Páginas de manual para todos os comandos e arquivos de configuração também fazem parte da documentação e fazem parte do território do FDP. Dois repositórios estão envolvidos: doc para os livros e artigos, e base para o sistema operacional e páginas de manual. Para editar páginas de manual, o repositório base deve ser registrado separadamente. + + Repositórios podem conter várias versões de documentação e código-fonte. Novas modificações quase sempre são feitas apenas para a versão mais recente, chamada head. + + + + Escolhendo um Diretório + + A documentação do FreeBSD é tradicionalmente armazenada em /usr/doc/, e o código fonte do sistema com páginas de manual em /usr/src/. Essas árvores são realocáveis ​​e os usuários podem armazenar as cópias de trabalho em outros locais para evitar interferir nas informações existentes nos diretórios principais. Os exemplos a seguir utilizam ~/doc e ~/src, ambos subdiretórios do diretório pessoal do usuário. + + + + Baixando uma Cópia + + O processo de download de um repositório é chamado de checkout e é feito com um svn checkout. Este exemplo faz checkout de uma cópia da versão mais recente (head) do repositório de documentação principal: + + % svn checkout https://svn.FreeBSD.org/doc/head ~/doc + + O checkout do código-fonte para trabalhar nas páginas de manual é muito semelhante: + + % svn checkout https://svn.FreeBSD.org/base/head ~/src + + + + Atualizando + + Os documentos e arquivos no repositório do FreeBSD mudam diariamente. As pessoas modificam arquivos e submetem alterações com frequência. Mesmo após um checkout inicial, já haverá alterações entre a cópia de trabalho local e o repositório principal do FreeBSD. Para atualizar a versão local com as mudanças que foram feitas no repositório principal, execute svn update no diretório que contém a cópia de trabalho local: + + % svn update ~/doc + + Adquira o hábito de proteção de executar svn update antes de editar os arquivos de documentação. Alguém pode ter editado esse arquivo muito recentemente e a cópia de trabalho local não incluirá essas alterações mais recentes até que ela seja atualizada. Editar a versão mais recente de um arquivo é muito mais fácil do que tentar combinar um arquivo local editado mais antigo com a versão mais recente do repositório. + + + + Revertendo Alterações + + De vez em quando acontece que algumas mudanças não eram necessárias, ou o escritor só quer começar novamente. Arquivos podem ser resetados para sua forma anterior com svn revert. Por exemplo, para apagar as alterações feitas no chapter.xml e redefini-las para o formato sem modificação: + + % svn revert chapter.xml + + + + Criando um Diff + + Após finalizar as alterações em um arquivo ou grupo de arquivos, as diferenças entre a cópia de trabalho local e a versão no repositório do FreeBSD devem ser coletadas em um único arquivo para ser submetido. Estes arquivos diff são produzidos redirecionando a saída de svn diff para um arquivo: + + % cd ~/doc +% svn diff > doc-fix-spelling.diff + + Dê ao arquivo um nome significativo que identifique o conteúdo. O exemplo acima é para correção ortográfica em toda a árvore de documentação. + + Se o arquivo diff for enviado com a interface web Submit a FreeBSD problem report, adicione uma extensão .txt para que o formulário web identifique que o conteúdo do arquivo é texto plano. + + Tenha cuidado: svn diff inclui todas as alterações feitas no diretório atual e em quaisquer subdiretórios. Se houver arquivos na cópia de trabalho com edições que ainda não estão prontas para serem enviadas, forneça uma lista apenas dos arquivos a serem incluídos: + + % cd ~/doc +% svn diff disks/chapter.xml printers/chapter.xml > disks-printers.diff + + + + Referências <application>Subversion</application> + + Estes exemplos demonstram um uso muito básico do Subversion. Mais detalhes estão disponíveis no Subversion Book e na Documentação do Subversion. + + + + + + + Estrutura de Diretórios da Documentação + + Arquivos e diretórios no repositório doc/ seguem uma estrutura destinada a: + + + + Facilitar a conversão do documento para outros formatos. + + + + Promover a consistência entre as diferentes organizações de documentação, e assim facilitar a alternância entre diferentes documentos. + + + + Facilitar a decisão de onde a nova documentação deve ser colocada. + + + + Além disso, o repositório de documentação deve acomodar documentos em vários idiomas e codificações diferentes. É importante que a estrutura do repositório de documentação não imponha quaisquer padrões particulares ou preferências culturais. + + + O Nível Superior, <filename>doc/</filename> + + Existem dois tipos de diretório em doc/, cada um com nomes de diretório e significados muito específicos. + + + + + + Diretório + Uso + + + + + + share + + Contém arquivos que não são específicos das várias traduções e codificações da documentação. Contém subdiretórios para categorizar ainda mais as informações. Por exemplo, os arquivos que fazem parte da infra-estrutura make1 estão em share/mk, enquanto o suporte adicional a arquivos XML (como o DTBook estendido do FreeBSD DTD) estão em share/xml. + + + + lang.encoding + + Existe um diretório para cada tradução e codificação disponível da documentação, por exemplo, en_US.ISO8859-1/ e zh_TW.UTF-8/. Os nomes são longos, mas ao especificar totalmente o idioma e a codificação, evitamos dores de cabeça futuras quando uma equipe de tradução desejar fornecer documentação no mesmo idioma, mas em mais de uma codificação. Isso também evita problemas que podem ser causados ​​por uma futura mudança para Unicode. + + + + + + + + Os Diretórios <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename> + + Esses diretórios contêm os próprios documentos. A documentação é dividida em até três outras categorias, indicadas pelos diferentes nomes de diretório. + + + + + + Diretório + Uso + + + + + + articles + + Documentação marcada como DocBook article (ou equivalente). Conteúdo curto e dividido em seções. Normalmente disponível apenas como um arquivo XHTML. + + + + books + + Documentação marcada como DocBook book (ou equivalente). Conteúdo longo e dividido em capítulos. Normalmente disponível como um grande arquivo XHTML (para pessoas com conexões rápidas, ou que desejam imprimi-lo facilmente de um navegador) e como uma coleção de arquivos menores e com links. + + + + man + + Para traduções das páginas de manual do sistema. Esse diretório conterá um ou mais diretórios manN, correspondendo às seções que foram traduzidas. + + + + + + Nem todo diretório lang.encoding terá todos esses subdiretórios. Depende de quanto a tradução foi realizada por essa equipe de tradução. + + + + Informação Específica de Documentação + + Esta seção contém informações específicas sobre documentos gerenciados pelo FDP. + + + O Handbook + + books/handbook/ + + O Handbook está escrito em DocBook XML usando DTD extendido do DocBook FreeBSD. + + O Handbook está organizado como um DocBook book. O livro é dividido em parts, cada uma contendo vários chapters. Os chapters são subdivididos em seções (sect1) e subseções (sect2, sect3) e assim por diante. + + + Organização Física + + Existem vários arquivos e diretórios dentro do diretório handbook. + + + A organização do Handbook pode ser alterada ao longo do tempo, e este documento pode estar defasado quanto ao detalhamento das mudanças organizacionais do mesmo. Envie perguntas sobre a organização do Handbook na lista de discussão do projeto FreeBSD. + + + + <filename>Makefile</filename> + + O Makefile define algumas variáveis ​​que afetam como o fonte XML é convertido em diversos formatos e lista os vários arquivos fontes que compõem o Handbook. Em seguida, ele inclui o doc.project.mk padrão, para inserir o restante do código que manipula a conversão de documentos de um formato para outro. + + + *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***