Package: libtext-xslate-perl
Version: 3.5.9-2+b1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:377: warning [page 5, line 1]: cannot break line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.21-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages libtext-xslate-perl depends on:
ii libc6 2.41-6
ii libdata-messagepack-perl 1.02-1+b4
ii libmouse-perl 2.5.11-1+b1
ii perl 5.40.1-2
ii perl-base [perlapi-5.40.0] 5.40.1-2
libtext-xslate-perl recommends no packages.
libtext-xslate-perl suggests no packages.
-- no debconf information
Input file is Text::Xslate::Manual::FAQ.3pm
Output from "mandoc -T lint Text::Xslate::Manual::FAQ.3pm": (shortened list)
1 : Text::Xslate::Manual::FAQ.3pm:112:99: STYLE: input text line longer
than 80 bytes: Note that \f(CW\*(C`...
1 : Text::Xslate::Manual::FAQ.3pm:156:82: STYLE: input text line longer
than 80 bytes: Handle warnings by \...
1 : Text::Xslate::Manual::FAQ.3pm:158:81: STYLE: input text line longer
than 80 bytes: That's because Xslat...
1 : Text::Xslate::Manual::FAQ.3pm:187:114: STYLE: input text line longer
than 80 bytes: Instance attributes,...
1 : Text::Xslate::Manual::FAQ.3pm:209:133: STYLE: input text line longer
than 80 bytes: Use \f(CW\*(C`start_...
1 : Text::Xslate::Manual::FAQ.3pm:227:87: STYLE: input text line longer
than 80 bytes: Convert HASH referen...
1 : Text::Xslate::Manual::FAQ.3pm:280:90: STYLE: input text line longer
than 80 bytes: While Template-Toolk...
1 : Text::Xslate::Manual::FAQ.3pm:303:90: STYLE: input text line longer
than 80 bytes: Xslate assumes templ...
1 : Text::Xslate::Manual::FAQ.3pm:313:298: STYLE: input text line longer
than 80 bytes: Template-Toolkit all...
1 : Text::Xslate::Manual::FAQ.3pm:332:89: STYLE: input text line longer
than 80 bytes: Macros are objects t...
1 : Text::Xslate::Manual::FAQ.3pm:377:101: STYLE: input text line longer
than 80 bytes: Initializing Xslate:...
-.-.
Output from
test-nroff -mandoc -t -ww -z Text::Xslate::Manual::FAQ.3pm: (shortened list)
1 cannot break line
-.-.
Show if Pod::Man generated this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
2:.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
-.-.
Strings longer than 3/4 of a standard line length (80).
Use "\:" to split the string at the end of an output line, for example a
long URL (web address).
This is a groff extension.
377 Initializing Xslate:
<https://github.com/duckduckgo/community\-platform/blob/master/lib/DDGC.pm#L268>
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
187:Instance attributes, e.g. \f(CW\*(C`include_path\*(C'\fR,
\f(CW\*(C`function\*(C'\fR, or \f(CW\*(C`syntax\*(C'\fR,
313:Template-Toolkit allows objects (i.e. blessed references) to access its
element if the object has no accessor methods, i.e. \f(CW\*(C`[% object.attr
%]\*(C'\fR might mean \f(CW\*(C`$object\->{attr}\*(C'\fR. This behavior breaks
encapsulation and hides typos, so Xslate doesn't allow such fallbacks.
-.-.
Wrong distance (not two spaces) between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
86:Xslate supports multiple template syntaxes. Kolon is the default syntax,
88:with Template-Toolkit 2. You can specify the template syntax by passing
104:Xslate is tested on perl v5.8.1. No special settings should be required.
136:byte code. For example (as described elsewhere) Text::Xslate automatically
137:escapes HTML unless you tell it not to. Text::Xslate implements this process
139:output buffer in C, as a custom byte code. This lets you avoid the penalties
150:space the current rendering will require. This allows you to greatly reduce
the
182:Don't create the instance in each request. It's less efficient.
187:Instance attributes, e.g. \f(CW\*(C`include_path\*(C'\fR,
\f(CW\*(C`function\*(C'\fR, or \f(CW\*(C`syntax\*(C'\fR,
267:you to export any functions to templates. Any function-based modules
275:hashes), you can write bridge modules. See Text::Xslate::Bridge for details.
313:Template-Toolkit allows objects (i.e. blessed references) to access its
element if the object has no accessor methods, i.e. \f(CW\*(C`[% object.attr
%]\*(C'\fR might mean \f(CW\*(C`$object\->{attr}\*(C'\fR. This behavior breaks
encapsulation and hides typos, so Xslate doesn't allow such fallbacks.
321:Not yet. Currently Xslate doesn't support external macros.
348:\& { a => [ 0 .. 100 ] },
410:\fII found a bug! What can I do for you?\fR
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
[List of affected lines removed.]
Longest line is number 313 with 298 characters
Template-Toolkit allows objects (i.e. blessed references) to access its element
if the object has no accessor methods, i.e. \f(CW\*(C`[% object.attr %]\*(C'\fR
might mean \f(CW\*(C`$object\->{attr}\*(C'\fR. This behavior breaks
encapsulation and hides typos, so Xslate doesn't allow such fallbacks.
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
288:\& alarm(1); # set timeout
-.-.
Remove unnecessary double font change (e.g., \fR\fI) in a row or (better)
use a two-fonts macro.
310:\fIWhy doesn't I cannot access \fR\f(CI$object\fR\fI.attr like TT2?\fR
353:\fIHow can I use Xslate in \fR\f(CI$my_favorite_WAF\fR\fI?\fR
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Text::Xslate::Manual::FAQ.3pm:136:byte code. For example (as described
elsewhere) Text::Xslate automatically
Text::Xslate::Manual::FAQ.3pm:272:class methods (they need wrappers).
Text::Xslate::Manual::FAQ.3pm:313:Template-Toolkit allows objects (i.e. blessed
references) to access its element if the object has no accessor methods, i.e.
\f(CW\*(C`[% object.attr %]\*(C'\fR might mean
\f(CW\*(C`$object\->{attr}\*(C'\fR. This behavior breaks encapsulation and
hides typos, so Xslate doesn't allow such fallbacks.
-.-.
Use a character "\(->" instead of plain "->" or "\->".
92:\& my $tx = Text::Xslate\->new(
96:\& my $tx = Text::Xslate\->new(
172:\& my $xslate = Text::Xslate\->new(...);
198:\& ja => Text::Xslate\->new( path => [ $template_ja ],
%common_config ),
199:\& en => Text::Xslate\->new( path => [ $template_en ],
%common_config ),
200:\& ro => Text::Xslate\->new( path => [ $template_ro ],
%common_config ),
202:\& $xslate{$lang}\->render(...);
213:\& my $tx = Text::Xslate\->new(
219:\& print $tx\->render_string(\*(AqHello, {{lang}} world!\*(Aq, { lang =>
\*(AqXslate\*(Aq });
233:\& : for $hash.keys() \-> $key {
237:\& : for $hash.values() \-> $value {
241:\& : for $hash.kv() \-> $pair {
289:\& $tx\->render(\*(Aq<: while true { } :>\*(Aq, \e%vars);
313:Template-Toolkit allows objects (i.e. blessed references) to access its
element if the object has no accessor methods, i.e. \f(CW\*(C`[% object.attr
%]\*(C'\fR might mean \f(CW\*(C`$object\->{attr}\*(C'\fR. This behavior breaks
encapsulation and hides typos, so Xslate doesn't allow such fallbacks.
337:\& my $tx = Text::Xslate\->new(
342:\& return scalar grep { $cb\->($_) } @{$a};
347:\& print $tx\->render_string(\*(Aq<: count($a, \-> $x { $x >= 50 })
:>\*(Aq,
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
Text::Xslate::Manual::FAQ.3pm:86:Xslate supports multiple template syntaxes.
Kolon is the default syntax,
Text::Xslate::Manual::FAQ.3pm:88:with Template-Toolkit 2. You can specify the
template syntax by passing
Text::Xslate::Manual::FAQ.3pm:104:Xslate is tested on perl v5.8.1. No special
settings should be required.
Text::Xslate::Manual::FAQ.3pm:136:byte code. For example (as described
elsewhere) Text::Xslate automatically
Text::Xslate::Manual::FAQ.3pm:137:escapes HTML unless you tell it not to.
Text::Xslate implements this process
Text::Xslate::Manual::FAQ.3pm:139:output buffer in C, as a custom byte code.
This lets you avoid the penalties
Text::Xslate::Manual::FAQ.3pm:150:space the current rendering will require.
This allows you to greatly reduce the
Text::Xslate::Manual::FAQ.3pm:182:Don't create the instance in each request.
It's less efficient.
Text::Xslate::Manual::FAQ.3pm:187:Instance attributes, e.g.
\f(CW\*(C`include_path\*(C'\fR, \f(CW\*(C`function\*(C'\fR, or
\f(CW\*(C`syntax\*(C'\fR,
Text::Xslate::Manual::FAQ.3pm:267:you to export any functions to templates. Any
function-based modules
Text::Xslate::Manual::FAQ.3pm:275:hashes), you can write bridge modules. See
Text::Xslate::Bridge for details.
Text::Xslate::Manual::FAQ.3pm:313:Template-Toolkit allows objects (i.e. blessed
references) to access its element if the object has no accessor methods, i.e.
\f(CW\*(C`[% object.attr %]\*(C'\fR might mean
\f(CW\*(C`$object\->{attr}\*(C'\fR. This behavior breaks encapsulation and
hides typos, so Xslate doesn't allow such fallbacks.
Text::Xslate::Manual::FAQ.3pm:321:Not yet. Currently Xslate doesn't support
external macros.
Text::Xslate::Manual::FAQ.3pm:348:\& { a => [ 0 .. 100 ] },
Text::Xslate::Manual::FAQ.3pm:410:\fII found a bug! What can I do for you?\fR
Text::Xslate::Manual::FAQ.3pm:411:.IX Subsection "I found a bug! What can I do
for you?"
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
Text::Xslate::Manual::FAQ.3pm:66:.IX Header "DESCRIPTION"
Text::Xslate::Manual::FAQ.3pm:69:.IX Header "QUESTIONS"
Text::Xslate::Manual::FAQ.3pm:71:.IX Subsection "General"
Text::Xslate::Manual::FAQ.3pm:156:.IX Subsection "Configuration"
Text::Xslate::Manual::FAQ.3pm:201:.IX Subsection "Templates"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
61:.if n .ad l
-.-.
Add lines to use the CR font for groff instead of CW.
.if t \{\
. ie \\n(.g .ft CR
. el .ft CW
.\}
11:.ft CW
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
322:.SS "Functions, filters and macros"
351:.SS "Web Application Frameworks"
382:.SS "Development and support"
415:.SH "SEE ALSO"
-.-.
.\" Define a fallback for font CW with
.if t \{\
. ie \n(.g .ds fC \f(CR
. el .ds fC \f(CW
.\}
.
.if n \{\
. ds fC \fR
.\}
Change \f(CW to \*(fC
75:We read it \f(CW\*(C`/eks\-leit/\*(C'\fR.
89:\&\f(CW\*(C`syntax\*(C'\fR option to the Text::Xslate constructor.
109:Pass \f(CW\*(C`PUREPERL_ONLY=1\*(C'\fR to \fIMakefile.PL\fR, which requests
112:Note that \f(CW\*(C`cpanm 1.7\*(C'\fR supports \f(CW\*(C`\-\-pp\*(C'\fR
option to install pure-Perl
113:alternatives, so you can type \f(CW\*(C`cpanm \-\-pp Text::Xslate\*(C'\fR.
144:while processing a template is to avoid the number of calls to
\f(CWmalloc()\fR.
146:\&\f(CWmalloc()\fR is to pre-allocate the output buffer in an intelligent
manner:
151:number of \f(CWmalloc()\fR calls required to render a template.
156:Handle warnings by \f(CW\*(C`warn_handler\*(C'\fR and raises exceptions if
needed.
187:Instance attributes, e.g. \f(CW\*(C`include_path\*(C'\fR,
\f(CW\*(C`function\*(C'\fR, or \f(CW\*(C`syntax\*(C'\fR,
209:Use \f(CW\*(C`start_tag\*(C'\fR, \f(CW\*(C`end_tag\*(C'\fR, and
\f(CW\*(C`line_start\*(C'\fR options to \f(CW\*(C`new\*(C'\fR method,
210:which can be joined together with \f(CW\*(C`syntax\*(C'\fR option:
227:Convert HASH references into ARRAY references because \f(CW\*(C`for\*(C'\fR
methods can
258:\&\f(CW\*(C`T::X::Bridge::TT2\*(C'\fR, and it does not require the
Template-Toolkit runtime.
268:are available by the \f(CW\*(C`module\*(C'\fR option.
280:While Template-Toolkit has a loop counter to prevent runaway
\f(CW\*(C`WHILE\*(C'\fR loop,
283:Instead, you can use \f(CWalarm()\fR to limit \fBany\fR runaway code:
303:Xslate assumes template files to be encoded in \f(CW\*(C`UTF\-8\*(C'\fR by
default, so the
308:\&\f(CW\*(C`:bytes\*(C'\fR to \f(CW\*(C`input_layer\*(C'\fR, although it's
not recommended.
313:Template-Toolkit allows objects (i.e. blessed references) to access its
element if the object has no accessor methods, i.e. \f(CW\*(C`[% object.attr
%]\*(C'\fR might mean \f(CW\*(C`$object\->{attr}\*(C'\fR. This behavior breaks
encapsulation and hides typos, so Xslate doesn't allow such fallbacks.
316:or prepare values as a non-object before calling \f(CWrender()\fR.
332:Macros are objects that overload \f(CW\*(C`&{}\*(C'\fR, the CODE
dereference operator, so
387:For \f(CW\*(C`vim\*(C'\fR user, there is \fIxslate.vim\fR for Kolon:
391:For \f(CW\*(C`emacs\*(C'\fR user, there are plugins:
-.-.
Put a (long) web address on a new line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
375:<https://github.com/duckduckgo/community\-platform>
377:Initializing Xslate:
<https://github.com/duckduckgo/community\-platform/blob/master/lib/DDGC.pm#L268>
379:Working on: <https://dukgo.com/>
389:<https://github.com/motemen/xslate\-vim>
393:<https://github.com/samvtran/kolon\-mode>
395:<https://github.com/yoshiki/tx\-mode>
402:<http://groups.google.com/group/xslate>
408:<https://github.com/xslate/p5\-Text\-Xslate/issues>
-.-.
Add "\&" after an ellipsis, when it does not end a sentence
172:\& my $xslate = Text::Xslate\->new(...);
202:\& $xslate{$lang}\->render(...);
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:377: warning [page 5, line 1]: cannot break line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- Text::Xslate::Manual::FAQ.3pm 2025-04-08 17:49:12.362722400 +0000
+++ Text::Xslate::Manual::FAQ.3pm.new 2025-04-08 17:56:24.643421517 +0000
@@ -374,7 +374,8 @@ There is a real-world project that uses
.PP
<https://github.com/duckduckgo/community\-platform>
.PP
-Initializing Xslate:
<https://github.com/duckduckgo/community\-platform/blob/master/lib/DDGC.pm#L268>
+Initializing Xslate:
+<https://github.com/duckduckgo/community\-platform/blob/master/lib/DDGC.pm#L268>
.PP
Working on: <https://dukgo.com/>
.PP
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
