[Po4a-commits] r2396 - in /branches/0.40.x/lib/Locale/Po4a: Po.pm Pod.pm Sgml.pm TeX.pm Text.pm TransTractor.pm Xhtml.pm Xml.pm
taffit-guest at users.alioth.debian.org
taffit-guest at users.alioth.debian.org
Sun Nov 28 23:16:54 UTC 2010
Author: taffit-guest
Date: Sun Nov 28 23:16:53 2010
New Revision: 2396
URL: http://svn.debian.org/wsvn/po4a/?sc=1&rev=2396
Log:
manual page conventions for section 3 manual
Modified:
branches/0.40.x/lib/Locale/Po4a/Po.pm
branches/0.40.x/lib/Locale/Po4a/Pod.pm
branches/0.40.x/lib/Locale/Po4a/Sgml.pm
branches/0.40.x/lib/Locale/Po4a/TeX.pm
branches/0.40.x/lib/Locale/Po4a/Text.pm
branches/0.40.x/lib/Locale/Po4a/TransTractor.pm
branches/0.40.x/lib/Locale/Po4a/Xhtml.pm
branches/0.40.x/lib/Locale/Po4a/Xml.pm
Modified: branches/0.40.x/lib/Locale/Po4a/Po.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/Po.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/Po.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/Po.pm Sun Nov 28 23:16:53 2010
@@ -51,10 +51,10 @@
=over 4
-=item porefs
-
-This specifies the reference format. It can be one of 'none' to not produce
-any reference, 'noline' to not specify the line number, and 'full' to
+=item B<porefs>
+
+This specifies the reference format. It can be one of B<none> to not produce
+any reference, B<noline> to not specify the line number, and B<full> to
include complete references.
=back
@@ -961,13 +961,13 @@
=over
-=item wrap
+=item B<wrap>
boolean indicating whether we can consider that whitespaces in string are
not important. If yes, the function canonizes the string before looking for
a translation, and wraps the result.
-=item wrapcol
+=item B<wrapcol>
the column at which we should wrap (default: 76).
@@ -1088,41 +1088,41 @@
=over 4
-=item msgid
+=item B<msgid>
the string in original language.
-=item msgstr
+=item B<msgstr>
the translation.
-=item reference
+=item B<reference>
an indication of where this string was found. Example: file.c:46 (meaning
in 'file.c' at line 46). It can be a space-separated list in case of
multiple occurrences.
-=item comment
+=item B<comment>
a comment added here manually (by the translators). The format here is free.
-=item automatic
+=item B<automatic>
a comment which was automatically added by the string extraction
-program. See the I<--add-comments> option of the B<xgettext> program for
+program. See the B<--add-comments> option of the B<xgettext> program for
more information.
-=item flags
+=item B<flags>
space-separated list of all defined flags for this entry.
-Valid flags are: c-text, python-text, lisp-text, elisp-text, librep-text,
-smalltalk-text, java-text, awk-text, object-pascal-text, ycp-text,
-tcl-text, wrap, no-wrap and fuzzy.
+Valid flags are: B<c-text>, B<python-text>, B<lisp-text>, B<elisp-text>, B<librep-text>,
+B<smalltalk-text>, B<java-text>, B<awk-text>, B<object-pascal-text>, B<ycp-text>,
+B<tcl-text>, B<wrap>, B<no-wrap> and B<fuzzy>.
See the gettext documentation for their meaning.
-=item type
+=item B<type>
this is mostly an internal argument: it is used while gettextizing
documents. The idea here is to parse both the original and the translation
@@ -1136,14 +1136,14 @@
This information is written as automatic comment in the PO file since this
gives to translators some context about the strings to translate.
-=item wrap
+=item B<wrap>
boolean indicating whether whitespaces can be mangled in cosmetic
reformattings. If true, the string is canonized before use.
-This information is written to the PO file using the 'wrap' or 'no-wrap' flag.
-
-=item wrapcol
+This information is written to the PO file using the B<wrap> or B<no-wrap> flag.
+
+=item B<wrapcol>
the column at which we should wrap (default: 76).
Modified: branches/0.40.x/lib/Locale/Po4a/Pod.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/Pod.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/Pod.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/Pod.pm Sun Nov 28 23:16:53 2010
@@ -212,7 +212,7 @@
with /usr/lib/perl5/Tk/MainWindow.pod (and some other
pages, see below) which contains:
- CE<lt>" #n"E<gt>
+ C<" #n">
Lack of luck, in the po4a version, this was splited on the space by the
wrapping. As result, in the original version, the man contain
@@ -223,7 +223,7 @@
"" #n""
-which is logic since C<foobar> is rewritten "foobar"
+which is logic since CE<lt>foobarE<gt> is rewritten "foobar"
Complete list of pages having this problem on my box (from 564 pages ; note
that it depends on the chosen wrapping column):
@@ -251,33 +251,33 @@
=over 4
-=item alt
+=item B<alt>
If set to a true value, selects an alternate output format that, among other
-things, uses a different heading style and marks C<=item> entries with a
+things, uses a different heading style and marks B<=item> entries with a
colon in the left margin. Defaults to false.
-=item code
+=item B<code>
If set to a true value, the non-POD parts of the input file will be included
in the output. Useful for viewing code documented with POD blocks with the
POD rendered and the code left intact.
-=item indent
+=item B<indent>
The number of spaces to indent regular text, and the default indentation for
-C<=over> blocks. Defaults to 4.
-
-=item loose
-
-If set to a true value, a blank line is printed after a C<=head1> heading.
-If set to false (the default), no blank line is printed after C<=head1>,
-although one is still printed after C<=head2>. This is the default because
+B<=over> blocks. Defaults to 4.
+
+=item B<loose>
+
+If set to a true value, a blank line is printed after a B<=head1> heading.
+If set to false (the default), no blank line is printed after B<=head1>,
+although one is still printed after B<=head2>. This is the default because
it's the expected formatting for manual pages; if you're formatting
arbitrary text documents, setting this to true may result in more pleasing
output.
-=item quotes
+=item B<quotes>
Sets the quote marks used to surround CE<lt>> text. If the value is a
single character, it is used as both the left and right quote; if it is two
@@ -285,17 +285,17 @@
the right quoted; and if it is four characters, the first two are used as
the left quote and the second two as the right quote.
-This may also be set to the special value C<none>, in which case no quote
+This may also be set to the special value B<none>, in which case no quote
marks are added around CE<lt>> text.
-=item sentence
+=item B<sentence>
If set to a true value, Locale::Po4a::Pod will assume that each sentence
ends in two spaces, and will try to preserve that spacing. If set to
false, all consecutive whitespace in non-verbatim paragraphs is compressed
into a single space. Defaults to true.
-=item width
+=item B<width>
The column at which to wrap text on the right-hand side. Defaults to 76.
Modified: branches/0.40.x/lib/Locale/Po4a/Sgml.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/Sgml.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/Sgml.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/Sgml.pm Sun Nov 28 23:16:53 2010
@@ -52,46 +52,46 @@
=over 4
-=item debug
+=item B<debug>
Space separated list of keywords indicating which part you want to debug. Possible values are: tag, generic, entities and refs.
-=item verbose
+=item B<verbose>
Give more information about what's going on.
-=item translate
+=item B<translate>
Space separated list of extra tags (beside the DTD provided ones) whose
content should form an extra msgid.
-=item section
+=item B<section>
Space separated list of extra tags (beside the DTD provided ones)
-containing other tags, some of them being of category 'translate'.
-
-=item indent
+containing other tags, some of them being of category B<translate>.
+
+=item B<indent>
Space separated list of tags which increase the indentation level.
-=item verbatim
+=item B<verbatim>
The layout within those tags should not be changed. The paragraph won't get
wrapped, and no extra indentation space or new line will be added for
cosmetic purpose.
-=item empty
+=item B<empty>
Tags not needing to be closed.
-=item ignore
+=item B<ignore>
Tags ignored and considered as plain char data by po4a. That is to say that
they can be part of an msgid. For example, E<lt>bE<gt> is a good candidate
for this category since putting it in the translate section would create
msgids not being whole sentences, which is bad.
-=item attributes
+=item B<attributes>
A space separated list of attributes that need to be translated. You can
specify the attributes by their name (for example, "lang"), but you can also
@@ -103,25 +103,25 @@
like E<lt>aaa|bbbbE<gt>lang to only translate lang attributes that are in
an E<lt>aaaE<gt> or a E<lt>bbbE<gt> tag.
-=item qualify
+=item B<qualify>
A space separated list of attributes for which the translation must be
qualified by the attribute name. Note that this setting automatically adds the
given attribute into the 'attributes' list too.
-=item force
+=item B<force>
Proceed even if the DTD is unknown or if nsgmls finds errors in the input
file.
-=item include-all
+=item B<include-all>
By default, msgids containing only one entity (like '&version;') are skipped
for the translator comfort. Activating this option prevents this
optimisation. It can be useful if the document contains a construction like
"<title>Á</title>", even if I doubt such things to ever happen...
-=item ignore-inclusion
+=item B<ignore-inclusion>
Space separated list of entities that won't be inlined.
Use this option with caution: it may cause nsgmls (used internally) to add
@@ -138,7 +138,7 @@
=item *
-the error output of nsgmls is redirected to /dev/null, which is clearly
+The error output of nsgmls is redirected to /dev/null, which is clearly
bad. I don't know how to avoid that.
The problem is that I have to "protect" the conditional inclusions (ie, the
Modified: branches/0.40.x/lib/Locale/Po4a/TeX.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/TeX.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/TeX.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/TeX.pm Sun Nov 28 23:16:53 2010
@@ -125,12 +125,12 @@
our %separated_command = ();
our %separated_environment = ();
-=item debug
+=item B<debug>
Activate debugging for some internal mechanisms of this module.
Use the source to see which parts can be debugged.
-=item no_wrap
+=item B<no_wrap>
Coma-separated list of environments which should not be re-wrapped.
@@ -140,19 +140,19 @@
If this environment was not already registered, po4a will consider that
this environment does not take any parameters.
-=item exclude_include
+=item B<exclude_include>
Colon-separated list of files that should not be included by \input and
\include.
-=item definitions
+=item B<definitions>
The name of a file containing definitions for po4a, as defined in the
B<INLINE CUSTOMIZATION> section.
You can use this option if it is not possible to put the definitions in
the document being translated.
-=item verbatim
+=item B<verbatim>
Coma-separated list of environments which should be taken as verbatim.
@@ -166,18 +166,18 @@
=head1 INLINE CUSTOMIZATION
-The TeX module can be customized with lines starting by "% po4a:".
+The TeX module can be customized with lines starting by B<% po4a:>.
These lines are interpreted as commands to the parser.
The following commands are recognized:
=over 4
-=item % po4a: command I<command1> alias I<command2>
+=item B<% po4a: command> I<command1> B<alias> I<command2>
Indicates that the arguments of the I<command1> command should be
treated as the arguments of the I<command2> command.
-=item % po4a: command I<command1> I<parameters>
+=item B<% po4a: command> I<command1> I<parameters>
This permit to describe in detail the parameters of the I<command1>
command.
@@ -188,14 +188,14 @@
=over 4
-=item an asterisk (*)
+=item an asterisk (B<*>)
po4a will extract this command from paragraphs (if it is located at
the beginning or the end of a paragraph).
The translators will then have to translate the parameters that are marked
as translatable.
-=item a plus (+)
+=item a plus (B<+>)
As for an asterisk, the command will be extracted if it appear at an
extremity of a block, but the parameters won't be translated separately.
@@ -207,7 +207,7 @@
Note: In this case you don't have to specify which parameters are
translatable, but po4a must know the type and number of parameters.
-=item a minus (-)
+=item a minus (B<->)
In this case, the command won't be extracted from any block.
But if it appear alone on a bloc, then only the parameters marked as
@@ -237,7 +237,7 @@
translated is only used if a paragraph is only composed of this href
command.
-=item % po4a: environment I<env> I<parameters>
+=item B<% po4a: environment> I<env> I<parameters>
This permits to define the parameters accepted by the I<env> environment.
This information is latter used to check the number of arguments of the
@@ -253,7 +253,7 @@
As for the commands, I<env> can be preceded by a plus (+) to indicate
that the \begin command must be translated with all its arguments.
-=item % po4a: separator I<env> "I<regex>"
+=item B<% po4a: separator> I<env> B<">I<regex>B<">
Indicates that an environment should be split according to the given
regular expression.
@@ -271,7 +271,7 @@
This can be used to split on "\\\\" in the first mandatory argument of the
title command. In this case, the environment is title{#1}.
-=item % po4a: verbatim environment I<env>
+=item B<% po4a: verbatim environment> I<env>
Indicate that I<env> is a verbatim environment.
Comments and commands will be ignored in this environment.
@@ -310,7 +310,7 @@
=over 4
-=item pre_trans
+=item B<pre_trans>
=cut
@@ -338,7 +338,7 @@
return $str;
}
-=item post_trans
+=item B<post_trans>
=cut
@@ -369,7 +369,7 @@
# comment with the first translated string of the paragraph.
my @comments = ();
-=item translate
+=item B<translate>
Wrapper around Transtractor's translate, with pre- and post-processing
filters.
@@ -428,7 +428,7 @@
### COMMANDS SEPARATION ###
###########################
-=item get_leading_command($buffer)
+=item B<get_leading_command>($buffer)
This function returns:
@@ -539,9 +539,9 @@
return ($command,$variant,\@args,$buffer);
}
-=item get_trailing_command($buffer)
-
-The same as get_leading_command, but for commands at the end of a buffer.
+=item B<get_trailing_command>($buffer)
+
+The same as B<get_leading_command>, but for commands at the end of a buffer.
=cut
@@ -623,7 +623,7 @@
return ($command,$variant,\@args,$buffer);
}
-=item translate_buffer
+=item B<translate_buffer>
Recursively translate a buffer by separating leading and trailing
commands (those which should be translated separately) from the
@@ -889,7 +889,7 @@
#### EXTERNAL CUSTOMIZATION ####
################################
-=item read
+=item B<read>
Overload Transtractor's read
@@ -905,7 +905,7 @@
push @{$self->{TT}{doc_in}}, read_file($self, $filename);
}
-=item read_file
+=item B<read_file>
Recursively read a file, appending included files which are not listed in the
@exclude_include array. Included files are searched using the B<kpsewhich>
@@ -1004,7 +1004,7 @@
=over 4
-=item parse_definition_file
+=item B<parse_definition_file>
Subroutine for parsing a file with po4a directive (definitions for
newcommands).
@@ -1044,7 +1044,7 @@
}
}
-=item parse_definition_line
+=item B<parse_definition_line>
Parse a definition line of the form "% po4a: ".
@@ -1096,7 +1096,7 @@
}
}
-=item is_closed
+=item B<is_closed>
=cut
@@ -1138,7 +1138,7 @@
#############################
#### MAIN PARSE FUNCTION ####
#############################
-=item parse
+=item B<parse>
=cut
@@ -1197,7 +1197,7 @@
}
} # end of parse
-=item docheader
+=item B<docheader>
=back
Modified: branches/0.40.x/lib/Locale/Po4a/Text.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/Text.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/Text.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/Text.pm Sun Nov 28 23:16:53 2010
@@ -76,7 +76,7 @@
my $bullets = 1;
-=item B<tabs>=I<mode>
+=item B<tabs=>I<mode>
Specify how tabulations shall be handled. The I<mode> can be any of:
@@ -98,7 +98,7 @@
my $tabs = "";
-=item B<breaks>=I<regex>
+=item B<breaks=>I<regex>
A regular expression matching lines which introduce breaks.
The regular expression will be anchored so that the whole line must match.
Modified: branches/0.40.x/lib/Locale/Po4a/TransTractor.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/TransTractor.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/TransTractor.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/TransTractor.pm Sun Nov 28 23:16:53 2010
@@ -785,17 +785,17 @@
=over
-=item wrap
+=item B<wrap>
boolean indicating whether we can consider that whitespaces in string are
not important. If yes, the function canonizes the string before looking for
a translation or extracting it, and wraps the translation.
-=item wrapcol
+=item B<wrapcol>
the column at which we should wrap (default: 76).
-=item comment
+=item B<comment>
an extra comment to add to the entry.
Modified: branches/0.40.x/lib/Locale/Po4a/Xhtml.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/Xhtml.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/Xhtml.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/Xhtml.pm Sun Nov 28 23:16:53 2010
@@ -47,7 +47,7 @@
=over 4
-=item B<includessi>[=I<rootpath>]
+=item B<includessi>[B<=>I<rootpath>]
Include files specified by an include SSI (Server Side Includes) element
(e.g. <!--#include virtual="/foo/bar.html" -->).
Modified: branches/0.40.x/lib/Locale/Po4a/Xml.pm
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/lib/Locale/Po4a/Xml.pm?rev=2396&op=diff
==============================================================================
--- branches/0.40.x/lib/Locale/Po4a/Xml.pm (original)
+++ branches/0.40.x/lib/Locale/Po4a/Xml.pm Sun Nov 28 23:16:53 2010
@@ -664,15 +664,15 @@
=over 4
-=item beginning
+=item B<beginning>
Specifies the beginning of the tag, after the "E<lt>".
-=item end
+=item B<end>
Specifies the end of the tag, before the "E<gt>".
-=item breaking
+=item B<breaking>
It says if this is a breaking tag class. A non-breaking (inline) tag is one
that can be taken as part of the content of another tag. It can take the
@@ -680,12 +680,12 @@
have to define the f_breaking function that will say whether a concrete tag of
this class is a breaking tag or not.
-=item f_breaking
+=item B<f_breaking>
It's a function that will tell if the next tag is a breaking one or not. It
-should be defined if the "breaking" option is not.
-
-=item f_extract
+should be defined if the B<breaking> option is not.
+
+=item B<f_extract>
If you leave this key undefined, the generic extraction function will have to
extract the tag itself. It's useful for tags that can have other tags or
@@ -693,7 +693,7 @@
function receives a boolean that says if the tag should be removed from the
input stream or not.
-=item f_translate
+=item B<f_translate>
This function receives the tag (in the get_string_until() format) and returns
the translated tag (translated attributes or all needed transformations) as a
@@ -1916,15 +1916,15 @@
=over 4
-=item include
+=item B<include>
This makes the returned array to contain the searched text
-=item remove
+=item B<remove>
This removes the returned stream from the input
-=item unquoted
+=item B<unquoted>
This ensures that the searched text is outside any quotes
More information about the Po4a-commits
mailing list