keryx team mailing list archive

[Douglass Clem <crashsystems@xxxxxxxxx>]

This evening (by my point of view) I was chatting with several people on
#Keryx, talking about the topics of translation and documentation. As far as
documentation goes, we were of the idea to build static XHTML documentation,
and have that bundled with the program. This would have several advantages,
one being that it would allow us to use bzr version control on the contents,
and another being that Keryx could be made to open up a browser with the
appropriate help section whenever a contextual help button was clicked.

I was however clueless how we could integrate this with Launchpad's
translation platform though. After doing some thinking, and receiving some
inspiration from this
article<http://www.fsfe.org/en/fellows/ciaran/ciaran_s_free_software_notes/gettext_for_static_websites>,
I have an idea that I would like to propose to you.

The documentation would be contained in /doc/help/xx, where 'xx' is the
language abbreviation. I would write a simple python program that would
write XHTML to a file. This program would use GNU gettext for all the
translatable strings, which would be divided up by paragraph. This would
allow us to generate .pot files for the documentation content allowing it to
play nice with Launchpad's translation support. Before every release, we
would need to have each translator run this program on his/her machine,
therefore generating the XHTML content that we will be putting in each
/doc/help/xx folder.

That is my master plan. What do you think? Can you foresee any problems with
this?

--
Douglass Clem
crashsystems.net
Public Key: http://crashsystems.net/pubkey.asc

READ CAREFULLY. By reading this email, you agree, on behalf of your
employer, to release me from all obligations and waivers arising from
any and all NON-NEGOTIATED  agreements, licenses, terms-of-service,
shrinkwrap, clickwrap, browsewrap, confidentiality, non-disclosure,
non-compete and acceptable use policies ("BOGUS AGREEMENTS") that I have
entered into with your employer, its partners, licensors, agents and
assigns, in perpetuity, without prejudice to my ongoing rights and
privileges. You further represent that you have the authority to release
me from any BOGUS AGREEMENTS on behalf of your employer.