Discussion:
minor typographical issue in Shell Command Language
Martin Sebor
2014-08-12 17:39:31 UTC
Permalink
The sentence in section 2.6.2 Parameter Expansion in the HTML
(and on page 2328, line 73947 in the PDF) is ever so slightly
inconsistently formatted, making one wonder about the intended
expansion in the example (which does become apparent after
a careful reading). The problem is in the sentence that reads:

(For example, ${foo-bar} xyz} would result in the expansion
of foo followed by the string xyz} if foo is set, else the
string "barxyz}").

In the HTML, the strings foo-bar, xyz, foo, and barxyz} are in
bold, while the rest of the text is in normal weight font. There
also is a space between ${ and foo-bar, and between ${foo-bar}
and xyz}.

In the PDF, the strings foo-bar, xyz and foo are also in bold,
but the string barxyz} is in monospace and normal weight. There
are no extra spaces.

In both the HTML and the PDF, only the string barxyz} is quoted.

I couldn't find the text that describes the notational conventions
used in the document but based on a quick review of a few examples
in the nearby text I would expect all the strings above to be in
monospace font, and both of the two possible results of the expansion,
namely "xyz}" and "barxyz}" to be quoted.

Is this worth opening an issue for or can it be left up to the
better judgment of the editor?

Martin
Andrew Josey
2014-08-14 15:41:06 UTC
Permalink
hi Martin, all
Post by Martin Sebor
The sentence in section 2.6.2 Parameter Expansion in the HTML
(and on page 2328, line 73947 in the PDF) is ever so slightly
inconsistently formatted, making one wonder about the intended
expansion in the example (which does become apparent after
(For example, ${foo-bar} xyz} would result in the expansion
of foo followed by the string xyz} if foo is set, else the
string "barxyz}").
In the HTML, the strings foo-bar, xyz, foo, and barxyz} are in
bold, while the rest of the text is in normal weight font. There
also is a space between ${ and foo-bar, and between ${foo-bar}
and xyz}.
In the PDF, the strings foo-bar, xyz and foo are also in bold,
but the string barxyz} is in monospace and normal weight. There
are no extra spaces.
In both the HTML and the PDF, only the string barxyz} is quoted.
I couldn't find the text that describes the notational conventions
used in the document but based on a quick review of a few examples
in the nearby text I would expect all the strings above to be in
monospace font, and both of the two possible results of the expansion,
namely "xyz}" and "barxyz}" to be quoted.
Is this worth opening an issue for or can it be left up to the
better judgment of the editor?
Martin
I’ll need to check with our editor on this. Typographical conventions are
on page xvii . A literal string should be quoted courier (monospace).
A literal character single quoted. Example output is Bold courier.
User input is courier (monospace).

regards
Andrew


--------
Andrew Josey The Open Group
Austin Group Chair Apex Plaza, Forbury Road
Email: a.josey-7882/***@public.gmane.org Reading,Berks.RG1 1AX,England
Tel:+44 118 9023044 US fax: +1 415 276 3760
Mobile:+44 774 015 5794 UK fax: +44 870 131 0418
Andrew Josey
2014-08-21 13:53:19 UTC
Permalink
All
A quick update on this item...

On 14 Aug 2014, at 16:41, Andrew Josey <ajosey-7882/***@public.gmane.org> wrote:

{snip}
Post by Andrew Josey
I’ll need to check with our editor on this. Typographical conventions are
on page xvii . A literal string should be quoted courier (monospace).
A literal character single quoted. Example output is Bold courier.
User input is courier (monospace).
I checked with our editor and she says:


"I have had a look at the code for this and it seems that "foo" and "bar" are consistently coded as filenames in this area; i.e., .Fi foo. Since this piece is talking about strings rather than file names we could change that here, but it needs a closer analysis.

Re the spaces in the HTML, the troff is coded using "\c" as a no-space continuation, so this is a translation error in the HTML. However, if we decide to use the string coding this would go away too.

It would be good to add this to a TC so that it doesn't get missed and we can work out how to address it during our edit.”

So I will file a bug report so we can resolve it in the TC
regards
Andrew


--------
Andrew Josey The Open Group
Austin Group Chair Apex Plaza, Forbury Road
Email: a.josey-7882/***@public.gmane.org Reading,Berks.RG1 1AX,England
Tel:+44 118 9023044 US fax: +1 415 276 3760
Mobile:+44 774 015 5794 UK fax: +44 870 131 0418

Loading...