[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Bug#257150: Any timeframe for updating the developers reference?

On Sat, Aug 04, 2007 at 08:43:58PM +0200, hertzog@debian.org wrote:
> retitle 257150 Paragraph about i18ned documentation is outdated
> severity 257150 normal
> thanks
> Replying to an old bug and discussion.
> On Sun, 18 Sep 2005, Frédéric Bothamy wrote:
> > * Helge Kreutzmann <kreutzm@itp.uni-hannover.de> [2005-09-18 13:15] :
> > > Hello,
> > > the french team has some people very capable of all the details
> > > regarding translation. Maybe you can ask them to update 
> > > 
> > > 6.6.2 Internationalized documentation
> > > 
> > > which would a) close my bug and b) help other translators. Do you
> > > think this is possible for Etch?
> > 
> > AFAIK doc-check is not available in any package now. It is available in
> > some CVS (for instance for the securing-howto).
> I think that the whole paragraph is outdated anyway. It doesn't make
> much sense to update the link in those conditions.

Well, it seems doc-check is still used in D-I, so I preferred to update
the link to point to D-I's doc-check.

> Nowadays, po4a or poxml are preferred to handle translations of documents.
> It looks like Nicolas François (in CC) could write us a little paragraph
> on this topic.

I've added a paragraph mentioning these tools, and a paragraph mentioning
the quite complete document written for DebConf6 by Christian and Javier
about Internationalization in Debian.

Kind Regards,
diff -rauN ../orig/developers-reference-3.3.8/common.ent ./developers-reference-3.3.8/common.ent
--- ../orig/developers-reference-3.3.8/common.ent	2006-11-11 19:13:05.000000000 +0100
+++ ./developers-reference-3.3.8/common.ent	2007-08-05 01:15:22.000000000 +0200
@@ -111,7 +111,7 @@
 <!ENTITY url-dmup "http://&www-debian-org;/devel/dmup";>
 <!ENTITY url-worldmap "http://&www-debian-org;/devel/developers.loc";>
-<!ENTITY url-i18n-doc-check "http://cvs.debian.org/boot-floppies/documentation/doc-check?rev=HEAD&amp;content-type=text/vnd.viewcvs-markup";>
+<!ENTITY url-i18n-doc-check "http://svn.debian.org/wsvn/d-i/trunk/manual/scripts/doc-check?op=file";>
 <!ENTITY url-eg-desc-upstream-info "http://&packages-host;/unstable/web/wml";>
diff -rauN ../orig/developers-reference-3.3.8/developers-reference.sgml ./developers-reference-3.3.8/developers-reference.sgml
--- ../orig/developers-reference-3.3.8/developers-reference.sgml	2006-11-12 12:05:22.000000000 +0100
+++ ./developers-reference-3.3.8/developers-reference.sgml	2007-08-05 01:59:26.000000000 +0200
@@ -4577,6 +4577,12 @@
       <sect id="bpp-i18n">
+        <p>
+This section contains global information for developers to make translators'
+life easier.  More information for translators and developers interrested
+in internationalization are available in the
+<url id="http://people.debian.org/~jfs/debconf6/html/";
+name="Internationalisation and localisation in Debian"> documentation.
 	<sect1 id="bpp-i18n-debconf">
           <heading>Handling debconf translations</heading>
@@ -4614,25 +4620,30 @@
 labor.  There's no way to eliminate all that work, but you can make things
 easier for translators.
-If you maintain documentation of any size, its easier for translators
+If you maintain documentation of any size, it is easier for translators
 if they have access to a source control system.  That lets translators
 see the differences between two versions of the documentation, so, for
 instance, they can see what needs to be retranslated.  It is
 recommended that the translated documentation maintain a note about
 what source control revision the translation is based on.  An
 interesting system is provided by <url id="&url-i18n-doc-check;"
-name="doc-check"> in the <package>boot-floppies</package> package,
+name="doc-check"> in the <package>d-i</package> package,
 which shows an overview of the translation status for any given
 language, using structured comments for the current revision of the
 file to be translated and, for a translated file, the revision of the
 original file the translation is based on.  You might wish to adapt
-and provide that in your CVS area.
+and provide that in your Subversion area.
 If you maintain XML or SGML documentation, we suggest that you isolate
 any language-independent information and define those as entities in a
 separate file which is included by all the different
 translations. This makes it much easier, for instance, to keep URLs
 up to date across multiple files.
+          <p>
+Some tools (e.g. po4a, poxml, or the translate-toolkit) are specialized in
+extracting the translatable material from different formats.  They produce
+PO files, a format quite common to translators, which permits to see what
+needs to be retranslated when the translated document is updated.

Reply to: