ISSUE 116

Number 116
Category errata
Synopsis 19, para. 1: Grave accent, apostrophe character
State lrmdraft
Class errata-discuss
Arrival-DateSep 14 2002
Originator Shalom.Bresticker@motorola.com
Release 2001b: 2.5.1, 2.7.5, 19, 25.52-53, 25.55-56
Environment
http://boydtechinc.com/etf/archive/etf_2002/0236.html
http://www.columbia.edu/kermit/ascii.html
http://www.cl.cam.ac.uk/~mgk25/ucs/quotes.html
http://www.cl.cam.ac.uk/~mgk25/ucs/apostrophe.html
Description
---------- Forwarded message ----------
Date: Fri, 13 Sep 2002 18:50:05 -0700
From: Brad Pierce <Brad.Pierce@synopsys.com>

1) In the first sentence of section 19 it is claimed that ASCII value
0x60 is called "accent grave". Likewise, in section 2.7.5, it is
claimed that it is called "open quote or accent grave". Although in
French this symbol is indeed called "accent grave", the standard name is
"grave accent".

US ASCII, ANSI X3.4-1986 (ISO 646 International Reference
Version)
<http://www.columbia.edu/kermit/ascii.html>

2) In the second sentence there is an empty set of parentheses which
should enclose an apostrophe.

3) In the second sentence the phrase "single quote character" should be
replaced with "apostrophe character" or "apostrophe character used in
Verilog number base formats".

<http://www.cl.cam.ac.uk/~mgk25/ucs/quotes.html>


Fix

1. In 2.5.1:

A. CHANGE the third sentence of paragraph 2 FROM

"The second form specifies a size constant, which shall be 
composed of up to three tokens-an optional size constant, a 
single quote followed by a base format character, and the 
digits representing the value of the number."

TO:

"The second form specifies a based constant, which shall be 
composed of up to three tokens-an optional size constant, an
apostrophe character (', ASCII 0x27) followed by a base 
format character, and the 
digits representing the value of the number."

(Note that issue #267 changes "size constant" to "based 
constant".)

B. CHANGE the first sentence of paragraph 5 FROM

"The second token, a base_format, shall consist of a 
case-insensitive letter specifying the base for the number, 
optionally preceded by the single character s (or S) to 
indicate a signed quantity, preceded by the single quote 
character (')."

TO:

"The second token, a base_format, shall consist of a 
case-insensitive letter specifying the base for the number, 
optionally preceded by the single character s (or S) to 
indicate a signed quantity, preceded by the apostrophe
character."

C. CHANGE paragraph 7 FROM

"The single quote and the base format character shall not 
be separated by any white space."
 
TO:

"The apostrophe character and the base format character 
shall not be separated by any white space."


2. CHANGE the first sentence of 2.7.5 FROM

"The ` character (the ASCII value 60, called open quote 
or accent grave) introduces a language construct used to 
implement compiler directives."

TO:

"The ` character (the ASCII value 0x60, called 
grave accent) introduces a language construct used to 
implement compiler directives."


3. CHANGE the first three sentences of section 19 FROM

"All Verilog compiler directives are preceded by the (` ) 
character. This character is called accent grave. It is 
different from the character ('), which is the single quote 
character."

TO

"All Verilog compiler directives are preceded by the (` ) 
character. This character is called grave accent
(ASCII 0x60). It is 
different from the character ('), which is the apostrophe
character (ASCII 0x27)."

(Note to editor:
The ` and ' characters should be in Courier font.
The apostrophe character should be straight vertical, not
slanted.)


4. The term "single quote" appears in 25.52-53, 55-56 in the
phrase "A character in single quotes ...", referring to C code.
Leave the phrase as is in those places.


5. Editor to make sure that everywhere the apostrophe character
is supposed to appear in code text, both Verilog and C, the 
plain straight up-and-down apostrophe character is used, not a 
curly quote nor a slanted quote character.

Similarly, make sure that the regular plain grave accent 
character is used wherever it is needed, not a curly version.

Similarly, double quotes in code text should be regular 
straight up-and-down quotation marks, not 'smart', slanted
quotes.

(Note to editor: change CourierNew font to Courier, 
 TimesNewRoman to Times.) 

Audit-Trail From: Shalom Bresticker <Shalom.Bresticker@motorola.com> To: etf-bugs@boyd.com Cc: Subject: Re: errata/116: PROPOSAL - 19, para. 1: Grave accent Date: Thu, 19 Dec 2002 11:12:55 +0200 I actually would like to discuss this one. Some additional points: 1. References (from Brad): http://www.columbia.edu/kermit/ascii.html http://www.cl.cam.ac.uk/~mgk25/ucs/quotes.html http://www.cl.cam.ac.uk/~mgk25/ucs/apostrophe.html 2. The term single quote also appears in 2.5.1 three times, and in 25.52-53, and 25.55-56. 3. I would like where the apostrophe character is mentioned in 2.5.1 and 19, for its ASCII code to be mentioned as well. 4. Where the ASCII codes are mentioned, in 2.5.1, 2.7.5, and 19, it should be said hether the code is in hex or decimal. 5. Finally, but the most work: everywhere the apostrophe character is supposed to appear in code in the text, should it be changed to a real simple apostrophe character? Why is it a question? I, for one, have become used to seeing these two characters (apostrophe and grave accent) looking as "forward tic" (as in 2.5.1, Example 4, first half) and "backward tic". If I change all the "forward tics" to simple apostrophes, they will become straight (as in 2.5.1, Example 4, second half), and we will have "straight tics" and "back tics". Technically, that is what we should do, but there may be other considerations. Maybe we should even add a sentence that "on your screen/printer", the appearance of the apostrophe may differ". PS. Separately, we also need to need to discuss, but probably much more briefly, the double quote characters. Shalom > Change the second sentence of section 19 from > > "This character is called accent grave." > > to > > "This character is called grave accent." > > --- > > In the third sentence, change > > "(), which is the single quote character" > > to > > "('), which is the apostrophe character" > > -- > > In the first sentence of section 2.7.5, change > > "open quote or accent grave" > > to > > "grave accent" > > http://boydtechinc.com/cgi-bin/issueproposal.pl?cmd=view&pr=116 -- Shalom Bresticker Shalom.Bresticker@motorola.com Design & Reuse Methodology Tel: +972 9 9522268 Motorola Semiconductor Israel, Ltd. Fax: +972 9 9522890 POB 2208, Herzlia 46120, ISRAEL Cell: +972 50 441478 "The devil is in the details." From: Shalom Bresticker <Shalom.Bresticker@motorola.com> To: etf-bugs@boyd.com Cc: Subject: Re: errata/116: PROPOSAL - 19, para. 1: Grave accent Date: Thu, 19 Dec 2002 11:20:36 +0200 Also, note to the editor: All the apostrophes and grave accents that appear in code in the text need to be converted to regular characters. They today may appear as any of their variants, e.g., smart quotes are curly quotes. Furthermore, they may not always appear in code font. They may appear in a keyword font or even a regular font. They may be in the middle of the text and not just in examples, etc. Need to catch as many of them as possible. Also, need to characterize the apostrophes which do not come out in the PDF. What variant are they?
Unformatted

Hosted by Boyd Technology