dhis2-documenters team mailing list archive

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

Some of you may have noticed I have added a bibliography to the main user
manual. Let me explain more or less what I have done, and ask for feedback.

1) A directory has been added to the branch called "bibliography". Contained
in this directory are several files.
dhis2_bibliography.bib- A BIBTEX formatted bibliography, which was produced
in JabRef. Theoretically, you could use any number of tools to manage this,
but JabRef was the one I settled on. Others may prefer Emacs of vi. Your
choice really. Managing the bibliography in native DocBook bibliography
format would be ideal, but there do not seem to be any tools out there
capable of doing this. JabRef seems to be very capable, and can export to a
number of different formats, including DocBook.
2) A few files named "docbook44...". These can be used to export the
bibliography to DocBook format with a few changes to the source code.
3) jabref_docbook44.diff which is a patch against the current trunk of
JabRef which will allow exporting to DocBook 4.4 (which the current user
documentation is in) directly. Apply this patch to the JabRef source tree
and recompile, and you are good to go. I submitted this patch to the JabRef
devs, so maybe it will get included in the next release.

So, once you add any references to the bibliography, you just export the
DocBook 4.4 file to dhis2_bibliography.xml (in the /src/docbkx/en directory)
and you are good to go.

Not the best workflow I know, but the best one I could come up with. If any
one has any better suggestions, just feel free to offer them up.

At any rate, it would be useful to begin to compile a bibliography of
theses/articles and even unpublished works (such as project reports) as part
of the documentation. These sorts of documents can be very useful to
implementers and people developing research and project proposals.

Best regards,
Jason