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

[Yavor Doganov]

CVSROOT:        /sources/trans-coord
Module name:    trans-coord
Changes by:     Yavor Doganov <yavor>   08/06/12 10:35:11

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

Log message:
        Add indexing commands.
        (Runtime Variables): Typo fix.

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

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/ChangeLog,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- ChangeLog   12 Jun 2008 09:32:08 -0000      1.84
+++ ChangeLog   12 Jun 2008 10:35:11 -0000      1.85
@@ -1,5 +1,8 @@
 2008-06-12  Yavor Doganov  <address@hidden>
 
+       * gnun.texi: Add indexing commands.
+       (Runtime Variables): Typo fix.
+
        * GNUmakefile ($(rootdir)/home.$(1).shtml)
        ($(subst /po/,/,$(1).html)): Revert the embarrassing change from
        2008-05-27 and document the real culrprit.

Index: gnun.texi
===================================================================
RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/gnun.texi,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -b -r1.31 -r1.32
--- gnun.texi   1 Jun 2008 15:43:42 -0000       1.31
+++ gnun.texi   12 Jun 2008 10:35:11 -0000      1.32
@@ -3,8 +3,9 @@
 @setfilename gnun.info
 @settitle GNUnited Nations Manual
 @c FIXME: Would be nice to have it in the format `%:b %:d, %:y', but
address@hidden in English.
address@hidden lastupdate 01.06.2008
address@hidden in English.  This is going to be changed anyway when GNUN is 
released
address@hidden as a GNU package.
address@hidden lastupdate 12.06.2008
 @afourpaper
 @c %**end of header
 
@@ -12,7 +13,7 @@
 @c available in gNewSense.  Thanks.
 
 @c FIXME: Add more xrefs, where appropriate.
address@hidden FIXME: Add indexing commands.
address@hidden FIXME: Improve the indexing commands.
 
 @copying
 
@@ -404,6 +405,8 @@
 
 @node Invoking GNUN
 @section Invoking GNUN
address@hidden invoking
address@hidden triggering, build
 
 The central part of @acronym{GNU}nited Nations is a makefile; actually
 a @file{GNUmakefile} since it heavily relies on features and
@@ -430,6 +433,8 @@
 
 @node Runtime Variables
 @subsection Variables to Control the Build Process
address@hidden variables
address@hidden variable, behavior
 
 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
@@ -439,8 +444,11 @@
 additional features will be implemented in a similar fashion.
 
 @table @samp
address@hidden VCS
address@hidden CVS
 @item VCS=no
 @itemx @dots{}
+
 Do not add any files to the repository.  This is the default.  You may
 as well omit to define @code{VCS} entirely; there is no special code
 that expects assigning the value `no'.
@@ -463,6 +471,9 @@
 additional check and forcefully adds all files.  Use it sparingly, since
 it is very slow and generally less reliable.
 
address@hidden VALIDATE
address@hidden validation
address@hidden sanity checks
 @item VALIDATE=no
 @itemx @dots{}
 Does not perform validation of the HTML articles and PO files.  This
@@ -475,7 +486,9 @@
 recommended to run the build this way, even if it is a bit tedious to
 fix the errors that are reported as a result of enforcing validation.
 
address@hidden NOTFIY=no
address@hidden NOTIFY
address@hidden mail, notifications
address@hidden NOTIFY=no
 @itemx @dots{}
 Do not send email notifications about errors.  This is the default.
 
@@ -486,6 +499,8 @@
 recipients; normally they should be set to the @acronym{GNUN}
 maintainers, webmasters and translators accordingly.
 
address@hidden VERBOSE
address@hidden output, detailed
 @item VERBOSE=yes
 If defined, the value of the variables @code{templates-translated},
 @code{home-translated}, @code{ALL_POTS} and @code{articles-translated}
@@ -493,6 +508,8 @@
 recommended in general since it will show a bug in the computation of
 the basic variables.
 
address@hidden TEAM
address@hidden variable, team
 @item address@hidden
 The translation team which articles need to be checked for
 completeness.  This variable is applicable only for the @code{report}
@@ -550,6 +567,7 @@
 
 @node sync
 @subsubsection The @code{sync} target
address@hidden synchronization, repository
 
 The @code{sync} target has a simple task: synchronize the
 @emph{original English} articles from a canonical repository, like
@@ -589,6 +607,8 @@
 
 @node report
 @subsubsection The @code{report} target
address@hidden reporting
address@hidden status, translations
 
 This target exists solely for convenience to translators, enabling them
 to check which articles are not 100% translated and have to be updated.
@@ -618,6 +638,8 @@
 
 @node Main Variables
 @section Defining Articles to be Built
address@hidden variables
address@hidden gnun.mk
 
 The file @file{gnun.mk} contains variable definitions, based on which
 almost all other important variables are computed.  In other words,
@@ -636,6 +658,9 @@
 not, that is a bug that should be reported and fixed.
 
 @table @samp
address@hidden TEMPLATE_LINGUAS
address@hidden templates, defining
address@hidden defining templates
 @item TEMPLATE_LINGUAS
 Add here your language code @emph{if and only if} you have all the
 server templates translated, and have committed
@@ -645,12 +670,18 @@
 @file{server/address@hidden and
 @file{server/address@hidden
 
address@hidden HOME_LINGUAS
address@hidden homepage, defining
address@hidden defining homepage
 @item HOME_LINGUAS
 Add your language code if you have already committed
 @file{po/address@hidden, that way the homepage for your language
 will be built.  It is not acceptable to have your language code
 defined in this variable, but not in @code{TEMPLATE_LINGUAS}.
 
address@hidden ROOT
address@hidden articles in root directory, defining
address@hidden defining articles in the root dir
 @item ROOT
 Add here articles that are in the server root, like
 @file{keepingup.html} and @file{provide.html}.  Always write only the
@@ -658,10 +689,14 @@
 of @code{ROOT} should be @code{keepingup provide}.  This is true for
 all the variables that expect values in the form of article names.
 
address@hidden ALL_DIRS
address@hidden directories, defining
address@hidden defining directories
 @item ALL_DIRS
 The list of directories containing articles, like @file{philosophy},
 @file{gnu}, @file{licenses}, etc.
 
address@hidden POT generation, articles
 @item gnu
 @itemx philosophy
 @itemx @address@hidden
@@ -673,6 +708,7 @@
 
 @node PO Files
 @section Working with PO Files
address@hidden PO, editing
 
 We anticipate that some gnu.org translators will find this format odd
 or inconvenient, if they never happened to work with PO files before.
@@ -687,6 +723,7 @@
 necessary to make it valid.  Here is a list of widely used PO editors:
 
 @itemize
address@hidden PO editors
 @item 
 PO mode.  We recommend using @acronym{GNU} Emacs in PO mode, because
 Emacs is the program that is suitable for performing any task when it
@@ -726,6 +763,8 @@
 
 @node New Translation
 @subsection Starting a New Translation
address@hidden translation, new
address@hidden 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.
@@ -771,6 +810,7 @@
 conventions, and the rules for gnu.org translations.  For reference,
 here is a list with all fields explained:
 
address@hidden PO headers
 @table @samp
 @item Project-Id-Version
 Add here the filename of the original article, without the
@@ -844,12 +884,16 @@
 There are some special messages that appear in the POT and PO:
 
 @table @samp
address@hidden notes, translators
address@hidden translators' notes
 @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
 translation does not have notes, you @emph{must} translate this as a
 space, that is, @key{SPC}.
 
address@hidden credits, translators
address@hidden translators' credits
 @item *GNUN-SLOT: TRANSLATOR'S CREDITS*
 This is again optional, and should contain the name (and address) of
 the person who made the translation.  ``Translate'' this string as a
@@ -857,6 +901,8 @@
 @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
 @code{msgstr}'s.  If that happens, long lines make reading subsequent
 diffs harder, and are generally annoying for most people.  If this issue
@@ -911,6 +957,8 @@
 
 @node Notes Slot
 @subsubsection The Special Slot for Translator's Notes
address@hidden notes, translators
address@hidden translators' notes
 
 Sometimes it is necessary to complement the translation of an essay
 with translator's notes.  The special message @code{*GNUN-SLOT:
@@ -966,6 +1014,8 @@
 
 @node Credits Slot
 @subsubsection The Special Slot for Translator's Credits
address@hidden credits, translators
address@hidden translators' credits
 
 Most of the translators usually put their name under the translation,
 in the ``footer'' area.  This is entirely acceptable, since some
@@ -991,6 +1041,8 @@
 
 @node Migrating
 @subsection Transforming existing translation in PO format
address@hidden migration, translations
address@hidden conversion of existing translations
 
 Migrating an existing translation to a PO file format is basically
 editing the header as described in the previous section, and
@@ -1039,6 +1091,9 @@
 
 @node GNU News
 @subsection Special Handling For @acronym{GNU} News
address@hidden gnunews
address@hidden whatsnew
address@hidden gnusflashes
 
 The @acronym{GNU} website has infrastructure for supporting ``What's
 New'', also known as address@hidden News''---see
@@ -1067,6 +1122,8 @@
 
 @node PO Tips
 @subsection Useful Hints For Editing PO Files
address@hidden tips, translators
address@hidden recommendations, PO files
 
 This section contains additional explanations, some in the form of
 advices and recommendations; not all of them are strictly related to
@@ -1159,6 +1216,8 @@
 
 @node generic.LANG.html
 @subsection The @address@hidden file
address@hidden team information
address@hidden generic notice, translations
 
 The files @file{server/gnun/address@hidden are special: if
 no such file exists for your language, an empty file will be created
@@ -1187,6 +1246,9 @@
 
 @node PO Files and Team
 @subsection Maintaining Translations in Your Team's Repository
address@hidden project repository
address@hidden repository, translation project
address@hidden team maintenance
 
 @acronym{GNUN} operates on the ``official'' Web repository of the
 Savannah project `www', where normally only the coordinators of
@@ -1207,6 +1269,7 @@
 place to keep their draft translations, until they ripe and are ready
 to be installed officially.
 
address@hidden team workflow
 The following diagram illustrates a typical workflow---it is applicable
 for small, medium and large teams:
 
@@ -1342,6 +1405,8 @@
 
 @node GNUmakefile.team and Cron
 @subsubsection Automatic Synchronization and Status Reports
address@hidden team maintenance, cron
address@hidden cron, team maintenance
 
 It is convenient to invoke such synchronization automatically, for
 example once every day.  If you have enabled commit notifications for
@@ -1372,6 +1437,8 @@
 
 @node Webmaster Tips
 @section Tips and Hints for Webmasters
address@hidden tips, webmasters
address@hidden webmaster tips
 
 This section contains some tips and general recommendations for
 webmasters in no particular order---it is not mandatory to follow them,
@@ -1476,6 +1543,9 @@
 
 @node make-prototype
 @subsection The @command{make-prototype} Script
address@hidden POT generation
address@hidden prototype generation
address@hidden generation, POT, .proto
 
 This is a Guile script which makes the ``prototype'' file,
 @address@hidden, from which the POT is generated.
@@ -1534,6 +1604,7 @@
 
 @node validate-html
 @subsection The @command{validate-html} Script
address@hidden validation, XHTML
 
 This is a Bash script whose purpose is to ``validate'' both the
 original and translated articles to make sure that they conform to the
@@ -1551,6 +1622,7 @@
 
 @node mailfail
 @subsection The @command{mailfail} Script
address@hidden mail, notifications
 
 This is a helper script that runs a command, and mails the output of
 that command in case it exits with a non-zero exit status.
@@ -1637,6 +1709,8 @@
 
 @node Bugs
 @chapter Reporting Bugs
address@hidden bugs, reporting
address@hidden reporting bugs
 
 @acronym{GNU}nited Nations, like any other software, is not bug free.
 There are some known bugs and annoyances, which are listed in the