=== modified file 'src/docbkx/en/dhis2_documentation_guide.xml' --- src/docbkx/en/dhis2_documentation_guide.xml 2011-07-24 10:30:05 +0000 +++ src/docbkx/en/dhis2_documentation_guide.xml 2011-08-09 20:20:27 +0000 @@ -1,6 +1,5 @@ -]> + DHIS 2 Documentation Guide @@ -99,14 +98,14 @@ Using images Screen shots are very useful for providing information to users on how particular actions should be performed. DocBook has no intrinsic mechanisms to know exactly how an image should be rendered in the final document. Therefore, it is necessary to provide instructions through element attributes. The following XML code fragment demonstrates how an image can be specified to occupy 80% of the available page width. For screen shots in landscape format, this seems to be an appropriate amount. You may need to experiment a bit to obtain a proper width for your image. Alternatively, you can edit the resolution of the image itself, in order to obtain a proper size during rendering. - <screenshot> - <screeninfo>DHIS2 Login screen</screeninfo> - <mediaobject> + <screenshot> + <screeninfo>DHIS2 Login screen</screeninfo> + <mediaobject> <imageobject> - <imagedata fileref="dhis2_login_screen.jpg" format="JPG" width="80%"/> - </imageobject> + <imagedata fileref="dhis2_login_screen.jpg" format="JPG" width="80%"/> + </imageobject> </mediaobject> -</screenshot> +</screenshot> For other images, depending on their size, a different value may be necessary. If you do not specify a width for you image, and its intrinsic size is larger than the available screen width, the image may overflow in certain document types with a fixed width, such as PDF. @@ -117,21 +116,22 @@ Should you wish to link several articles together into a book, DocBook provides a mechanism to assign an id to a section. In the example below, a section has been assigned an id. This id must be unique within the document. - <section id="mod2_1"> -<title>Getting started with DHIS2</title> .... + <section id="mod2_1"> +<title>Getting started with DHIS2</title> .... In order to include an article into a book, an Xinclude statement must be used. The following example shows how. -<chapter> +<chapter> <title>Getting started with DHIS2</title> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dhis2_user_man_mod2.xml" xpointer="mod2_1" encoding="UTF-8"/> -... +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dhis2_user_man_mod2.xml" + xpointer="mod2_1" encoding="UTF-8"/> +... Note that the file name and id have been assigned in the parent document, referring to the actual file (href) and particular fragment of the child document that should be referenced in the parent document (xpointer). Including chapters in a book is very simple. The example below illustrates how: - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dhis2_user_man_ -mod1.xml" encoding="UTF-8"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dhis2_user_man_ +mod1.xml" encoding="UTF-8"/> In this case, there is no need to explicitly reference a part of the document, unless you only want to include a portion of the chapter. If you want to use a section of the chapter, you can assign an id to that section, and then reference that section through an xpointer.