 |
|
 |
|
USING NAMING CONVENTIONS
|
Naming conventions make
schema more understandable by making them easier to read. They
can
also give information about the function of the identifier-for
example, whether its an element, type,
or attribute- which can be helpful in understanding the
schema. There exists many varied naming
conventions, and none of them is really wrong. What it comes
down to is a matter of personal
preference. The following outlines what the recommended
OFDAxml naming conventions do allow,
and do not allow.
OFDAxml does:
- Use identifiers
that provide clues to the meaning of the content.
Readibility is more
than tag length.
- Use the Upper
Camel Case capitalization style for all XML constructs other
than attributes
in which the first letter in the identifier and the first letter
of each subsequent concatenated
word are capitalized. Used for names of three or more
characters. For example: DateRequired.
- Use the Lower
Camel Case capitalization style for attribute names in which the
first letter in the identifier is in lower case and the first
letter of each subsequent concatenated word are
capitalized. Used for attribute names of three or more
characters.
- Append the word
"Type" to all names of simple types.
- Use well-known
acronyms to replace lengthy phrase names where
appropriate. For
example, ItemSKU instead of ItemStockKeepingUnit.
- Use Upper Camel
Case for acronyms of three or more characters. However,
acronyms that
consist of only two characters should be capitalized. For
example: ContractID
- Use names, not
numbers, for enumeration values. The names used for
enumeration values
must conform to the guidelines for element or attribute names.
- Prefer ISO
standards to national or consortium specifications.
OFDAxml does not:
- Use names that
require case sensitivity.
- Create identifiers
with names that differ only by case.
- Use abbreviations
or contractions as parts of identifier names. For example,
use
TaxNumber instead of TaxNum.
- Use acronyms that are not
generally accepted outside of the office furniture industry. For
example, SIF.
- Include a repetition of the
name of a containing structure in the name of an element. For
example, a <Customer> element could contain a <Name>
element but should not contain a <CustomerName>element.
|
|
|
© 2004 Office Furniture
Dealers Alliance. All Rights Reserved.
|
|
 |
 |