Re: A couple of minor debiandoc issues
David Sewell (dsewell@virginia.edu) wrote:
> 1. I've noticed a small stylistic error in the way page cross-references are
> generated from DebianDoc SGML to PDF and Postscript output. Given a phrase
> in the SGML original like
>
> With the advent of package pools (see <ref id="pools">) ,
>
> if the location of the referenced section is on the previous page in
> printed PDF/PS output, this gets translated to
>
> With the advent of package pools (see 'The pool directory' on the
> page before)
>
> That's unidiomatic--it should be "on the preceding page." I'd file a bug
> report, but I can't figure out which program called by debiandoc2[pdf|ps]
> is responsible for the translation. (I'm an editor, dammit, not a
> programmer!)
Why don't you just file the bug and let me worry about who or what is the
culprit? :-) The funny thing is that LaTeX (or one of its styles) is
responsible for this. File the bug and I'll look into it.
> 2. One other tiny issue: the DebianDoc-SGML manual says of the <prgn> tag:
>
> In output formats where character highlighting and various font
> styles are available this is usually represented by using a
> fixed-width font. In plain text output formats these names are not
> specially marked at all, as they occur frequently and introducing
> quoting would disrupt the flow of the text.
>
> But actually the subroutine in /usr/share/perl5/DebianDoc_SGML/Format/Text.pm
> that handles <prgn> adds single quotation marks, just as the <tt>,
> <file>, and <package> subroutines do. (Subroutine is _output_prgn).
>
> Which ought to be changed, subroutine or documentation? Maybe the
> latter, because the quoting is helpful in differentiating short Linux
> program names from ordinary words.
Yes, this is definitely a documentation bug. Please file the report.
(Actually, the documentation is due for a complete overhaul.)
If you find more of these stylistic and other types or errors from an
editor point-of-view please file bug reports.
Thanks,
Ardo
--
Ardo van Rangelrooij
home email: ardo@debian.org
home page: http://people.debian.org/~ardo
GnuPG fp: 3B 1F 21 72 00 5C 3A 73 7F 72 DF D9 90 78 47 F9
--
To UNSUBSCRIBE, email to debian-doc-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Reply to: