dhis2-devs team mailing list archive

[Jason Pickering <jason.p.pickering@xxxxxxxxx>]

Hi.

Basically, if your document is intended to be part of the user manual,
you should construct it as a chapter. I would reccomend to do it this
way, as it seems to make more sense.

If it is meant to be a standalone type of document, you can use an article.


The main user manual is the dhis2_user_manual.xml document. Your
chapter will be included with an xinclude statement, similar to the
other chapters.

Hope this is clear.

The latest successful builds of the documents are available here..

http://dhis.uio.no/ci/job/Dhis2%20documentation/

Best regards,
jason

On Wed, Dec 9, 2009 at 4:52 PM, Dr. Juma Lungo <juma.lungo@xxxxxxxxxxxx> wrote:
> Hi Jason
> i have now managed to checkout the document from launchpad.
> i suppose
> under /src/docbkx/en/ is where document chapters are.
> or how can i get an index (table of content) that can quickly show me what
> is already in the document.
> i am still downloading my serna free and its dependencies.
>
> Juma
>
>
> -------- Original Message --------
> Subject: Re: [Dhis2-devs] Documentation
> From: Jason Pickering <jason.p.pickering@xxxxxxxxx>
> Date: Wed, December 09, 2009 5:02 pm
> To: "Dr. Juma Lungo" <juma.lungo@xxxxxxxxxxxx>
> Cc: Bob Jolliffe <bobjolliffe@xxxxxxxxx>, Arther HISP
> <arthurheywood@xxxxxxxxx>, John lewis <johnlewis.hisp@xxxxxxxxx>,
> dhis2-documenters@xxxxxxxxxxxxxxxxxxx, dhis2-devs
> <dhis2-devs@xxxxxxxxxxxxxxxxxxx>, anthony muyepa
> <anthony_muyepa@xxxxxxxxxxx>
>
> Hi Juma,
>
> I have used both Oxygen and XMLSpy , but quite honestly, I felt they
> were a bit overkill for the purposes of DocBook at least at this
> point, IMHO. I stopped using them quite early on. Serna is heavily
> geared towards DocBook production, whereas Oxygen and XMLSpy are
> really just generalized XML tools, although they are very powerful.
> The only downside of using Serna that I have found thus far, is it can
> be a bit lax in validating the document properly. Using xmllint can
> really help to ensure that the document properly validates.
>
> Serna is quite good I think, and though the download (especially in
> this part of the world) is painful. I bounce back and forth between
> Serna and vi, as sometimes it is more useful to edit the source of the
> document directly, without all the pretty printing of Serna. The first
> download of the docs is pretty heavy as well, because of all the
> images. The last part of the process (transforming the documents with
> maven) will be equally painful in terms of downloading the first time.
> However, these are pretty much one off processes and once this is
> done, synchronization to and from the repository can take place
> through differential updates. This was one of my key drivers here in
> Lusaka, as our internet is certainly worse than next door in TZ. :)
>
>
> Anyway, my two cents. One of the other reasons we chose DocBook was
> that you can use essentially any editor you are comfortable with. In
> my case, I have settled on vi and Serna for now, but if something else
> pops up, it is easy to switch.
>
> Regards,
> Jason
>
>
>
> On Wed, Dec 9, 2009 at 3:28 PM, Dr. Juma Lungo <juma.lungo@xxxxxxxxxxxx>
> wrote:
>> Hi Bob
>> My Geneva Oxygen XML has expired. Now i am in the process of installing
>> Serna Free, slow internet takes longer.
>> may be HISP need to buy us serious Programming Tools like oxygen.
>>
>> Lungo
>>
>> -------- Original Message --------
>> Subject: Re: [Dhis2-devs] Documentation
>> From: Bob Jolliffe <bobjolliffe@xxxxxxxxx>
>> Date: Wed, December 09, 2009 2:45 pm
>> To: Juma Lungo <juma.lungo@xxxxxxxxxxxx>
>> Cc: Jason Pickering <jason.p.pickering@xxxxxxxxx>, Arther HISP
>> <arthurheywood@xxxxxxxxx>, John lewis <johnlewis.hisp@xxxxxxxxx>,
>> dhis2-documenters@xxxxxxxxxxxxxxxxxxx, dhis2-devs
>> <dhis2-devs@xxxxxxxxxxxxxxxxxxx>, anthony muyepa
>> <anthony_muyepa@xxxxxxxxxxx>
>>
>> Hi Juma
>>
>> Good to see you have some documentation for installing on Ubuntu.  I did
>> create a dhis2 "deb packager" last week which is in the repository under
>> tools.  Should make the ubuntu installation process much simpler.  I can
>> merge documentation for this with your documentation once you have it up.
>>
>> Bob.
>>
>> 2009/12/9 Juma Lungo <juma.lungo@xxxxxxxxxxxx>
>>>
>>> Thanks Jason
>>> i would like to be part of this movement.
>>> we have also created some pieces of documentations.
>>> for example how to install DHIS2 in Ubuntu, and some health programme
>>> specific training manuals.
>>> lets see how we can incoorperate this into the larger document.
>>>
>>> Lungo
>>>
>>> Jason Pickering wrote:
>>>
>>> Hi Lungo,
>>> I have been helping out with the documentation effort. I am not sure
>>> how much of the conversation you have followed, so I will briefly
>>> start from the top. We had a discussion a few months back about trying
>>> to consolidate all of the different documentation efforts into a
>>> single repository, so that we can all collaborate together on it. We
>>> decided to try and move all of the documentation to the DocBook
>>> format, which is a pure XML format that is presentation neutral and
>>> makes it easier for us to produce modular documents in a distributed
>>> manner.
>>>
>>> You can take a look at the documentation guide, to get you started. It
>>> is available here..
>>>
>>>
>>>
>>> http://dhis.uio.no/ci/job/Dhis2%20documentation/lastSuccessfulBuild/artifact/target/site/en/pdf/dhis2_documentation_guide.pdf
>>>
>>> It may look rather daunting at first, but once you get started, it is
>>> pretty easy, especially if you are using one of the WYSIWYG editors
>>> like Serna Free.
>>>
>>> I will be happy to try and help get you started.
>>>
>>> Best regards,
>>> Jason
>>>
>>>
>>>
>>>
>>> On Wed, Dec 9, 2009 at 9:48 AM, Juma Lungo <juma.lungo@xxxxxxxxxxxx>
>>> wrote:
>>>
>>>
>>> Hi Lars
>>>
>>> may be i have missed an email.
>>> where is the current documentation you are refering to.
>>> dhis2 documentation is a top priority work for the tanzanian case now.
>>>
>>> Lungo
>>>
>>>
>>> Jason Pickering wrote:
>>>
>>> Hi Lars,
>>> Agreed for now.
>>>
>>> I have some extra time on my hands right now, so I can try and work on
>>> this a bit more if you get some more material.
>>>
>>>
>>> regards,
>>> Jason
>>>
>>> 2009/12/8 Lars Helge Øverland <larshelge@xxxxxxxxx>:
>>>
>>>
>>> Thanks a lot for this contribution Jason. The docs is really starting to
>>> look better.
>>>
>>> I will talk to Calle and see if he has some inputs. HISP SA has
>>> apparently
>>> produced a lot of material which could be borrowed from.
>>>
>>> Re the inclusion in trunk I have changed my mind anyway, the size of the
>>> doc
>>> branch is increasing quickly with all the images and would add too much
>>> size
>>> for people only wanting the code.
>>>
>>> Lars
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Mailing list: https://launchpad.net/~dhis2-devs
>>> Post to     : dhis2-devs@xxxxxxxxxxxxxxxxxxx
>>> Unsubscribe : https://launchpad.net/~dhis2-devs
>>> More help   : https://help.launchpad.net/ListHelp
>>>
>>
>>
>