Multilingual documents in the documentation branch

Howdy. I have managed to modify, I think, the directory structure a
bit to make the creation of multilingual version of documents a bit
more manageable. I will update the documentation guide soon on exactly
what the procedure is. Briefly, all documents for a given language
should be placed into the /src/docbkx/XX folder, where XX represents
the ISO language code ( I suggest 639-1 unless there are other
reasons, but this should match what DHIS2 is using as well). All
resources, such as images, should be placed in the /src/resources
directory, which has been moved out of the /src/docbkx directory. I
am assuming that maybe the images should be language independent, but
am not really sure about this. This is a point for consideration.
Otherwise, we may need to move the image resources back into a given
language directory. Maybe those thinking of creating docs in languages
other than English can comment on whether screen shots and the like
will need to be language specific.

I will try and explain all the changes in the documentation guide, and
of course, suggestions/criticisms are welcome.

Best regards,
Jason

Thanks for doing this Jason, good work.

I think images are just as context-bound as the text.
We’ve seen from our previous work that It is important to have screen shots from the local version in the manual reflecting local data element names, reports etc. If this is not too complicated to achieve I would suggest we go for this.

Ola

···

2009/10/27 Jason Pickering jason.p.pickering@gmail.com

Howdy. I have managed to modify, I think, the directory structure a

bit to make the creation of multilingual version of documents a bit

more manageable. I will update the documentation guide soon on exactly

what the procedure is. Briefly, all documents for a given language

should be placed into the /src/docbkx/XX folder, where XX represents

the ISO language code ( I suggest 639-1 unless there are other

reasons, but this should match what DHIS2 is using as well). All

resources, such as images, should be placed in the /src/resources

directory, which has been moved out of the /src/docbkx directory. I

am assuming that maybe the images should be language independent, but

am not really sure about this. This is a point for consideration.


Otherwise, we may need to move the image resources back into a given

language directory. Maybe those thinking of creating docs in languages

other than English can comment on whether screen shots and the like

will need to be language specific.

I will try and explain all the changes in the documentation guide, and

of course, suggestions/criticisms are welcome.

Best regards,

Jason


Mailing list: https://launchpad.net/~dhis2-devs

Post to : dhis2-devs@lists.launchpad.net

Unsubscribe : https://launchpad.net/~dhis2-devs

More help : https://help.launchpad.net/ListHelp

No, this is fine. I will place them back in the "en" directory, and
then we update the documentation guide with this in mind.

Best regards,
Jason

···

On Wed, Oct 28, 2009 at 10:11 AM, Ola Hodne Titlestad <olatitle@gmail.com> wrote:

2009/10/27 Jason Pickering <jason.p.pickering@gmail.com>

Howdy. I have managed to modify, I think, the directory structure a
bit to make the creation of multilingual version of documents a bit
more manageable. I will update the documentation guide soon on exactly
what the procedure is. Briefly, all documents for a given language
should be placed into the /src/docbkx/XX folder, where XX represents
the ISO language code ( I suggest 639-1 unless there are other
reasons, but this should match what DHIS2 is using as well). All
resources, such as images, should be placed in the /src/resources
directory, which has been moved out of the /src/docbkx directory. I
am assuming that maybe the images should be language independent, but
am not really sure about this. This is a point for consideration.

Thanks for doing this Jason, good work.

I think images are just as context-bound as the text.
We've seen from our previous work that It is important to have screen shots
from the local version in the manual reflecting local data element names,
reports etc. If this is not too complicated to achieve I would suggest we go
for this.

Ola
-----------

Otherwise, we may need to move the image resources back into a given
language directory. Maybe those thinking of creating docs in languages
other than English can comment on whether screen shots and the like
will need to be language specific.

I will try and explain all the changes in the documentation guide, and
of course, suggestions/criticisms are welcome.

Best regards,
Jason

_______________________________________________
Mailing list: DHIS 2 developers in Launchpad
Post to : dhis2-devs@lists.launchpad.net
Unsubscribe : DHIS 2 developers in Launchpad
More help : ListHelp - Launchpad Help