--- README.maintainers.orig 2006-02-12 13:09:34.000000000 +0100 +++ README.maintainers 2006-02-12 13:25:27.000000000 +0100 @@ -3,41 +3,47 @@ maintainers) and translators (or translation teams). -Translators usually retrieve a POT (for a new translation) or the current +Translators usually fetch a POT (for a new translation) or retrieve the current PO for their language, then they translate the untranslated strings and -update the translation of the string marked fuzzy. +update the translation of the strings marked as fuzzy. +Updating files +-------------- + Translators need to know if a PO has to be updated: * they can verify the POs in the version control system or in the distributed archives/packages - * they can be inform by the translation teams, which automatically + * they can be informed by the translation teams, which automatically check the status of the POs in various packages. -We want to avoid the translator to be notified by an user reporting that -some strings are not translated even if the PO contain no untranslated or +We want to avoid translators to be notified by a user reporting that +some strings are not translated even if the PO contains neither untranslated nor fuzzy string. -Thus it is important to ensure that the POT are up-to-date with the -original documentation and that the POs contains the same strings as the -POT. +Thus it is important to ensure that the POTs are up-to-date with the +original documents and that the POs contain the same strings as the +POTs. - 1. Upstream maintainers should update the POT according to the orginal - documents and update the POs according to these uptodate POT when they + 1. Upstream maintainers should update the POTs according to the original + documents and update the POs according to these up-to-date POTs when they distribute an archive. - 2. If the switch to po4a is done in a distribution, the source package - should also contain up to date translation materials. + 2. If the switch to po4a has been done in a distribution, the source package + should also contain up-to-date translation materials. 3. If the documentation is patched by the distribution, the maintainer - must not forget to update the POT and POs. + must not forget to update the POTs and POs. It is important to ensure that the translation materials are updated automatically. +Architecture +------------ + A standardized architecture of the source tree will help the translation -teams when they try to detect the POS that need to be updated. +teams when they try to detect the POTs that need to be updated. Thus we recommend the following architecture: @@ -70,15 +76,15 @@ | | | \-- ... -We recommend to use a configuration file with po4a that does not require +We recommend to use a configuration file for po4a that does not require any option (put the options in the configuration file). -This permits to easily check that the POT is up-to-date with the +This permits to easily check if the POT is up-to-date with the documentation and that the -It is important to avoid a build failure in the case a generated +It is important to avoid a build failure if a generated translation cannot be generated (the PO is too outdated, an addendum -cannot be applied, ...), thus you should use wildcards or test if the file +cannot be applied, ...). You should therefore use wildcards or test if the file was generated in the 'install' or 'dist' rules @@ -90,7 +96,12 @@ When po4a is used upstream, we recommend to run po4a in the 'dist' rule. This will update the POT and POs, and will generate the translated documents. These translated documents can be distributed in the source archive if the -maintainer don't want to add a build dependency on po4a. +maintainer don't want to add a build dependency on po4a. You should then +add an autoconf check on po4a. It will allow you to update the documentation +if po4a is available on your system. If po4a is not available, documents +will be distributed without being synced with the original version, but the +build process won't fail. + It is important to distribute the POT and POs in the source archive. A typical dist rule could then be: @@ -116,11 +127,12 @@ (or 'build-indep') rule: clean: - # Updtate the POT and POs + # Update the POT and POs cd <...>/po4a && po4a --no-translations --rm-backups .cfg build: # Generate the translations cd <...>/po4a && po4a --rm-backups .cfg - +You should try to avoid distribution-specific build systems, to ensure the +portability of your software.