[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
trans-coord/gnun/server/gnun doc/gnun.texi doc/...
|
From: |
Pavel Kharitonov |
|
Subject: |
trans-coord/gnun/server/gnun doc/gnun.texi doc/... |
|
Date: |
Fri, 08 Mar 2013 12:03:07 +0000 |
CVSROOT: /sources/trans-coord
Module name: trans-coord
Changes by: Pavel Kharitonov <ineiev> 13/03/08 12:03:07
Modified files:
gnun/server/gnun/doc: gnun.texi web-trans.texi
gnun/server/gnun: ChangeLog
Log message:
Minor documentation rearrangements and fixes.
* doc/gnun.texi (Main Variables): Move `FUZZY_DIFF_LINGUAS'
description up.
(Team's Repository): Improve footnote wording.
(GNUmakefile.team Variables): Add `ADD_FUZZY_DIFF' anchor,
reword reference to `gnun-add-fuzzy-diff'.
(PO Files): Improve the introduction.
(New Translation): Split the node, creating the following:
(PO Header, GNUN Slots, Wrapping Long Lines): New nodes
whose texts come from former `New Translation' (the
`GNUN Slots' anchor is removed).
(PO Header): Fix header example (s/8-bit/8bit/); fix a typo
s/80 lines/80 characters/.
(Wrapping Long Lines): Move down, after the description of GNUN slots.
(PO Tips): Remove obsolete recommendation on FSF address, it
is not in the boilerplate these days.
(Modifying Templates, Validation): Merge `Validation' to
`Modifying Templates', put the result in place of `Validation'.
(Webmasters Tips): Adjust the menu.
(Comments for Translators): Remove spurious comment.
(gnun-add-fuzzy-diff): Add references to `wdiff',
`FUZZY_DIFF_LINGUAS' and `ADD_FUZZY_DIFF'.
* doc/web-trans.texi (Updating): Fix mistakes in grammar.
Add a reference to `gnun-add-fuzzy-diff'.
(PO Files): Improve footnote wording.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/trans-coord/gnun/server/gnun/doc/gnun.texi?cvsroot=trans-coord&r1=1.85&r2=1.86
http://cvs.savannah.gnu.org/viewcvs/trans-coord/gnun/server/gnun/doc/web-trans.texi?cvsroot=trans-coord&r1=1.53&r2=1.54
http://cvs.savannah.gnu.org/viewcvs/trans-coord/gnun/server/gnun/ChangeLog?cvsroot=trans-coord&r1=1.360&r2=1.361
Patches:
Index: doc/gnun.texi
===================================================================
RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/doc/gnun.texi,v
retrieving revision 1.85
retrieving revision 1.86
diff -u -b -r1.85 -r1.86
--- doc/gnun.texi 28 Feb 2013 12:14:08 -0000 1.85
+++ doc/gnun.texi 8 Mar 2013 12:03:07 -0000 1.86
@@ -854,8 +854,8 @@
address@hidden because presumably, they are more familiar with
GNUnited Nations' internals. From a purely technical point of view,
there is no difference.}, ideally after performing some local tests. A
-translation team leader should update only @code{FUZZY_DIFF_LINGUAS},
address@hidden; everything else is supposed to be built
+translation team leader should update only @code{FUZZY_DIFF_LINGUAS}
+and @code{TEMPLATE_LINGUAS}; everything else is supposed to be built
automagically, without manual intervention. If not, that is a bug that
should be reported and fixed.
@@ -888,6 +888,14 @@
@item @file{server/address@hidden
@end itemize
address@hidden FUZZY_DIFF_LINGUAS
address@hidden
address@hidden previous, diff
address@hidden FUZZY_DIFF_LINGUAS
+Add your language code here if you want GNUN to add differences to
+``previous'' @code{msgid}s in your PO files.
address@hidden, for more information.
+
@cindex extra-templates
@cindex templates, additional
@cindex defining templates
@@ -926,14 +934,6 @@
sitemaps, that is, an additional externally generated compendium is used
when updating them. @xref{Sitemap}, for more information.
address@hidden FUZZY_DIFF_LINGUAS
address@hidden previous, diff
address@hidden FUZZY_DIFF_LINGUAS
-Add your language code here if you want GNUN to add differences to
-``previous'' @code{msgid}s in your PO files. The differences are shown in
-the default @command{wdiff} format. @xref{wdiff, wdiff, The word
-difference finder, wdiff, GNU wdiff}, for more information.
-
@cindex ROOT
@cindex articles in root directory, defining
@cindex defining articles in the root dir
@@ -1185,7 +1185,7 @@
persons interested in particular address@hidden following
sections describe in more details how to setup these automatic
actions; however, if you have any difficulties with that, please ask
-the GNU Web Translation Managers to make it for your team using our
+the GNU Web Translation Managers to setup them for your team on our
server.}. A translator would then normally update the PO file, and
commit it again in the project's Sources repository, from where the
coordinator will pick it up and install it in `www'.
@@ -1278,10 +1278,12 @@
@table @samp
@item ADD_FUZZY_DIFF
address@hidden
The program to manage differences to ``previous'' @code{msgid}s added to
``fuzzy'' translations when merging PO files. When undefined,
the makefile tries to find @command{gnun-add-fuzzy-diff} and assigns
-the result to this variable. @xref{gnun-add-fuzzy-diff}.
+the result to this variable. @xref{gnun-add-fuzzy-diff}, for more
+information.
Define to empty string to disable the feature.
@@ -1533,16 +1535,18 @@
@node PO Files
@chapter Working with PO Files
-This section provides GNUN-specific information about woking
-with PO files. For general information, @pxref{PO Files, ,
+This section provides technical details about woking with PO files.
+For general information about PO editors, @pxref{PO Files, ,
Working with PO Files, web-trans, GNU Web Translators Manual}.
@menu
* New Translation:: How to start a new translation.
+* PO Header:: How to fill the header of a new translation.
+* GNUN Slots:: Special GNUN messages.
+* Wrapping Long Lines::
* PO Tips:: Tips and hints for translators.
* Migrating:: How to migrate an existing translation to a PO
format under GNUN's control.
-
@end menu
@node New Translation
@@ -1570,6 +1574,10 @@
GNUN also provides a customized script to automatically fill more
header fields. @xref{gnun-init-po}.
address@hidden PO Header
address@hidden Filling the PO File Header
address@hidden PO files, header
+
The PO file header as generated usually looks like this:
@example
@@ -1661,7 +1669,7 @@
"Language-Team: Bulgarian <www-bg-list@@gnu.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8-bit\n"
+"Content-Transfer-Encoding: 8bit\n"
@end group
@end example
@@ -1670,16 +1678,18 @@
simply pressing @key{TAB} in PO mode).
It is recommended that you wrap all lines in the comments to be less
-than 80 lines; that looks better from a purely aesthetic point of view
+than 80 characters; that looks better from a purely aesthetic point of view
and improves the performance of @file{GNUmakefile.team}'s @code{publish}
rule (@pxref{publish}).
address@hidden GNUN Slots
address@hidden Special GNUN messages
+
There are some special messages that appear in the POT and PO:
@table @samp
@cindex notes, translators
@cindex translators' notes
address@hidden Slots}
@item *GNUN-SLOT: TRANSLATOR'S NOTES*
This is for translator's notes that are injected in the resulting
translation. @xref{Notes Slot}, for more information. If your
@@ -1702,55 +1712,6 @@
@xref{Credits Slot}.
@end table
address@hidden wrapping long lines
address@hidden long lines, wrap
-Most of the PO editors do not wrap long lines that inevitably appear in
address@hidden If that happens, long lines make reading subsequent
-diffs harder, and are generally annoying for most people. If this issue
-bothers you, you can ``normalize'' the already finished PO translation
-by executing on the command line @code{msgcat -o @var{file}.po
address@hidden, before installing it in the repository. Either way, the
-build system will treat it is a valid PO file.
-
-For those lucky Emacs users, here is a code snippet that you can put
-in your @file{.emacs}; doing @kbd{M-x po-wrap} while in PO mode will
-wrap all long lines:
-
address@hidden
address@hidden
-(defun po-wrap ()
- "Filter current po-mode buffer through `msgcat' tool to wrap all lines."
- (interactive)
- (if (eq major-mode 'po-mode)
- (let ((tmp-file (make-temp-file "po-wrap."))
- (tmp-buf (generate-new-buffer "*temp*")))
- (unwind-protect
- (progn
- (write-region (point-min) (point-max) tmp-file nil 1)
- (if (zerop
- (call-process
- "msgcat" nil tmp-buf t (shell-quote-argument tmp-file)))
- (let ((saved (point))
- (inhibit-read-only t))
- (delete-region (point-min) (point-max))
- (insert-buffer tmp-buf)
- (goto-char (min saved (point-max))))
- (with-current-buffer tmp-buf
- (error (buffer-string)))))
- (kill-buffer tmp-buf)
- (delete-file tmp-file)))))
address@hidden group
address@hidden lisp
-
-It is highly desirable that you check if the PO file you finished
-translating (or editing) is valid, before committing it. This is done
-by running @code{msgfmt -cv -o /dev/null @var{file}} or by simply
-pressing @kbd{V} in PO mode. The build system automatically verifies
-each PO file when invoked with @code{VALIDATE=yes}, but you won't get a
-warm and fuzzy feeling if a stupid typo you made halts the whole update
-of all translations. Such things happen to everyone, so it is a good
-practice to check before you actually commit.
-
@menu
* Notes Slot:: How to handle translator's notes.
* Credits Slot:: Translator's credits.
@@ -1820,7 +1781,7 @@
readers prefer to send buggestions directly to the translator. Also,
giving credit where credit is due is a natural thing.
-Like the previous slot, you should ``translate'' it as a @key{SPC} if
+Like the previous slot, you should ``translate'' it as a space if
you don't want your name to appear there.
Here is an example of the recommended way to specify credits:
@@ -1837,6 +1798,58 @@
meets the linking criteria for gnu.org. Please follow the FSF HTML
Style Sheet when adding URIs or other information.
address@hidden Wrapping Long Lines
address@hidden Wrapping Long Lines
address@hidden wrapping long lines
address@hidden long lines, wrap
+
+Most of the PO editors do not wrap long lines that inevitably appear in
address@hidden If that happens, long lines make reading subsequent
+diffs harder, and are generally annoying for most people. If this issue
+bothers you, you can ``normalize'' the already finished PO translation
+by executing on the command line @code{msgcat -o @var{file}.po
address@hidden, before installing it in the repository. Either way, the
+build system will treat it is a valid PO file.
+
+For those lucky Emacs users, here is a code snippet that you can put
+in your @file{.emacs}; doing @kbd{M-x po-wrap} while in PO mode will
+wrap all long lines:
+
address@hidden
address@hidden
+(defun po-wrap ()
+ "Filter current po-mode buffer through `msgcat' tool to wrap all lines."
+ (interactive)
+ (if (eq major-mode 'po-mode)
+ (let ((tmp-file (make-temp-file "po-wrap."))
+ (tmp-buf (generate-new-buffer "*temp*")))
+ (unwind-protect
+ (progn
+ (write-region (point-min) (point-max) tmp-file nil 1)
+ (if (zerop
+ (call-process
+ "msgcat" nil tmp-buf t (shell-quote-argument tmp-file)))
+ (let ((saved (point))
+ (inhibit-read-only t))
+ (delete-region (point-min) (point-max))
+ (insert-buffer tmp-buf)
+ (goto-char (min saved (point-max))))
+ (with-current-buffer tmp-buf
+ (error (buffer-string)))))
+ (kill-buffer tmp-buf)
+ (delete-file tmp-file)))))
address@hidden group
address@hidden lisp
+
+It is highly desirable that you check if the PO file you finished
+translating (or editing) is valid, before committing it. This is done
+by running @code{msgfmt -cv -o /dev/null @var{file}} or by simply
+pressing @kbd{V} in PO mode. The build system automatically verifies
+each PO file when invoked with @code{VALIDATE=yes}, but you won't get a
+warm and fuzzy feeling if a stupid typo you made halts the whole update
+of all translations. Such things happen to everyone, so it is a good
+practice to check before you actually commit.
+
@node PO Tips
@section Useful Hints for Editing PO Files
@cindex tips, translators
@@ -1890,20 +1903,6 @@
which normally you would want to preserve verbatim.
@item
-If you translate ``Free Software Foundation, Inc.'' in your native
-language in the copyright notice, then please prepend the English name
-to the @code{<address>}; otherwise it looks awkward in most
-languages. Example:
-
address@hidden
-# type: Content of: <div><address>
-msgid "51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA"
-msgstr ""
-"Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, "
-"Boston, MA 02110-1301, USA"
address@hidden example
-
address@hidden
Do not use HTML entities for non-ASCII letters as in the English
original. They are harder to type and read. So, if there is
@samp{ü} and this is a character from the alphabet of your
@@ -2019,19 +2018,28 @@
be disappointed if the POT changes again in the next GNUN run(s).
@menu
-* Validation:: How to verify the documents.
+* Modifying Templates:: How to avoid errors.
* Comments for Translators:: Passing comments to translators.
-* Modifying Boilerplates::
* Localized URLs:: Specifying URLs of diagrams
to be translated.
* Splitting Long Passages:: How to avoid too long strings
in PO files.
@end menu
address@hidden Validation
address@hidden Validation
address@hidden validation
address@hidden Modifying Templates
address@hidden Modifying Templates
address@hidden boilerplates
address@hidden templates
+
+Any significant structural diversion from
address@hidden in a specific article may result in errors from
+GNUN. Any untested intrusive updates to the server templates (such as
+changing the entire look & feel of the site) will probably break
+GNUN build process. Of course, this does not
+mean that no changes should happen---only that they must be applied in
+a sandbox first, to ensure a smooth transition.
address@hidden validation
The script @command{gnun-validate-html} is useful for webmasters who
want to verify if their (potentially intrusive) changes result in a
valid markup. Before committing your changes, you can check whether
@@ -2047,8 +2055,6 @@
@section Comments for Translators
@cindex comments for translators
address@hidden Emacs Lisp code goes here...
-
If you want a comment to be visible for translators, place it
@emph{inside} the element, for example:
@@ -2073,18 +2079,6 @@
after the beginning of the HTML comment (@code{<!--}), since this will
unnecessarily indent the comment in the POT.
address@hidden Modifying Boilerplates
address@hidden Modifying Boilerplates
address@hidden boilerplates
-
address@hidden:} Any significant structural diversion from
address@hidden in a specific article may result in errors from
-GNUN. Any untested intrusive updates to the server templates (such as
-changing the entire look & feel of the site) will probably break
address@hidden translations under GNUN's control. Of course, this does not
-mean that no changes should happen---only that they must be applied in
-our sandbox first, to ensure a smooth transition.
-
@node Localized URLs
@section Localized URLs
@cindex localized URLs
@@ -2336,9 +2330,10 @@
This script adds comments with differences of current @code{msgid}s
against ``previous'' ones to ``fuzzy'' translations in a PO file. To produce
-the differences @command{wdiff} is used. This may be useful to figure
-out what has changed. In fact, it wraps around a @command{sed} script
-used in GNUN internally.
+the differences @command{wdiff} is used. (@xref{wdiff, wdiff, The word
+difference finder, wdiff, GNU wdiff}, for more information.)
+This may be useful to figure out what has changed. In fact, it wraps
+around a @command{sed} script used in GNUN internally.
@example
gnun-add-fuzzy-diff [OPTION...] [FILE]
@@ -2356,6 +2351,11 @@
Display usage information and exit.
@end table
+The script is invoked automatically when requested through the
address@hidden variable in @file{GNUmakefile}
+(@pxref{FUZZY_DIFF_LINGUAS}) and through the @code{ADD_FUZZY_DIFF}
+variable in @file{GNUmakefile.team} (@pxref{ADD_FUZZY_DIFF}).
+
@node gnun-diff-po
@subsection The @command{gnun-diff-po} Script
@cindex comparing, translations
Index: doc/web-trans.texi
===================================================================
RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/doc/web-trans.texi,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -b -r1.53 -r1.54
--- doc/web-trans.texi 7 Feb 2013 13:06:40 -0000 1.53
+++ doc/web-trans.texi 8 Mar 2013 12:03:07 -0000 1.54
@@ -1227,12 +1227,12 @@
It is very important to keep existing translations up-to-date with the
respective English originals. This task should be higher priority than
-translating new articles. We developped different means to automate
+translating new articles. We developed various means to automate
the process of tracking outdated translations.
@itemize
@item
-GNUN's @code{report} rule can help you to identify precisely which
+GNUN's @code{report} rule can help you identify precisely which
articles need updating; @pxref{report, , , gnun, The GNUnited Nations
Manual}. There is a monthly cron job which sends the output of this
rule to each team as requested by their leaders. If you want the
@@ -1267,6 +1267,12 @@
Translation Managers to setup a job for your team, please write to
@email{web-translators@@gnu.org}.
address@hidden
+If your editors don't hightlight differences against previous
+messages, you may find it useful to track the changes in the messages
+with @command{gnun-add-fuzzy-diff}. For more details,
address@hidden, , , gnun, The GNUnited Nations Manual}.
+
@end itemize
@node Capitalization
@@ -1467,7 +1473,7 @@
We anticipate that some gnu.org translators will find this format odd
or inconvenient, if they never happened to work with PO files
address@hidden www.gnu.org-specific information about editing
address@hidden detailed information about editing
PO files, @pxref{PO Files, , Working with PO Files, gnun,
The GNUnited Nations Manual}.}.
Don't worry, you will soon get accustomed to it. It is the
Index: ChangeLog
===================================================================
RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/ChangeLog,v
retrieving revision 1.360
retrieving revision 1.361
diff -u -b -r1.360 -r1.361
--- ChangeLog 1 Mar 2013 04:13:49 -0000 1.360
+++ ChangeLog 8 Mar 2013 12:03:07 -0000 1.361
@@ -1,3 +1,34 @@
+2013-03-08 Pavel Kharitonov <address@hidden>
+
+ Minor documentation rearrangements and fixes.
+
+ * doc/gnun.texi (Main Variables): Move `FUZZY_DIFF_LINGUAS'
+ description up.
+ (Team's Repository): Improve footnote wording.
+ (GNUmakefile.team Variables): Add `ADD_FUZZY_DIFF' anchor,
+ reword reference to `gnun-add-fuzzy-diff'.
+ (PO Files): Improve the introduction.
+ (New Translation): Split the node, creating the following:
+ (PO Header, GNUN Slots, Wrapping Long Lines): New nodes
+ whose texts come from former `New Translation' (the
+ `GNUN Slots' anchor is removed).
+ (PO Header): Fix header example (s/8-bit/8bit/); fix a typo
+ s/80 lines/80 characters/.
+ (Wrapping Long Lines): Move down, after the description of
+ GNUN slots.
+ (PO Tips): Remove obsolete recommendation on FSF address, it
+ is not in the boilerplate these days.
+ (Modifying Templates, Validation): Merge `Validation' to
+ `Modifying Templates', put the result in place of
+ `Validation'.
+ (Webmasters Tips): Adjust the menu.
+ (Comments for Translators): Remove spurious comment.
+ (gnun-add-fuzzy-diff): Add references to `wdiff',
+ `FUZZY_DIFF_LINGUAS' and `ADD_FUZZY_DIFF'.
+ * doc/web-trans.texi (Updating): Fix mistakes in grammar.
+ Add a reference to `gnun-add-fuzzy-diff'.
+ (PO Files): Improve footnote wording.
+
2013-03-01 Pavel Kharitonov <address@hidden>
* GNUmakefile (generate-translinks): Specify dir="ltr"
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- trans-coord/gnun/server/gnun doc/gnun.texi doc/...,
Pavel Kharitonov <=