Khronos Public Bugzilla
Bug 155 - id and sid represented inconsistently throughout spec
Summary: id and sid represented inconsistently throughout spec
Status: NEW
Alias: None
Product: COLLADA
Classification: Unclassified
Component: Specification (show other bugs)
Version: 1.5.0
Hardware: Macintosh Mac OS
: P3 minor
Target Milestone: Release 1.5.1
Assignee: Fabrice Robinet
QA Contact: COLLADA Work Group email alias
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-04-22 17:40 PDT by Ellen Finch
Modified: 2014-01-07 10:30 PST (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ellen Finch 2009-04-22 17:40:29 PDT
Consistent formatting and capitalization can help clarity. Currently, ID, id, SID, sid are inconsistently used, capitalized, and formatted.

From COLLADA style guide:

identifier (ID) –  Spell out identifier in most cases, although ID is allowable after it has been spelled out and defined in parentheses in the same element or section; for example: “identifier (ID)”. No special formatting on ID; it’s an acronym, not an attribute name. Don’t use id (except id* when it is an attribute name).
 
scoped identifier (SID)–  Spell out scoped identifier in most cases, although SID is allowable after it has been spelled out and defined in parentheses in the same element or section; for example: “scoped identifier (SID)”. When using SID, use with an (“an SID”). Hyphenate as adjective (scoped-identifier addressing). No special formatting on SID; it’s an acronym, not an attribute name (except sid* when it is an attribute name).

* In these cases, format the id or sid in monotype font, whatever's in the document; currently, courier. Not italic.