dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 655
committer: Jason P. Pickering <jason.p.pickering@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sat 2013-03-02 07:12:08 +0200
message:
  Minor update to documentation guide.
modified:
  src/docbkx/en/dhis2_documentation_guide.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

=== modified file 'src/docbkx/en/dhis2_documentation_guide.xml'
--- src/docbkx/en/dhis2_documentation_guide.xml	2012-01-21 06:02:58 +0000
+++ src/docbkx/en/dhis2_documentation_guide.xml	2013-03-02 05:12:08 +0000
@@ -9,14 +9,14 @@
   <section id="docs_2">
     <title>Introduction</title>
     <para>One of the main advantages of DocBook is that there is complete separation between the
-content and presentation. DocBook is a pure XML format, and is well documented. It is believed that only a very small subset of its features will be required in order to achieve much higher quality documentation for DHIS. There are some 400 separate mark-up elements that cater to almost any level of technical documentation needs, but in reality, only a few dozen of these element will probably need to be employed to achieve high-quality documentation for DHIS 2, both for printed as well as on-line formats such as HTML or integrated help systems within the application itself. Therefore, there are wide range of possibilities in terms of which editor can be used for the creation of DocBook files. A fairly complete list of possibilities is located <ulink url="http://wiki.docbook.org/topic/DocBookAuthoringTools";>here</ulink>. It is currently recommended to use <ulink url="http://www.syntext.com/products/serna-free/ ">Syntext Serna Free</ulink> for editing DocBook source files as WYSIWYG. In principle, any text editing program or XML editor will be capable of being used to create DocBook files. </para>
+content and presentation. DocBook is a pure XML format, and is well documented. It is believed that only a very small subset of its features will be required in order to achieve much higher quality documentation for DHIS. There are some 400 separate mark-up elements that cater to almost any level of technical documentation needs, but in reality, only a few dozen of these element will probably need to be employed to achieve high-quality documentation for DHIS 2, both for printed as well as on-line formats such as HTML or integrated help systems within the application itself. Therefore, there are wide range of possibilities in terms of which editor can be used for the creation of DocBook files. A fairly complete list of possibilities is located <ulink url="http://wiki.docbook.org/topic/DocBookAuthoringTools";>here</ulink>. It is currently recommended to use  WYSIWYG  <ulink url="http://sourceforge.net/projects/sernafree.mirror/files/latest/download";>Syntext Serna Free</ulink>   editor for editing DocBook source files. In principle, any text editing program or XML editor can be used to author DocBook files.</para>
     <note>
       <para>It is not recommended to use the editor XMLmind XML Editor Personal Edition (also known as XXE Personal), as the editor &quot;silently&quot; places unneeded whitespace and other ornamentation to the DocBook source which makes collaborative editing of documents very difficult. </para>
     </note>
     <para>One of the key concepts to keep in mind when authoring documentation in DocBook, or other
 presentation neutral formats, is that the <emphasis role="bold">content </emphasis>of the document should be considered in the first instance. The <emphasis role="bold">presentation </emphasis>of the document will take place in a separate step, where it will be rendered into
 different formats, such as HTML and PDF. It is therefore important that the document is will organised and structured, with appropriate DocBook tags and structural elements being considered.</para>
-    <para>It is good practise to break your document in to various sections using the
+    <para>It is good practice to break your document in to various sections using the
 &quot;sect&quot;, or section element. Section elements can also be nested within each other, such as &quot;Section 1&quot; and &quot;Section 2&quot;. This concept is essentially the same as <productname>Microsoft Word</productname> or other word processing programs. DocBook will automatically take care of numbering the sections for you when the document is produced. Two other important elements are the &quot;itemizedlist&quot; and &quot;numberedlist&quot;. These are quite similar, but an itemised list corresponds to a bulleted list, which a numbered list will be rendered with each element being numbered sequentially. Other key elements are &quot;screenshot&quot; and &quot;table&quot; which should be self-explanatory.</para>
   </section>
   <section id="docs_3">
@@ -104,7 +104,7 @@
     <title>Handling multilingual documentation</title>
     <para>The directory structure of the documentation has been created in order to facilitate the
 creation of documents in any language. If you want to create a new set of documents in a given language, simply create a new directory in the <filename>dhis2-docbook-docs/src/docbkx/</filename> directory. Be sure to use the ISO 639-1 code for the language you are going to create documents in. A complete list of these codes can be found <ulink url="http://en.wikipedia.org/wiki/ISO_639-1";>here</ulink>. Add a new folder for
-images in a sub-directory , replacing XX with the actual ISO 639-1 code for the language you will create documents in. You will also need to edit the pom.xml file in the main dhis2-docbook-docs directory. If you are unsure of what changes need to be made to this file, ask on the mailing list first, as this file controls the generation of all the documentation. </para>
+images in a sub-directory , replacing XX with the actual ISO 639-1 code for the language you will create documents in. You will also need to edit the <filename>pom.xml </filename>file in the main dhis2-docbook-docs directory. If you are unsure of what changes need to be made to this file, ask on the mailing list first, as this file controls the generation of all the documentation. </para>
   </section>
   <section id="docs_9">
     <title>Building the documentation</title>