ISSUE 170

Add Proposal  Edit Analysis  Edit Class, Environment, or Release
Number 170
Category errata
Synopsis formatting of bnf non-terminals
State analyzed
Class errata-discuss
Arrival-DateOct 24 2002
Originator Shalom Bresticker <Shalom.Bresticker@motorola.com>
Release 2001b
Environment
Description

--------------BE979914B9374CBE99EA80AD
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

There is inconsistent formatting of BNF non-terminal names where they
appear in the main text.

Sometimes they appear in italics Times font, sometimes in fixed Courier
font.
I think in the majority of cases, they appear in Courier font.
It is possible there are additional cases.

Section 1.3 does not cover this.
It says that italics are used when a term is being defined (another
convention not well adhered to. Many terms appear in italics both before
and after their definitions.) and fixed font is used for examples and
constants.

Personally, I would prefer the italics, but that would be more work.

In any case, 1.3 should cover this and it should be consistent.

--
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."



--------------BE979914B9374CBE99EA80AD
Content-Type: text/html; charset=us-ascii
Content-Transfer-Encoding: 7bit

<!doctype html public "-//w3c//dtd html 4.0 transitional//en">

There is inconsistent formatting of BNF non-terminal names where they
appear in the main text.

Sometimes they appear in italics Times font, sometimes in fixed Courier
font.

I think in the majority of cases, they appear in Courier font.

It is possible there are additional cases.

Section 1.3 does not cover this.

It says that italics are used when a term is being defined (another
convention not well adhered to. Many terms appear in italics both before
and after their definitions.) and fixed font is used for examples and constants.

Personally, I would prefer the italics, but that would be more
work.

In any case, 1.3 should cover this and it should be consistent.

-- 
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."

 

--------------BE979914B9374CBE99EA80AD--

Fix
Audit-Trail

Analyzed by Shalom.Bresticker@motorola.com on Tue May 27 06:08:49 2003

I propose that BNF non-terminals be formatted in the text as
italics Times font.

Most non-terminals have underscores in the name and can be
located that way.

A few non-terminals are just a single word, such as
"expression", and appear in the text many times as regular
words and not just as BNF constructs. So it is hard to spot
those places where they are specifically intended to refer
to the BNF construct. But in many of those cases, the
sentence will work equally well if they are interpreted as
regular words anyway.

Unformatted



Hosted by Boyd Technology