dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 261
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2011-02-11 15:46:57 +0100
message:
  Added skeleton for implementation guide
removed:
  src/docbkx/pt/
  src/docbkx/pt/dhis2_documentation_guide.xml
  src/docbkx/ru/
  src/docbkx/ru/dhis2_documentation_guide.xml
renamed:
  src/docbkx/en/dhis2_implementation_guide.xml => src/docbkx/en/dhis2_implementation_guide_short.xml


--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs

Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription

=== renamed file 'src/docbkx/en/dhis2_implementation_guide.xml' => 'src/docbkx/en/dhis2_implementation_guide_short.xml'
=== removed directory 'src/docbkx/pt'
=== removed file 'src/docbkx/pt/dhis2_documentation_guide.xml'
--- src/docbkx/pt/dhis2_documentation_guide.xml	2010-03-25 08:32:51 +0000
+++ src/docbkx/pt/dhis2_documentation_guide.xml	1970-01-01 00:00:00 +0000
@@ -1,409 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. -->
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; [
-<!ENTITY br ''>]>
-
-
-
-<chapter>
-  <chapterinfo>
-    <title>
-      DHIS 2 Documentação Guia
-    </title>
-    <author>
-      <firstname>
-        Jason
-      </firstname>
-      <surname>
-        Pickering
-      </surname>
-      <affiliation>
-        <orgname>
-        </orgname>
-      </affiliation>
-    </author>
-    <pubdate>
-      14/09/09
-    </pubdate>
-    <keywordset>
-      <keyword>
-        DHIS2
-      </keyword>
-      <keyword>
-        documentação
-      </keyword>
-      <keyword>
-        DocBook
-      </keyword>
-    </keywordset>
-    <revhistory>
-      <revision>
-        <revnumber>
-          2
-        </revnumber>
-        <date>
-          28/10/09
-        </date>
-        <revdescription>
-          <para>
-            Adicionado mais algumas informações sobre documentos multilíngües e editores.
-          </para>
-        </revdescription>
-      </revision>
-      <revision>
-        <revnumber>
-          1
-        </revnumber>
-        <date>
-          29/09/09
-        </date>
-        <revdescription>
-          <para>
-            Adicionadas mais informações sobre como começar com bzr e DocBook
-          </para>
-        </revdescription>
-      </revision>
-    </revhistory>
-  </chapterinfo>
-  <title>
-    DHIS2 Documentation Guide
-  </title>
-  <section id="docs_1">
-    <title>
-      DHIS 2 Visão Geral do Sistema de Documentação
-    </title>
-    <para remap="">
-      DHIS 2 é um sistema baseado na web agregado de informação de gestão em desenvolvimento muito ativo. Embora essencialmente destinados à gestão dos agregados, os dados georreferenciados de saúde, deve ser possível utilizar o sistema para outros fins também. Atualmente, há um grande número de bolsos desconectado da documentação em vários formatos (por exemplo, MediaWiki, documentos do Word, Confluence). Há uma necessidade de consolidar o processo de documentação e trazê-lo mais em linha com a natureza distribuída do desenvolvimento da aplicação em si. Foi sugerido, portanto, para mover a documentação atual para a plataforma DocBook. Este artigo não discutirá os méritos da plataforma DocBook, mas servirá como um breve guia para a sua utilização por DHIS 2 implementadores, usuários e desenvolvedores. Os leitores são incentivados a fazer sua própria decisão sobre se a utilização do DocBook ou não, para fins de documentação.
-    </para>
-  </section>
-  <section id="docs_2">
-    <title>
-      Introdução
-    </title>
-    <para>
-      Uma das principais vantagens do DocBook é que não há separação completa entre o conteúdo e apresentação. DocBook é um formato XML puro, e está bem documentado. Acredita-se que apenas um subconjunto muito limitado de suas características será necessária para atingir a documentação de qualidade muito mais elevada para DHIS. Há cerca de 400 marca-se separar os elementos que servem para quase qualquer nível de necessidades de documentação técnica, mas na realidade, apenas algumas dezenas desses elementos provavelmente terá que ser empregada para atingir a documentação de alta qualidade para DHIS 2, tanto para os impressos bem como sobre a linha de formatos, como HTML ou sistemas de ajuda integrado dentro do próprio aplicativo. Intervalo, portanto, existem grandes possibilidades em termos de qual editor pode ser usado para a criação de arquivos DocBook. Uma lista bastante completa de possibilidades é localizado
-      <ulink url="http://wiki.docbook.org/topic/DocBookAuthoringTools";>
-        aqui
-      </ulink>
-      . Actualmente, é recomendado o uso
-      <ulink url="http://www.syntext.com/products/serna-free/ ">
-        Syntext Serna Free
-      </ulink>
-      para editar arquivos DocBook fonte como WYSIWYG. Não é recomendado usar o editor XMLmind XML Editor Personal Edition (também conhecido como XXE pessoais), como o editor de &quot;silenciosamente&quot; coloca em branco desnecessários e outros ornamentos para a fonte do DocBook que torna a edição colaborativa de documentos muito difícil.
-    </para>
-    <para>
-      Um dos conceitos-chave para manter em mente ao criar documentação no formato DocBook, ou outros formatos de apresentação neutra, é que o
-      <emphasis role="bold">
-        conteúdo
-      </emphasis>
-      do documento deve ser considerado em primeiro lugar. O
-      <emphasis role="bold">
-        apresentação
-      </emphasis>
-      do documento será realizada em uma etapa separada, onde será processado em diferentes formatos, como HTML e PDF. Portanto, é importante que o documento é a vontade organizada e estruturada, com as tags do DocBook apropriada e elementos estruturais a serem consideradas.
-    </para>
-    <para>
-      Praticar É bom para quebrar o documento em várias seções para uso da seita &quot;, ou elemento de seção. Seção elementos também podem ser aninhados uns nos outros, como &quot;Seção 1&quot; e &quot;Section 2&quot;. Este conceito é essencialmente a mesma
-      <productname>
-        Microsoft Word
-      </productname>
-      ou programas de processamento de texto. DocBook cuidará automaticamente da numeração das seções para você quando o documento é produzido. Dois outros elementos importantes são os itemizedlist &quot;e&quot; NumberedList &quot;. Estes são bastante similares, mas uma lista discriminada corresponde a uma lista com marcadores, uma lista numerada, que será processado com cada elemento a ser numerado sequencialmente. Outros elementos-chave são &quot;imagem&quot; e &quot;tabela&quot; que devem ser auto-explicativo.
-    </para>
-  </section>
-  <section id="docs_3">
-    <title>
-      Começando com o Launchpad
-    </title>
-    <para>
-      Atualmente, o sistema de documentação faz parte do código-fonte alojados em
-      <ulink url="https://launchpad.net/";>
-        Launchpad
-      </ulink>
-      . Launchpad é uma plataforma colaborativa que permite que várias pessoas trabalham em projetos de software de forma colaborativa. Para que isso seja possível, um sistema de controle de versão é necessário para gerenciar todas as mudanças que vários usuários podem fazer. Launchpad usa o
-      <emphasis>
-        Bazar
-      </emphasis>
-      sistema de controle de origem. Enquanto ele está fora do escopo deste documento para descrever a funcionalidade do
-      <emphasis>
-        Bazar
-      </emphasis>
-      , Os usuários que desejem criar a documentação terá que ganhar pelo menos uma compreensão básica de como funciona o sistema. Um guia básico é fornecida na próxima seção.
-    </para>
-    <para>
-      Para começar a adicionar ou editar a documentação, você deve primeiro fazer um checkout do código fonte. Se você não tiver um login id Launchpad, você precisará obter um. Isto pode ser feito
-      <ulink url="https://launchpad.net/+login";>
-        aqui
-      </ulink>
-      . Uma vez que você se cadastra no Launchpad, você terá que solicitar o acesso aos
-      <emphasis>
-        dhis2-documenters
-      </emphasis>
-      grupo. Entrar para Launchpad, e em seguida, solicitar o acesso
-      <ulink url="https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs";>
-        aqui
-      </ulink>
-      . O seu pedido terá de ser aprovada pelos administradores do grupo. Depois de ter sido concedido o acesso ao grupo, você pode confirmar as alterações para o ramo de documentação e enviar e receber e-mails na lista dos grupos.
-    </para>
-  </section>
-  <section id="docs_4">
-    <title>
-      Obtendo o documento de origem
-    </title>
-    <para>
-      Para editar a documentação, você precisa fazer o download das páginas de origem da documentação para o seu computador. Launchpad usa um sistema de controle de versão conhecida como bzr. Existem diferentes métodos para obter Bazaar trabalhando em seu sistema, dependendo de qual sistema operacional você está usando. Um bom passo-a-passo para
-      <productname>
-        Microsoft
-      </productname>
-      sistemas operativos pode ser visto
-      <ulink url="http://wiki.showmedo.com/index.php/Using_Launchpad_and_Bazaar#Steps_to_download_a_project_on_Launchpad_that_uses_Bazaar_with_only_one_branch";>
-        aqui
-      </ulink>
-      . Se você estiver usando Linux, você precisará instalar o bzr no seu sistema através do seu gestor de pacotes, ou a partir do código fonte.
-    </para>
-    <para>
-      Uma vez instalado o bzr no seu sistema, você vai precisar fazer o download do documento de origem. Basta seguir este procedimento:
-    </para>
-    <orderedlist>
-      <listitem>
-        <para>
-          Verifique se você tem Bazaar instalado.
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          Iniciar Bazaar botão direito do mouse uma pasta se você estiver usando
-          <productname>
-            Windows
-          </productname>
-          e selecionando
-          <command>
-            Bzr Aqui
-          </command>
-          . Se você usa Linux, você pode simplesmente criar uma pasta para armazenar as fontes de documento. Você pode colocar a origem do documento em qualquer pasta que você gosta.
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          Para baixar a última revisão do tipo DHIS2 documentos do projeto:
-          <command>
-            bzr branch http://bazaar.launchpad.net/% 7Edhis2-documenters/dhis2/dhis2-docbook-docs
-          </command>
-          Se você estiver usando Linux, ou alternativamente, se você estiver usando
-          <productname>
-            Windows
-          </productname>
-          Digite o URL para o repositório de código-fonte &quot;
-          <ulink url="https://bazaar.launchpad.net/%7Edhis2-documenters/dhis2/dhis2-docbook-docs";>
-            http://bazaar.launchpad.net/ 7Edhis2-documenters/dhis2/dhis2-docbook-docs%
-          </ulink>
-          &quot;
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          O processo de transferência deverá começar e todos os arquivos fonte da documentação será baixado para a pasta que você especificou.
-        </para>
-      </listitem>
-    </orderedlist>
-  </section>
-  <section id="docs_5">
-    <title>
-      Edição da documentação
-    </title>
-    <para>
-      Depois de ter baixado a fonte, você deve ter uma série de pastas dentro do dhis2-docbook-diretório docs. Todos os documentos devem ser colocados na
-      <filename>
-        dhis2-docbook-docs/src/docbkx/XX
-      </filename>
-      pasta. Note que o
-      <filename>
-        XX
-      </filename>
-      representa a ISO 639-1 (duas letras) código de linguagem da documentação. Se você está desenvolvendo documentação do idioma Inglês, colocá-lo dentro do
-      <filename>
-        / dhis2-docbook-docs/src/docbkx/en /
-      </filename>
-      pasta. Coloque qualquer imagem de arquivos que podem estar ligados ao seu documento no
-      <filename>
-        / dhis2-docbook-docs/src/docbkx/XX/resources/images
-      </filename>
-      pasta e associar estas dentro de seu documento DocBook usando um link do arquivo relativo. Quando a documentação é construída, em uma etapa separada, as imagens serão automaticamente copiados para o diretório correto durante o processo de criação.
-    </para>
-  </section>
-  <section id="docs_6">
-    <title>
-      Usando imagens
-    </title>
-    <para>
-      As capturas de tela são muito úteis para fornecer informações aos usuários sobre a forma particular, as acções devem ser executadas. DocBook tem mecanismos intrínsecos para saber exatamente como uma imagem deve ser processada no documento final. Portanto, é necessário fornecer instruções através de atributos do elemento. O fragmento de código XML a seguir demonstra como uma imagem pode ser especificado para ocupar 80% da largura de página disponíveis. Para capturas de tela em formato de paisagem, este parece ser um valor adequado. Você pode precisar experimentar um pouco para obter uma largura adequada para a sua imagem. Alternativamente, você pode editar a resolução da imagem em si, a fim de obter um tamanho adequado durante o processamento.
-    </para>
-    <literallayout>
-      &lt;screenshot&gt; &lt;screeninfo tela de login DHIS2 &lt;/ screeninfo&gt; &lt;mediaobject&gt; &lt;imageobject&gt; &lt;imagedata fileref=&quot;dhis2_login_screen.jpg&quot; format=&quot;JPG&quot; width=&quot;80%&quot;/&gt; &lt;/ imageobject&gt; &lt;/ mediaobject&gt; &lt; / screenshot&gt;
-    </literallayout>
-    <para>
-      Para outras imagens, dependendo do seu tamanho, um valor diferente pode ser necessária. Se você não especificar uma largura de imagem para você e sua dimensão intrínseca é maior que a largura disponível na tela, a imagem pode transbordar em determinados tipos de documentos com uma largura fixa, como o PDF.
-    </para>
-  </section>
-  <section id="docs_7">
-    <title>
-      Ligando os documentos juntos
-    </title>
-    <para>
-      DocBook oferece uma estrutura modular, onde muitos documentos separados podem ser unidas em um documento mestre. Fragmentos de diferentes documentos também podem ser reutilizados em diferentes contextos. Por isso, é importante considerar se o documento deve ser construído como um artigo ou um capítulo. Os capítulos são, essencialmente, partes de um livro, e podem ser ligados em um documento muito mais facilmente. Os artigos são essencialmente autônoma documentos, mas eles também podem ser reunidos em um documento maior no nível do componente.
-    </para>
-    <para>
-      Caso deseje ligar vários artigos juntos em um livro, DocBook oferece um mecanismo para atribuir um id para uma seção. No exemplo a seguir, uma seção foi atribuído um id. Esta identificação deve ser exclusivo dentro do documento.
-    </para>
-    <para>
-      <literallayout>
-        &lt;section id=&quot;mod2_1&quot;&gt; &lt;title&gt; Começando com DHIS2 &lt;/ title&gt; ....
-      </literallayout>
-    </para>
-    <para>
-      A fim de incluir um artigo em um livro, uma declaração xinclude deve ser usado. O exemplo a seguir mostra como.
-    </para>
-    <para>
-      <literallayout>
-        &lt;chapter&gt; &lt;title&gt; Começando com DHIS2 &lt;/ title&gt; xi &lt;: include xmlns: xi = &quot;http://www.w3.org/2001/XInclude&quot; href = &quot;dhis2_user_man_mod2.xml&quot; XPointer = &quot;mod2_1&quot; encoding = &quot;UTF-8&quot; /&gt;
-      </literallayout>
-    </para>
-    <para>
-      Note que o nome do arquivo e identificação tenha sido atribuído no documento do pai, referindo-se ao arquivo real (href) e fragmento específico do documento de criança que devem ser referenciados no documento pai (XPointer).
-    </para>
-    <para>
-      Incluindo capítulos de um livro é muito simples. O exemplo abaixo ilustra como:
-    </para>
-    <para>
-      <literallayout>
-        &lt;xi:include xmlns:xi=&quot;http://www.w3.org/2001/XInclude&quot; href=&quot;dhis2_user_man_ mod1.xml&quot; encoding=&quot;UTF-8&quot;/&gt;
-      </literallayout>
-    </para>
-    <para>
-      Neste caso, não há referência explícita a uma parte do documento, a menos que você só quer incluir uma parte do capítulo. Se você quiser usar uma seção do capítulo, você pode atribuir uma id para a seção, e em seguida, que a secção de referência através de um XPointer.
-    </para>
-  </section>
-  <section id="docs_8">
-    <title>
-      Manuseio de documentação multilingue
-    </title>
-    <para>
-      A estrutura do diretório da documentação foi criada para facilitar a criação de documentos em qualquer idioma. Se você quiser criar um novo conjunto de documentos em um determinado idioma, basta criar um novo diretório no
-      <filename>
-        dhis2-docbook-docs/src/docbkx /
-      </filename>
-      diretório. Certifique-se de usar o código ISO 639-1 para o idioma que você está indo para criar documentos dentro Uma lista completa destes códigos pode ser encontrada
-      <ulink url="http://en.wikipedia.org/wiki/ISO_639-1";>
-        aqui
-      </ulink>
-      . Adicionar uma nova pasta para imagens em um sub-diretório, substituindo o XX com o actual código ISO 639-1 para o idioma que você vai criar documentos polegadas Você também precisará editar o arquivo pom.xml no dhis2 principal docs-docbook - diretório. Se você não tiver certeza de que mudanças precisam ser feitas para este arquivo, pergunte na lista de discussão em primeiro lugar, como este arquivo controla a geração de toda a documentação.
-    </para>
-  </section>
-  <section id="docs_9">
-    <title>
-      Construindo a documentação
-    </title>
-    <para>
-      Uma das principais vantagens do formato DocBook é que a documentação de origem pode ser transformado em uma grande variedade de formatos, incluindo HTML, blocos HTML, XHTML, PDF e uma série de outros formatos. Há uma grande variedade de ferramentas que são capazes de executar essa tarefa. Basicamente, a fonte de XML do documento é transformado usando o padrão DocBook folhas de estilo XSL para o formato desejado. A lista completa de ferramentas capazes de transformar o DocBook, não serão listados aqui, mas alguns exemplos são fornecidos abaixo.
-    </para>
-    <para>
-      Últimas constrói da documentação estão disponíveis
-    </para>
-    <section>
-      <title>
-        Construindo a documentação com o Apache Maven
-      </title>
-      <para>
-        Para transformar os arquivos fonte da documentação para diferentes formatos, como HTML ou PDF, você precisará instalar o programa Apache Maven. Você pode obter uma cópia
-        <ulink url="http://maven.apache.org/download.html";>
-          aqui
-        </ulink>
-        ou instalando-lo através de seu gerenciador de pacotes se você estiver usando Linux. Basta executar o comando
-        <command>
-          limpos mvn package
-        </command>
-        no Windows ou no Linux a partir do
-        <filename>
-          / docs dhis2-docbook -
-        </filename>
-        diretório. Maven vai começar a baixar os componentes necessários para transformar os documentos em HMTL e PDF. Uma vez que o processo tenha sido concluído (seja paciente pela primeira vez, como há uma série de componentes que devem ser baixados), de todos os tipos de destino documento será gerado no diretório /
-        <filename>
-          dhis2-docbook-docs/target/docbkx
-        </filename>
-        diretório. Documentos HTML vai estar no diretório HTML e PDF será no diretório PDF.
-      </para>
-    </section>
-    <section>
-      <title>
-        Prédio com xmlto
-      </title>
-      <para>
-        <command>
-          xmlto
-        </command>
-        é uma ferramenta útil disponível na plataforma Linux para transformar documentos DocBook em diferentes formatos. Mais informações sobre o pacote pode ser encontrado
-        <ulink url="http://cyberelk.net/tim/software/xmlto/";>
-          aqui
-        </ulink>
-        . Se você não quiser usar o Apache Maven por algum motivo, você pode instalar
-        <command>
-          xmlto
-        </command>
-        através de seu gerenciador de pacotes. Depois de ter instalado
-        <command>
-          xmlto
-        </command>
-        você pode apenas executar
-        <command>
-          xmlto
-          <parameter>
-            html
-          </parameter>
-          <parameter>
-            file_to_transform
-          </parameter>
-        </command>
-        onde o
-        <parameter>
-          file_to_transform
-        </parameter>
-        parâmetro é o nome do arquivo que deseja transformar. Existem muitos outros formatos disponíveis, tais como PDF, PS, JavaHelp e outros.
-      </para>
-    </section>
-  </section>
-  <section id="docs_10">
-    <title>
-      Comprometendo as suas alterações de volta para o Launchpad
-    </title>
-    <para>
-      Depois de ter terminado o seu documento de edição, você terá de confirmar as suas alterações de volta para o Launchpad. Abra um prompt de comando no Windows ou um shell no Linux, e navegue até a pasta onde você colocou sua documentação. Se você adicionou novos arquivos ou pastas para sua filial local, você terá de adicioná-los à árvore de origem com o
-      <command>
-        bzr add
-      </command>
-      comando, seguido pelo nome de pasta ou arquivo (s) que você adicionou. Depois de ter adicionado todos os seus novos arquivos, você precisa comprometer-los ao seu ramo local com o seguinte comando:
-    </para>
-    <blockquote>
-      <para>
-        <command>
-          bzr commit-m &quot;Criado tradução Amárico da documentação&quot;
-        </command>
-      </para>
-    </blockquote>
-    <para>
-      Basta adicionar uma mensagem informativa do que você tem feito. Depois de ter cometido alterações em sua filial local, você pode empurrá-los para o ramo principal com o seguinte comando:
-      <blockquote>
-        <para>
-          <command>
-            bzr push bzr + ssh: / / bazaar.launchpad.net /% 7Edhis2-documenters/dhis2/dhis2-docbook-docs
-          </command>
-        </para>
-      </blockquote>
-    </para>
-    <para>
-      Se você tiver alguma dúvida, ou não pode achar que você pode começar, basta enviar um email com o seu problema
-      <email>
-        dhis2-documenters@xxxxxxxxxxxxxxxxxxx
-      </email>
-      .
-    </para>
-  </section>
-</chapter>
\ No newline at end of file

=== removed directory 'src/docbkx/ru'
=== removed file 'src/docbkx/ru/dhis2_documentation_guide.xml'
--- src/docbkx/ru/dhis2_documentation_guide.xml	2010-03-25 08:19:58 +0000
+++ src/docbkx/ru/dhis2_documentation_guide.xml	1970-01-01 00:00:00 +0000
@@ -1,409 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. -->
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; [
-<!ENTITY br ''>]>
-
-
-
-<chapter>
-  <chapterinfo>
-    <title>
-      DHIS 2 Документация Руководства
-    </title>
-    <author>
-      <firstname>
-        Jason
-      </firstname>
-      <surname>
-        Пикеринг
-      </surname>
-      <affiliation>
-        <orgname>
-        </orgname>
-      </affiliation>
-    </author>
-    <pubdate>
-      14/09/09
-    </pubdate>
-    <keywordset>
-      <keyword>
-        DHIS2
-      </keyword>
-      <keyword>
-        Документация
-      </keyword>
-      <keyword>
-        DocBook
-      </keyword>
-    </keywordset>
-    <revhistory>
-      <revision>
-        <revnumber>
-          2
-        </revnumber>
-        <date>
-          28/10/09
-        </date>
-        <revdescription>
-          <para>
-            Добавлено несколько более подробную информацию о многоязычных документов и редакторов.
-          </para>
-        </revdescription>
-      </revision>
-      <revision>
-        <revnumber>
-          1
-        </revnumber>
-        <date>
-          29/09/09
-        </date>
-        <revdescription>
-          <para>
-            Добавлено больше информации о начале работы с DocBook и BZR
-          </para>
-        </revdescription>
-      </revision>
-    </revhistory>
-  </chapterinfo>
-  <title>
-    DHIS2 документация Руководства
-  </title>
-  <section id="docs_1">
-    <title>
-      DHIS 2 Документация Обзор системы
-    </title>
-    <para remap="">
-      DHIS 2 представляет собой веб-совокупная система управления информацией при весьма активном развитии. Хотя в первую очередь предназначен для управления совокупности привязки данных о состоянии здоровья, он должен быть пригоден для использования системы для других целей, как хорошо. В настоящее время существует большое количество разорванных карманы документации в различных форматах (например, MediaWiki, документы Word, Confluence). Существует необходимость консолидации процесса подготовки документации и приведения его в большее соответствие с-распределенный характер развития самого приложения. Было сделано предположение, поэтому для перемещения текущей документации на платформу DocBook. В этой статье не будем обсуждать относительные преимущества платформы DocBook, а скорее будет служить кратким руководством по ее использованию DHIS 2 исполнителей, пользователи и разработчики. Читателям предлагается самостоятельно принимать решение о том, использовать или не DocBook для документации.
-    </para>
-  </section>
-  <section id="docs_2">
-    <title>
-      Введение
-    </title>
-    <para>
-      Одним из основных преимуществ является то, что DocBook существует полное разделение между содержанием и презентации. DocBook это чистый формат XML, и хорошо документированы. Считается, что лишь очень небольшая часть его функции будут необходимы для того, чтобы достичь гораздо более высокого качества документации DHIS. Есть некоторые отдельные марки 400-элементы, которые готовы выполнить практически любой уровень потребностей в технической документации, но в действительности, всего лишь несколько десятков из этих элементов, вероятно, должны быть использованы для достижения высокого качества документации DHIS 2, как для печатной а также он-лайн форматах, таких как HTML или комплексные системы помогают в самом приложении. Таким образом, существует широкий спектр возможностей, в рамках которого редактор может быть использована для создания файлов DocBook. Находится довольно полный список возможностей
-      <ulink url="http://wiki.docbook.org/topic/DocBookAuthoringTools";>
-        здесь
-      </ulink>
-      . В настоящее время рекомендуется использовать
-      <ulink url="http://www.syntext.com/products/serna-free/ ">
-        Syntext Серна Бесплатно
-      </ulink>
-      для редактирования DocBook исходных файлов в качестве WYSIWYG. Не рекомендуется использовать редактор XMLmind XML редактор Personal Edition (также известная как XXE личности), так как редактор &quot;молча&quot; местах ненужных пробелов и других орнаментов на источник DocBook, что делает совместное редактирование документов, очень сложно.
-    </para>
-    <para>
-      Одним из ключевых понятий иметь в виду, когда авторская документация в DocBook, презентацию или другие нейтральные форматы, в том, что
-      <emphasis role="bold">
-        содержание
-      </emphasis>
-      этого документа должны быть рассмотрены в первой инстанции.
-      <emphasis role="bold">
-        Презентация
-      </emphasis>
-      документа будет проходить в отдельный этап, где она будет оказываться в различные форматы, такие как HTML и PDF. Поэтому важно, что этот документ будет организованный и структурированный, с соответствующей метки DocBook и структурные элементы рассматриваются.
-    </para>
-    <para>
-      Это хорошая практика сломать ваш документ в различных разделах использовании &quot;секта&quot;, или раздела элемента. Секции элементы могут быть вложенными друг в друга, такие, как &quot;Раздел 1&quot; и &quot;раздел 2&quot;. Эта концепция является по существу таким же, как
-      <productname>
-        Microsoft Word
-      </productname>
-      или другие программы обработки текстов. DocBook автоматически позаботится нумерация разделов для вас, когда производится документом. Двумя другими важными элементами являются &quot;itemizedlist&quot; и &quot;NumberedList&quot;. Они очень похожи, но подробный перечень соответствует маркированный список, нумерованный список будет оказываться с каждым элементом которого пронумерованы. Другие ключевые элементы &quot;экрана&quot; и &quot;стол&quot;, который должен быть сам за себя.
-    </para>
-  </section>
-  <section id="docs_3">
-    <title>
-      Приступая к работе с Launchpad
-    </title>
-    <para>
-      В настоящее время документация система является частью исходного кода, хранящаяся в
-      <ulink url="https://launchpad.net/";>
-        Launchpad
-      </ulink>
-      . Launchpad представляет собой совместную платформу, которая позволяет нескольким людям работать над совместными проектами программного обеспечения. Для того чтобы это стало возможным, системы контроля версий является необходимым для того, чтобы управлять всеми изменениями, которые несколько пользователей могут сделать. Launchpad использует
-      <emphasis>
-        Базар
-      </emphasis>
-      система управления исходными текстами. Хотя это выходит за рамки этого документа для описания функциональности
-      <emphasis>
-        Базар
-      </emphasis>
-      Пользователи, которые хотят создать документации необходимо будет набрать не менее общее представление о том, как работает система. Основные инструкции приведены в следующем разделе.
-    </para>
-    <para>
-      Для того чтобы начать добавлении или редактировании документов, вы должны сначала выполнить выезда из исходного кода. Если вы еще не Launchpad Логин ID, вам будет необходимо получить. Это может быть сделано
-      <ulink url="https://launchpad.net/+login";>
-        здесь
-      </ulink>
-      . Если вы зарегистрировались на Launchpad, вам придется запросить доступ к
-      <emphasis>
-        dhis2-документирует
-      </emphasis>
-      группу. Войти на Launchpad, а затем запросить доступ
-      <ulink url="https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs";>
-        здесь
-      </ulink>
-      . Ваша заявка должна быть утверждена в группу администраторов. Как только вы получили доступ к группе, вы можете зафиксировать изменения в документации филиала, отправлять и получать сообщения электронной почты в список групп.
-    </para>
-  </section>
-  <section id="docs_4">
-    <title>
-      Получение исходного документа
-    </title>
-    <para>
-      Для того, чтобы править в документации, вам потребуется загрузить исходный страниц документации на компьютер. Launchpad использует систему контроля версий известных как BZR. Существуют различные методы для получения Базар работает над системой, в зависимости от установленной операционной системы, которую вы используете. Хороший шаг за шагом руководство для
-      <productname>
-        Microsoft
-      </productname>
-      операционных систем, можно рассматривать
-      <ulink url="http://wiki.showmedo.com/index.php/Using_Launchpad_and_Bazaar#Steps_to_download_a_project_on_Launchpad_that_uses_Bazaar_with_only_one_branch";>
-        здесь
-      </ulink>
-      . Если вы используете Linux, то вам нужно установить BZR на вашей системе через менеджер пакетов, или исходный код.
-    </para>
-    <para>
-      После установки BZR на вашей системе, вам необходимо загрузить исходный документ. Просто следуйте следующей процедуре:
-    </para>
-    <orderedlist>
-      <listitem>
-        <para>
-          Убедитесь, что у вас есть базар установлены.
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          Начало базар щелкнув правой кнопкой мыши папку, если вы используете
-          <productname>
-            Windows
-          </productname>
-          и выбора
-          <command>
-            Здесь BZR
-          </command>
-          . Если вы используете Linux, вы можете просто создать папку для хранения документов источников. Вы можете поместить исходный документ в любой папке вам нравится.
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          Чтобы загрузить последнюю версию пересмотра DHIS2 типа проектов документов:
-          <command>
-            BZR филиала http://bazaar.launchpad.net/% 7Edhis2-documenters/dhis2/dhis2-docbook-docs
-          </command>
-          Если вы используете Linux, или же, если вы используете
-          <productname>
-            Windows
-          </productname>
-          Введите URL в хранилище исходного кода &quot;
-          <ulink url="https://bazaar.launchpad.net/%7Edhis2-documenters/dhis2/dhis2-docbook-docs";>
-            http://bazaar.launchpad.net/ 7Edhis2-documenters/dhis2/dhis2-docbook-docs%
-          </ulink>
-          &quot;
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          Процесс загрузки должен начинаться и все файлы, документацию источника будут загружены в папку, которую вы указали.
-        </para>
-      </listitem>
-    </orderedlist>
-  </section>
-  <section id="docs_5">
-    <title>
-      Редактирование документации
-    </title>
-    <para>
-      После того как вы скачали исходники, вы должны иметь серию папок внутри dhis2-Docbook-Docs каталога. Все документы должны быть помещены в
-      <filename>
-        dhis2-docbook-docs/src/docbkx/XX
-      </filename>
-      папки. Обратите внимание, что
-      <filename>
-        XX
-      </filename>
-      представляет собой ISO 639-1 (два письма) код языка документации. Если вы разрабатываете Английский язык документации, поместить его внутрь
-      <filename>
-        / dhis2-docbook-docs/src/docbkx/en /
-      </filename>
-      папки. Место любые файлы изображений, которые могут быть связаны с вашим документом в
-      <filename>
-        / dhis2-docbook-docs/src/docbkx/XX/resources/images
-      </filename>
-      папки и ссылки внутри этих документа DocBook использование относительных ссылок на файлы. Когда построили документации, в отдельный шаг, изображения будут автоматически копироваться в правильный каталог в процессе сборки.
-    </para>
-  </section>
-  <section id="docs_6">
-    <title>
-      Использование изображений
-    </title>
-    <para>
-      Внешний вид, очень полезны для информирования пользователей о том, как конкретные действия должны быть выполнены. DocBook не имеет внутренние механизмы, чтобы точно знать, как изображение должно быть вынесено в итоговом документе. Таким образом, необходимо предоставить инструкции через атрибуты элементов. Следующий код XML фрагмента показывает, как изображение может быть указана занимают 80% от имеющейся ширине страницы. Для снимки экрана в альбомном формате, это, кажется, на соответствующую величину. Возможно, вам придется немного поэкспериментировать, чтобы получить надлежащее ширина изображения. Кроме того, можно изменить разрешение на само изображение, чтобы получить нужный размер во время рендеринга.
-    </para>
-    <literallayout>
-      &lt;screenshot&gt; &lt;screeninfo&gt; DHIS2 экране Войти &lt;/ screeninfo&gt; &lt;mediaobject&gt; &lt;imageobject&gt; &lt;imagedata fileref=&quot;dhis2_login_screen.jpg&quot; format=&quot;JPG&quot; width=&quot;80%&quot;/&gt; &lt;/ imageobject&gt; &lt;/ mediaobject&gt; &lt; / скриншот&gt;
-    </literallayout>
-    <para>
-      Для других изображений, в зависимости от их размера, различные значения могут быть необходимы. Если не указать ширину для вас образ, и ее собственного размера больше, чем ширина экрана, изображение может буфера в определенные типы документов с фиксированной шириной, такие как PDF.
-    </para>
-  </section>
-  <section id="docs_7">
-    <title>
-      Образцы документов вместе
-    </title>
-    <para>
-      DocBook предоставляет собой модульную структуру, где многие отдельные документы могут быть связаны друг с другом в мастер-документ. Фрагменты из различных документов также может быть использован в различных контекстах. Поэтому важно рассмотреть вопрос о вашем документе должны быть построены в виде статьи или раздела. Главы существенно часть книги, и поэтому могут быть связаны между собой в большей документа очень легко. Статья в основном автономные документы, но они также могут быть собраны вместе в большой документ на уровне компонентов.
-    </para>
-    <para>
-      Если вы захотите связать вместе несколько статей в книгу, DocBook предоставляет механизм присвоить идентификатор раздела. В примере, приведенном ниже, раздел был присвоен идентификатор. Это ID должно быть уникальным в пределах документа.
-    </para>
-    <para>
-      <literallayout>
-        &lt;section id=&quot;mod2_1&quot;&gt; &lt;title&gt; Приступая к работе с DHIS2 &lt;/ TITLE&gt; ....
-      </literallayout>
-    </para>
-    <para>
-      Для того, чтобы включить статью в книгу, XInclude заявлении должны быть использованы. Следующий пример показывает, каким образом.
-    </para>
-    <para>
-      <literallayout>
-        &lt;chapter&gt; &lt;title&gt; Приступая к работе с DHIS2 &lt;/ TITLE&gt; &lt;XI: включить XMLNS: XI = &quot;http://www.w3.org/2001/XInclude&quot; HREF = &quot;dhis2_user_man_mod2.xml&quot; XPointer = &quot;mod2_1&quot; Кодирование = &quot;UTF-8&quot; /&gt;
-      </literallayout>
-    </para>
-    <para>
-      Заметим, что имя файла и ID были назначены в основном документе, ссылаясь на фактическое файл (HREF), и особое фрагмента ребенка документе, который следует ссылаться в основном документе (XPointer).
-    </para>
-    <para>
-      Включая главы в книге, очень прост. Пример ниже иллюстрирует, как:
-    </para>
-    <para>
-      <literallayout>
-        &lt;xi:include xmlns:xi=&quot;http://www.w3.org/2001/XInclude&quot; href=&quot;dhis2_user_man_ mod1.xml&quot; encoding=&quot;UTF-8&quot;/&gt;
-      </literallayout>
-    </para>
-    <para>
-      В этом случае, нет необходимости явно ссылкой части документа, если только вы не хотите, чтобы включить часть главы. Если вы хотите использовать часть этой главы, вы можете присвоить идентификатор для этого раздела, а затем указание, что разрез XPointer.
-    </para>
-  </section>
-  <section id="docs_8">
-    <title>
-      Обработка многоязычной документации
-    </title>
-    <para>
-      Структура каталога документации был создан в целях содействия созданию документов на любом языке. Если вы хотите создать новый набор документов в той или иной язык, просто создайте новую папку в
-      <filename>
-        dhis2-docbook-docs/src/docbkx /
-      </filename>
-      каталоге. Обязательно используйте ISO 639-1 код языка вы собираетесь создавать документы дюйма полный перечень этих кодов можно найти
-      <ulink url="http://en.wikipedia.org/wiki/ISO_639-1";>
-        здесь
-      </ulink>
-      . Добавить новую папку для изображений в подкаталог, заменив XX с фактическими ISO 639-1 код языка вы будете создавать документы, в которой Вы также необходимо будет изменить pom.xml файл в главный dhis2-Docbook-Docs каталоге. Если вы не знаете, какие изменения необходимо внести в этот файл, задать вопрос в список рассылки первых, поскольку этот файл управляет генерацией вся документация.
-    </para>
-  </section>
-  <section id="docs_9">
-    <title>
-      Создание документации
-    </title>
-    <para>
-      Одним из основных преимуществ формата DocBook в том, что источником документации могут быть преобразованы в различные форматы, включая HTML, фрагментированное HTML, XHTML, PDF, а также ряд других форматов. Существуют разнообразные инструменты, которые способны выполнять эту задачу. В основном Исходный XML документ преобразуется с помощью стандартных листах DocBook XSL стиль в желаемом формате. Полный список инструментов, способных преобразовать DocBook не будет в списке, но несколько примеров приводится ниже.
-    </para>
-    <para>
-      Последняя версия документации доступны
-    </para>
-    <section>
-      <title>
-        Создание документации с Apache Maven
-      </title>
-      <para>
-        Для того, чтобы преобразовать файлы документации источник в различные форматы, такие как HTML или PDF, вам нужно установить программу Apache Maven. Вы можете получить копию
-        <ulink url="http://maven.apache.org/download.html";>
-          здесь
-        </ulink>
-        или путем установки его через менеджер пакетов, если вы используете Linux. Просто запустите команду
-        <command>
-          MVN чистые пакеты
-        </command>
-        В Windows или Linux с
-        <filename>
-          / dhis2-Docbook-Docs
-        </filename>
-        каталоге. Maven начнет загрузку компоненты, необходимые для преобразования документов в HMTL и PDF. После завершения процесса (будьте терпеливы в первый раз, так как есть целый ряд компонентов, которые должны быть загружены), все типы целевой документ будет создан в /
-        <filename>
-          dhis2-docbook-docs/target/docbkx
-        </filename>
-        каталоге. HTML документы будут находиться в каталоге HTML, PDF и документы будут находиться в каталоге PDF.
-      </para>
-    </section>
-    <section>
-      <title>
-        Здание с xmlto
-      </title>
-      <para>
-        <command>
-          xmlto
-        </command>
-        это полезная утилита доступна на платформах Linux для преобразования DocBook документов в различных форматах. Более подробную информацию о пакете можно найти
-        <ulink url="http://cyberelk.net/tim/software/xmlto/";>
-          здесь
-        </ulink>
-        . Если вы не хотите использовать Apache Maven по некоторым причинам, вы можете установить
-        <command>
-          xmlto
-        </command>
-        через менеджер пакетов. После установки
-        <command>
-          xmlto
-        </command>
-        Вы можете просто выполнить
-        <command>
-          xmlto
-          <parameter>
-            HTML
-          </parameter>
-          <parameter>
-            file_to_transform
-          </parameter>
-        </command>
-        где
-        <parameter>
-          file_to_transform
-        </parameter>
-        параметра является имя файла, который вы хотели бы преобразования. Есть много других форматах, таких как PDF, PS, JavaHelp и другие.
-      </para>
-    </section>
-  </section>
-  <section id="docs_10">
-    <title>
-      Фиксация ваших изменений к Launchpad
-    </title>
-    <para>
-      После того как вы закончили редактирование документа твоим, вам необходимо совершить изменения с Launchpad. Откройте командную строку Windows или Linux на оболочку и перейдите в папку, где вы разместили вашу документацию. Если вы добавили какие-либо новые файлы или папки на вашем местном отделении, вам необходимо добавить их в дерево исходных текстов с
-      <command>
-        Добавить BZR
-      </command>
-      команды, а затем папку или файл, имя (имена), которые вы добавили. После того как вы добавили все ваши новые файлы, вам придется совершить их в местные отделения с помощью следующей команды:
-    </para>
-    <blockquote>
-      <para>
-        <command>
-          BZR совершению-М &quot;создан амхарском перевода документации&quot;
-        </command>
-      </para>
-    </blockquote>
-    <para>
-      Просто добавьте информационное сообщение о том, что вы сделали. Когда вы совершили изменения в местное отделение, вы можете подтолкнуть их к мастер филиала с помощью следующей команды:
-      <blockquote>
-        <para>
-          <command>
-            BZR BZR Push + SSH: / / bazaar.launchpad.net /% 7Edhis2-documenters/dhis2/dhis2-docbook-docs
-          </command>
-        </para>
-      </blockquote>
-    </para>
-    <para>
-      Если у Вас возникли вопросы, или не могут найти, что вы можете начать поиск, достаточно отправить письмо с Вашей проблемой
-      <email>
-        dhis2-documenters@xxxxxxxxxxxxxxxxxxx
-      </email>
-      .
-    </para>
-  </section>
-</chapter>
\ No newline at end of file