diff options
authorSergey Poznyakoff <gray@gnu.org>2021-02-07 11:54:33 +0200
committerSergey Poznyakoff <gray@gnu.org>2021-02-07 11:55:06 +0200
commitdf55dc124fc570ba2fa4f7fd54df258ff57a8559 (patch)
parent286694058746baf1f8c7c85cfaf45a8e755bf0cd (diff)
Revise the docs
* doc/wyslij-po.texi: Revise. * doc/Config: Rename to doc/html.init
-rw-r--r--doc/html.init (renamed from doc/Config)4
2 files changed, 39 insertions, 74 deletions
diff --git a/doc/Config b/doc/html.init
index a199aca..1f36c54 100644
--- a/doc/Config
+++ b/doc/html.init
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with Wyslij-po. If not, see <http://www.gnu.org/licenses/>.
+use strict;
my $top_html_dir="/software/wyslij-po";
my $graphics_dir="$top_html_dir/graphics";
@@ -151,8 +152,11 @@ my @gray_buttons = (\&gray_document_title, ' ',
'FastBack', ' ', 'Up', ' ', 'FastForward', ' ',
'Contents', 'Index' );
+set_from_init_file('TOP_BUTTONS', undef);
set_from_init_file('SECTION_BUTTONS', \@gray_buttons);
set_from_init_file('CHAPTER_BUTTONS', \@gray_buttons);
+set_from_init_file('NODE_FOOTER_BUTTONS', \@gray_buttons);
+set_from_init_file('SECTION_FOOTER_BUTTONS', \@gray_buttons);
diff --git a/doc/wyslij-po.texi b/doc/wyslij-po.texi
index 32edb56..4ed44dd 100644
--- a/doc/wyslij-po.texi
+++ b/doc/wyslij-po.texi
@@ -2,7 +2,6 @@
@c %**start of header
@setfilename wyslij-po.info
@settitle Wyslij-po Manual
-@c %**end of header
@setchapternewpage odd
@defcodeindex pr
@@ -32,6 +31,11 @@
* wyslij-po: (wyslij-po). Submit PO files to the Translation Project.
@end direntry
@end ifinfo
+@c %**end of header
+@end iftex
Copyright @copyright{} 2007-2021 Sergey Poznyakoff
@@ -56,49 +60,16 @@ this Manual, like GNU software. Help the software be free.''
@end titlepage
-@end ifnothtml
-@node Top, Intro, (dir), (dir)
-@chapter Wyslij-po
+@node Top
+@top Wyslij-po
This edition of the @cite{Wyslij-po Manual}, last updated @value{UPDATED},
documents Wyslij-po Version @value{VERSION}.
-@end ifinfo
-* Intro:: Introduction to Wyslij-po.
-* Submit:: Submitting Translations.
-* Dry-run:: Debugging, Verbose Output and Dry-run Mode.
-* Config:: Configuration Files.
-* Langtab:: Language Tables.
-* Reporting Bugs:: How to Report a Bug.
+@end ifnottex
-* Build:: How to build the package.
-* Invoke:: Invocation summary.
-* Copying This Manual:: The GNU Free Documentation License.
-* Concept Index:: Index of Concepts.
- --- The Detailed Node Listing ---
-Submitting Translations.
-* Verification::
-* Message::
-* Sending::
-@end detailmenu
-@end menu
-@node Intro, Submit, Top, Top
+@node Intro
@chapter Introduction to Wyslij-po
@cindex wyslij-po
@cindex Internationalization
@@ -106,8 +77,7 @@ Submitting Translations.
@cindex Localization
@cindex l18n
It is a common practice for a program to be documented and to
-produce its diagnostics in English. Whether this practice is good or
-bad is a topic of a separate discussion. However it is, the waste
+produce its diagnostics in English. However, the waste
majority of us would prefer their computer to speak our native
language instead. This goal is already achieved for many free software
programs, and is going to be achieved for still more of them using the
@@ -126,10 +96,10 @@ gettext manual}.
While internationalization is usually taken care of by programmers,
localization is the responsibility of translators. Usually this
process consists of creating a special file, called @dfn{@acronym{PO} file},
-which is basically a table of all the messages a given program ever
-issues, which, for each such message, lists its translation (or
-translations) to a given language (@pxref{PO Files, The Format of PO
-Files, PO Files, gettext, GNU gettext manual}).
+which is basically a table of all the messages the program ever
+issues, which, for each such message, lists its translation to a given
+language (@pxref{PO Files, The Format of PO Files, PO Files, gettext,
+GNU gettext manual}).
@cindex Translation Project
@cindex @acronym{TP}
@@ -141,7 +111,7 @@ the Translation Project that maintainers download @acronym{PO} files for
inclusion into their project while preparing them for the release.
There are several ways to submit a translation. First, it can, of
-course, be submitted manually. Secondly, you can use @kbd{M}
+course, be submitted manually. Secondly, you can use the @kbd{M}
(@code{po-send-mail}) command in GNU Emacs @dfn{po-mode}
(@pxref{PO Files, The Format of PO
Files, PO Files, gettext, GNU gettext manual}).
@@ -162,7 +132,7 @@ pronounced roughly like @samp{vishleey-po}.
GNU Mailutils} --- a powerful collection of libraries and utilities
for handling electronic mail.
-@node Submit, Dry-run, Intro, Top
+@node Submit
@chapter Submitting Translations.
To submit one or several @acronym{PO} files, simply give them as
@@ -228,12 +198,6 @@ registration information (@pxref{Message}).
The following sections describe each step in detail.
-* Verification::
-* Message::
-* Sending::
-@end menu
@node Verification
@section Verification
@cindex @acronym{PO} verification
@@ -250,7 +214,7 @@ traffic and the impact on the @acronym{TP} mail server and robot.
The values of the @acronym{PO} headers @code{PO-Revision-Date} and
@code{POT-Creation-Date} are compared. If @code{POT-Creation-Date} is
-after @code{PO-Revision-Date}, the @acronym{PO} file is obviously
+newer than @code{PO-Revision-Date}, the @acronym{PO} file is obviously
outdated and therefore it is not submitted.
This test is controlled by the following command line options:
@@ -282,7 +246,7 @@ where @code{@value{DOMAINVAR}} is replaced with the project name
obtained from the @code{Project-Id-Version} @acronym{PO} header.
Then, the contents of this page is retrieved, and the following
-extended @dfn{regular expression} is executed over it:
+extended @dfn{regular expression} is applied to it:
The current template for this domain is <a href=".[^"]*/(.[^"]*)">
@@ -392,7 +356,7 @@ $ wyslij-po --cc "tp-keeper@@dom.ain,root@@remote.org"
If you wish to make those additional addresses invisible, use
-@option{--bcc} command line option (or @code{bcc} configuration
+the @option{--bcc} command line option (or @code{bcc} configuration
statement) instead.
@@ -427,17 +391,13 @@ compression level, use:
$ wyslij-po --gzip "/usr/bin/gzip -c --best"
@end example
- Use @code{compress} statement to set the compression command from the
+ Use the @code{compress} statement to set the compression command from the
configuration file (@pxref{Config, compress}).
Notice, that when setting compression command (either from command line
or from configuration file), @emph{you must always include
@option{-c} option in the @command{gzip} command line}.
- Yet another way to supply additional arguments to @command{gzip} is
-by using @env{GZIP} environment variable (@pxref{Environment,
-Environment, Environment, gzip, Gzip Manual}).
@node Sending
@section Sending
@cindex sending messages
@@ -521,7 +481,7 @@ mails directly to the @acronym{TP} mail server:
$ wyslij-po --mailer=smtp://mail.vrijschrift.org @dots{}
@end example
-@node Dry-run, Config, Submit, Top
+@node Dry-run
@chapter Debugging, Verbose Output and Dry-run Mode.
Usually @command{wyslij-po} operates silently. It issues a
@@ -615,7 +575,7 @@ X-Mailer: wyslij-po @value{VERSION}
NOT submitting
@end example
-@node Config, Langtab, Dry-run, Top
+@node Config
@chapter Configuration Files.
@cindex configuration file
If you have a set of commonly used @command{wyslij-po} options, it
@@ -635,7 +595,7 @@ include directory, if the @code{include} statement is used
Manual}). Per-user configuration is kept in file @file{~/.wyslij-po}.
To set default mailer (similar to @option{--mailer} option,
-@pxref{Sending, mailer}), use @code{mailer} statement, @xref{Mailer Statement,
+@pxref{Sending, mailer}), use the @code{mailer} statement, @xref{Mailer Statement,
Mailer Statement,, mailutils, GNU Mailutils Manual}.
@deffn {Configuration} compress @var{command}
@@ -736,7 +696,7 @@ regexps, Extended regular expressions, Extended regular expressions,
sed, GNU sed}) with exactly one parenthesized group.
@end deffn
-@node Langtab, Reporting Bugs, Config, Top
+@node Langtab
@chapter Language Tables.
@cindex language code
To recreate the canonical @acronym{PO} name (@pxref{canonical-name})
@@ -758,9 +718,9 @@ as follows:
comments and are ignored as well.
@item Unless ignored by the above reasons, any line is split at the
whitespace. The first word in line gives the language code (usually
-corresponding to @acronym{ISO} 639). The rest of words are re-composed
-into a string, using a single horizontal space as a delimiter. This
-string is then used as the full language name (the look-up key).
+corresponding to @acronym{ISO} 639). The rest of words is taken as
+a literal string that gives the full language name (the look-up key)
+for that code.
@end itemize
For example, the following entry:
@@ -799,6 +759,7 @@ files. Therefore, if you get the similar error:
wyslij-po: Unknown language: Bulgarian
@end example
you should make sure the right tables are read, by running
@command{wyslij-po} with the @option{-vv} (or, better yet,
@option{--dry-run --verbose}) command line option. In normal case, it
@@ -820,7 +781,7 @@ using the data from @uref{@value{TPTEAMS}}, so most
of the time you won't have to edit it (unless, of course, new language
teams are added to the @acronym{TP})
-@node Reporting Bugs, Build, Langtab, Top
+@node Reporting Bugs
@chapter How to Report a Bug
Email bug reports to @email{bug-wyslij-po@@gnu.org.ua}.
@@ -835,7 +796,7 @@ needed is:
@item Conditions under which the bug appears.
@end itemize
-@node Build, Invoke, Reporting Bugs, Top
+@node Build
@appendix How to Build the Package
@cindex building @command{wyslij-po}
@cindex @command{wyslij-po}, building
@@ -844,7 +805,7 @@ needed is:
@enumerate 1
-Make sure you have installed the GNU Mailutils, version 2.0 or later.
+Make sure you have installed the GNU Mailutils, version 3.4 or later.
@@ -859,7 +820,7 @@ Run @code{make}
Run @code{make install}
@end enumerate
-@node Invoke, Copying This Manual, Build, Top
+@node Invoke
@appendix Invocation Summary.
@cindex Command line options
@cindex Options, command line
@@ -946,10 +907,10 @@ Print program version
@end table
-@node Copying This Manual, Concept Index, Invoke, Top
+@node Copying This Manual
@include fdl.texi
-@node Concept Index, , Copying This Manual, Top
+@node Concept Index
@comment node-name, next, previous, up
@unnumbered Concept Index

Return to:

Send suggestions and report system problems to the System administrator.