trans-coord/gnun/server/gnun ChangeLog gnun.texi

[Yavor Doganov]

CVSROOT:        /cvsroot/trans-coord
Module name:    trans-coord
Changes by:     Yavor Doganov <yavor>   08/06/01 15:43:42

Modified files:
        gnun/server/gnun: ChangeLog gnun.texi 

Log message:
        (Usage, Invoking GNUN, Runtime Variables, report)
        (New Translation, GNUmakefile.team Variables): Use @code instead
        of @command when there are arguments and/or options.
        (GNU News): New node.
        (PO Tips): Add two more items about usage of HTML entities in
        translations and wrapping `msgstr'.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/trans-coord/gnun/server/gnun/ChangeLog?cvsroot=trans-coord&r1=1.77&r2=1.78
http://cvs.savannah.gnu.org/viewcvs/trans-coord/gnun/server/gnun/gnun.texi?cvsroot=trans-coord&r1=1.30&r2=1.31

Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/trans-coord/trans-coord/gnun/server/gnun/ChangeLog,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -b -r1.77 -r1.78
--- ChangeLog   1 Jun 2008 11:30:45 -0000       1.77
+++ ChangeLog   1 Jun 2008 15:43:42 -0000       1.78
@@ -1,5 +1,12 @@
 2008-06-01  Yavor Doganov  <address@hidden>
 
+       * gnun.texi (Usage, Invoking GNUN, Runtime Variables, report)
+       (New Translation, GNUmakefile.team Variables): Use @code instead
+       of @command when there are arguments and/or options.
+       (GNU News): New node.
+       (PO Tips): Add two more items about usage of HTML entities in
+       translations and wrapping `msgstr'.
+
        * GNUmakefile ($(template-dir)/po/whatsnew.translinks): New target
        to avoid `No rule to make ../../server/po/whatsnew.bg.html' error
        when run in a fresh export.

Index: gnun.texi
===================================================================
RCS file: /cvsroot/trans-coord/trans-coord/gnun/server/gnun/gnun.texi,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -b -r1.30 -r1.31
--- gnun.texi   22 Mar 2008 08:46:05 -0000      1.30
+++ gnun.texi   1 Jun 2008 15:43:42 -0000       1.31
@@ -4,11 +4,11 @@
 @settitle GNUnited Nations Manual
 @c FIXME: Would be nice to have it in the format `%:b %:d, %:y', but
 @c in English.
address@hidden lastupdate 22.03.2008
address@hidden lastupdate 01.06.2008
 @afourpaper
 @c %**end of header
 
address@hidden Please do not use features of Texinfo >> 4.8, which is the 
version
address@hidden Please do not use features of Texinfo >> 4.11, which is the 
version
 @c available in gNewSense.  Thanks.
 
 @c FIXME: Add more xrefs, where appropriate.
@@ -381,11 +381,11 @@
 article-independent but team-specific information.  They are designed to
 reside in the @file{server/gnun} directory, but this may change.  In all
 examples in this manual, ``invoking'' means executing on the command
-line @command{make -C server/gnun address@hidden
+line @code{make -C server/gnun address@hidden
 address@hidden@var{value} @dots{}]} while the working directory is the
 root in the `www' web repository.  For the purpose of brevity, we will
 refer to the above command as simply @command{make}, which is equivalent
-to @command{cd server/gnun ; make}.  It is desirable never to invoke
+to @code{cd server/gnun ; make}.  It is desirable never to invoke
 @command{make} with the @option{-k} (@option{--keep-going}) option,
 because an eventual error in only one make recipe might create a mess in
 many articles, both original and translated.  Do this with caution, and
@@ -418,10 +418,10 @@
 
 If you don't specify a target, @command{make} by default builds the
 target @code{all}, which in this case is to rebuild all translations
-that are not up-to-date.  However, there are special targets that do
-not depend on the standard @code{all} target, which can be built by
address@hidden @var{target}}.  Some of the variables in the next
-section apply to them, and some do not.
+that are not up-to-date.  However, there are special targets that do not
+depend on the standard @code{all} target, which can be built by
address@hidden @var{target}}.  Some of the variables in the next section
+apply to them, and some do not.
 
 @menu
 * Runtime Variables::   Variables to control the build process.
@@ -431,11 +431,11 @@
 @node Runtime Variables
 @subsection Variables to Control the Build Process
 
-The build process has several modes of operation, and they all relate
-to the handling of files that are to be added to the repository or
+The build process has several modes of operation, and they all relate to
+the handling of files that are to be added to the repository or
 performing certain sanity checks at build time.  The variables are
 specified on the command line, after @command{make}, in the form
address@hidden, e.g. @command{make VCS=yes}.  In the future,
address@hidden, e.g. @code{make VCS=yes}.  In the future,
 additional features will be implemented in a similar fashion.
 
 @table @samp
@@ -458,10 +458,10 @@
 @item VCS=always
 Because @acronym{GNU} Make considers the targets up-to-date after a
 successful build, if it was performed with no VCS interaction, the
-important newly created files will not be added (and committed when
-you do @command{cvs commit}) in the repository.  Assigning this value
-enables additional check and forcefully adds all files.  Use it
-sparingly, since it is very slow and generally less reliable.
+important newly created files will not be added (and committed when you
+do @code{cvs commit}) in the repository.  Assigning this value enables
+additional check and forcefully adds all files.  Use it sparingly, since
+it is very slow and generally less reliable.
 
 @item VALIDATE=no
 @itemx @dots{}
@@ -590,11 +590,11 @@
 @node report
 @subsubsection The @code{report} target
 
-This target exists solely for convenience to translators, enabling
-them to check which articles are not 100% translated and have to be
-updated.  The way to check this is by running @command{make report
address@hidden, where @var{lang} is the language code, as usual.
-Thus, to check all French translations, one would run
+This target exists solely for convenience to translators, enabling them
+to check which articles are not 100% translated and have to be updated.
+The way to check this is by running @code{make report address@hidden,
+where @var{lang} is the language code, as usual.  Thus, to check all
+French translations, one would run
 
 @example
 make report TEAM=fr
@@ -716,6 +716,7 @@
 * New Translation::     How to start a new translation.
 * Migrating::           How to migrate an existing translation to a PO
                           format under @acronym{GNUN}'s control.
+* GNU News::            How to handle ``whatsnew'' (a.k.a. ``gnunews'').
 * PO Tips::             Tips and hints for translators.
 * generic.LANG.html::   Specifying information that will propagate in
                           every translation in a certain language.
@@ -726,17 +727,17 @@
 @node New Translation
 @subsection Starting a New Translation
 
-To start a new translation, the easiest way is to copy the existing
-POT as @address@hidden, where @var{lang} is your language
-code.  For example, to prepare for a new translation of the essay
+To start a new translation, the easiest way is to copy the existing POT
+as @address@hidden, where @var{lang} is your language code.
+For example, to prepare for a new translation of the essay
 @uref{http://www.gnu.org/philosophy/free-sw.html}, you can simply do
address@hidden philosophy/po ; cp free-sw.pot address@hidden and
-then edit the latter.  If @file{free-sw.pot} does not exist it is
-because either the article is not yet ``templated'' (i.e. migrated to
-the new style), or the @acronym{GNUN} maintainers have not yet added
-it to the value of the appropriate variable in
address@hidden/gnun/gnun.mk}.  In that case, just ask them to do the
-necessary in order the POT to be generated.
address@hidden philosophy/po ; cp free-sw.pot address@hidden and then
+edit the latter.  If @file{free-sw.pot} does not exist it is because
+either the article is not yet ``templated'' (i.e. migrated to the new
+style), or the @acronym{GNUN} maintainers have not yet added it to the
+value of the appropriate variable in @file{server/gnun/gnun.mk}.  In
+that case, just ask them to do the necessary in order the POT to be
+generated.
 
 You could also use the @command{msginit} utility that would populate
 the PO file header with the right information, provided your
@@ -856,14 +857,13 @@
 @xref{Credits Slot}.
 @end table
 
-Most of the PO editors do not wrap long lines that inevitably appear
-in @code{msgstr}'s.  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 @command{cat
address@hidden | msgcat - -o @var{file}.po}, before installing it in
-the repository.  Either way, the build system will treat it is a valid
-PO file.
+Most of the PO editors do not wrap long lines that inevitably appear in
address@hidden's.  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{cat @var{file}.po | msgcat - -o
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
@@ -897,12 +897,12 @@
 
 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 @command{msgfmt -cv -o /dev/null @var{file}} or by simply
+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.
+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.
@@ -1037,6 +1037,34 @@
 translation, address@hidden made some changes in 2007, and the original
 translator returned in 2008 and continued maintaining it.
 
address@hidden GNU News
address@hidden Special Handling For @acronym{GNU} News
+
+The @acronym{GNU} website has infrastructure for supporting ``What's
+New'', also known as address@hidden News''---see
address@hidden://www.gnu.org/@/server/@/standards/@/README.webmastering.html#polnews}
+for details.  Entries are added in a special plain text file,
address@hidden/whatsnew.txt} and are used to build
address@hidden/whatsnew.include} and @file{gnusflashes.include}.  The
+former is used by @file{server/whatsnew.html}, while the latter is
+included in the homepage.
+
address@hidden has rules for building @file{whatsnew.pot}, which
+contains all necessary strings for
address@hidden/address@hidden,
address@hidden/address@hidden and
address@hidden@var{lang}.include}.  There is nothing unusual in this
+POT file, so it should be translated like any other.  When you commit
address@hidden@var{lang}.po}, it will be used to generate all three
+localized files.  In addition, if there is a homepage for this language,
+it will be rebuilt when @address@hidden is
+generated for the first time in order the translated homepage to include
+it instead of @file{gnusflashes.include}.
+
+Note that localized @acronym{RSS} feeds are not supported on purpose, as
+it would be annoying for subscribers if new items appear in English and
+then once again translated.
+
 @node PO Tips
 @subsection Useful Hints For Editing PO Files
 
@@ -1112,6 +1140,21 @@
 "Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, "
 "Boston, MA 02110-1301, USA"
 @end example
+
address@hidden
+There is absolutely no reason to use HTML entities in translations as a
+replacement for common non-ASCII characters.  They are harder to write
+and serve no purpose.
+
address@hidden
+Wrapping of @code{msgstr} using @kbd{M-q} in Emacs (or other means) is
+considered harmful.  It is best to leave @acronym{GNUN} (or more
+precisely, Po4a) to do the wrapping---that way all generated HTML
+translations will have predictable results.  This will help tremendously
+for the conversion to other formats, like Texinfo.  Also, note that not
+all elements are wrapped by default, so deliberately wrapping the text
+inside the @code{msgstr} could lead to an invalid page or a page that is
+valid, but is rendered incorrectly by the web browser.
 @end itemize
 
 @node generic.LANG.html
@@ -1284,9 +1327,8 @@
 statistics) of those that need to be updated.
 @end table
 
address@hidden VCS=yes} is the recommended command to be run
-periodically.  To check the status of the translations, run
address@hidden report}.
address@hidden VCS=yes} is the recommended command to be run periodically.
+To check the status of the translations, run @code{make report}.
 
 Feel free to replace all strings with equivalents in your native
 language and of course---do not hesitate to extend this file and modify