Re: [sca-assembly] [NEW ISSUE] Add a Section documenting naming conventionsto the start of the SCA Assembly Specification

http://www.osoa.org/jira/browse/ASSEMBLY-96

Yours,  Mike.

Strategist - Emerging Technologies, SCA & SDO.

Co Chair OASIS SCA Assembly TC.

IBM Hursley Park, Mail Point 146, Winchester, SO21 2JN, Great Britain.

Phone & FAX: +44-1962-818014    Mobile: +44-7802-467431  

Email:  

From:
Mike Edwards/UK/IBM@IBMGB

To:
"OASIS Assembly" <>

Date:
21/11/2008 09:56

Subject:
[sca-assembly] [NEW ISSUE] Add a Section
documenting naming conventions to the start of the SCA Assembly Specification

Raiser:                Mike Edwards

Target:                SCA Assembly
Specification:  sca-assembly-1.1-spec-cd01-rev3.doc

Description: 

The SCA Liaison committee has asked us to add a small section on naming
conventions to the 

frontmatter of the SCA Assembly specification. 

This needs to cover conventions for the names that are defined by SCA in
particular: 

- names of elements and attributes in XSD files 

- names of intents 

Proposal: 

Add a new section, 1.3, following line 62: 

1.3 Naming Conventions 

This specification follows some naming conventions for artifacts defined
by the specification, 

as follows: 

For the names of elements and the names
of attributes within XSD files, the names follow

the CamelCase convention, with all names starting with a lower case letter.

eg <element
name="componentType"
type="sca:ComponentType"/>

For the names of types within XSD files,
the names follow the CamelCase convention with

all names starting with an upper case letter

eg. <complexType
name="ComponentService">

For the names of intents, the names
follow the CamelCase convention, with all names 

starting with a lower case letter, EXCEPT for cases where the intent represents
an

established acronym, in which case the entire name is in upper case.

An example of an intent which is an acronym is the "SOAP" intent.

Yours,  Mike.

Strategist - Emerging Technologies, SCA & SDO.

Co Chair OASIS SCA Assembly TC.

IBM Hursley Park, Mail Point 146, Winchester, SO21 2JN, Great Britain.

Phone & FAX: +44-1962-818014    Mobile: +44-7802-467431  

Email:  

Unless stated otherwise above:

IBM United Kingdom Limited - Registered in England and Wales with number
741598. 

Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6
3AU 

Unless stated otherwise above:

IBM United Kingdom Limited - Registered in England and Wales with number
741598. 

Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6
3AU