[Top][All Lists]

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

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

From: Yavor Doganov
Subject: trans-coord/gnun/server/gnun ChangeLog gnun.texi
Date: Fri, 14 Mar 2008 15:20:18 +0000

CVSROOT:        /sources/trans-coord
Module name:    trans-coord
Changes by:     Yavor Doganov <yavor>   08/03/14 15:20:18

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

Log message:
        (Webmaster Tips, mailfail, validate-html-notify): New
        (PO Files and Team): Do not use @var in the diagram example; TeX
        doesn't align the table properly.


Index: ChangeLog
RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/ChangeLog,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -b -r1.37 -r1.38
--- ChangeLog   14 Mar 2008 07:05:24 -0000      1.37
+++ ChangeLog   14 Mar 2008 15:20:17 -0000      1.38
@@ -1,3 +1,10 @@
+2008-03-14  Yavor Doganov  <address@hidden>
+       * gnun.texi (Webmaster Tips, mailfail, validate-html-notify): New
+       nodes.
+       (PO Files and Team): Do not use @var in the diagram example; TeX
+       doesn't align the table properly.
 2008-03-14  Kaloian Doganov  <address@hidden>
        * GNUmakefile (generate-html): Use a little more conscious and

Index: gnun.texi
RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/gnun.texi,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -b -r1.15 -r1.16
--- gnun.texi   14 Mar 2008 06:18:29 -0000      1.15
+++ gnun.texi   14 Mar 2008 15:20:17 -0000      1.16
@@ -394,6 +394,8 @@
 * Invoking GNUN::       How to trigger a (re)build.
 * Main Variables::      Specifying what to build.
 * PO Files::            The gentle art of editing PO files.
+* Webmaster Tips::      The webmaster's guide to GNUnited Nations'
+                          universe.
 @end menu
 @node Invoking GNUN
@@ -1086,7 +1088,7 @@
 +----------+                   +-------------------+
-| ``www''  |                   |   address@hidden''    |
+| ``www''  |                   |   ``www-LANG''    |
 |   Web    |------>---->-------|Sources repository |
 |repository|  automatic merge  +-------------------+
 +----------+                         |    |     |
@@ -1244,6 +1246,49 @@
 `\' as a line continuation character---the example shown is made that
 way for better readability.
address@hidden Webmaster Tips
address@hidden Tips and Hints for Webmasters
+This section contains some tips and general recommendations for
+webmasters in no particular order---it is not mandatory to follow them,
+but doing so will make translators' lives substantially easier.
+First and foremost, respect translators' work---it is ungrateful and
+hard, undoubtedly much harder than translation of programs.  It is
+important to have as many and as better as possible translations, and
+you don't have to make titanic efforts to help.
+If you plan to edit a certain page extensively, please do so within the
+period between two adjacent @acronym{GNUN} builds---i.e. within a day.
+That way, the POT will be regenerated only once, and translators who are
+quick to update it immediately won't be disappointed if it changes again
+in the next run.
+Use @emph{only} US-ASCII characters and HTML entities for the others.
+This is required because the English text in the articles serves as a
+replacement of the translation when the latter is not complete.  So if
+you use, say, the character @'e (e-accute) directly in an English
+page---which is UTF-8 as declared in @file{server/header.html}, it will
+appear broken on those translated pages who use a different encoding.
+This specific advice is pretty much mandatory---the build fails if the
+original article contains such characters---but we are ready to fix any
+errors a webmaster makes.
+The script @command{validate-html} is useful for webmasters who want to
+verify if their (potentially intrusive) changes result in a valid
+markup.  It is recommended to make a symlink somewhere in your
address@hidden (like @file{~/bin})---that way you will automaically use the
+latest version, provided that you regularly update your working copy.
+Before committing your changes, you can check if it is valid by running
+validate-html philosophy/not-ipr.html
address@hidden example
address@hidden, for more information.
address@hidden Emacs Lisp code goes here...
 @node Internals
 @chapter Unexciting Information for @acronym{GNUN}'s Operation
@@ -1267,6 +1312,8 @@
 * make-prototype::
 * validate-html::
+* mailfail::
+* validate-html-notify::
 @end menu
 @node make-prototype
@@ -1344,10 +1391,91 @@
 automatic variable is not expanded properly due to a bug in the
address@hidden mailfail
address@hidden The @command{mailfail} Script
+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.
address@hidden depends on @acronym{GNU} Mailutils, or a compatible
+implementation, such as BSD's mailx.
+mailfail [--dry-run] RCPT SUBJECT CMD [ARG ...]
address@hidden example
+The @command{mailfail} script accepts the following options:
address@hidden @option
address@hidden --dry-run
+Does not send the email message.
address@hidden RCPT
+The recepient of the message in a valid format, like}.
address@hidden SUBJECT
+The subject of the message; if it is longer than a word you should
+guard it with quotes.
address@hidden CMD
+The command you want to run and send a mail in case it fails.
address@hidden address@hidden
+The arguments of @code{CMD}, if any.
address@hidden table
+Here is a typical example, similar to the way it is used in
+mailfail "Bad PO" msgfmt -cv -o /dev/null bg.po
address@hidden example
+This will check the validity of @file{bg.po} with the @command{msgfmt}
+program and in case there are errors, a message will be sent to the
+specified address with `Bad PO' as subject and the error output from
address@hidden as body.
address@hidden inherits the exit status of the command being run.
+If an argument is missing, the usage information is printed to the
+standard output and the exit code is 1.
address@hidden validate-html-notify
address@hidden The @command{validate-html-notify} Script
+This script is a wrapper around @command{validate-html}
+(@pxref{validate-html}); it is necessary because it is hard to capture
+the output of the program from a program that itself captures the output
+of another program that it runs.
+validate-html-notify [--dry-run] RCPT FILE
address@hidden example
address@hidden @option
address@hidden --dry-run
+Does not actually send the message, just like @command{mailfail}.
address@hidden RCPT
+The recepient of the message.
address@hidden FILE
+The HTML file that has to be validated for compliance with the
address@hidden standard.
address@hidden table
+The subject of the message is hardcoded in the script, since this
+wrapper has a specific task and cannot be used to invoke an arbitrary
+command---use @command{mailfail} for that.  @xref{mailfail}.
 @node Rules
 @section How The Recipes Work
-Read the source for now.
+Read the source code, then please tell us :-)
 @node Copying This Manual
 @appendix GNU Free Documentation License

reply via email to

[Prev in Thread] Current Thread [Next in Thread]