File, Schema, and Enumeration Naming and Capitalization Consistency

    • Type: Bug
    • Resolution: Fixed
    • Priority: Minor
    • None
    • Affects Version/s: None
    • Component/s: Domain Model
    • None
    • Hide

      Use consistent naming

      Show
      Use consistent naming

      The schemas and WSDLs will be major deliverables from this TC and we need consistency in naming the files, editing and formatting the schemas, and capitalizing the enumerations.

      I'm seeing a mixture of all uppercase, all lowercase, upper camel case, and lower camel case naming among the 0.50 artifacts.

      From Robin Cover's recent email regarding namespaces, I see that OASIS has existing standards for naming files, URIs, and namespaces:

      http://docs.oasis-open.org/specGuidelines/namingGuidelines/resourceNamingV08.html#uri-NS-root

      And a "camel" link therein to Robin's Cover Pages at:

      http://xml.coverpages.org/camelCase.html

      which appears to indicate a frequent preference among standards groups for upper camel case for elements and lower camel case for attributes.

      1. While the WSDL files are consistently named in upper camel case, the schema files are less consistently named:

      CMIS.xsd
      ATOM4CMIS.xsd
      cmisMessageTypes.xsd

      2. The CMIS.xsd has enumerations in lowercase, upper camel case, and lower camel case. Is there an established pattern being followed here?

      3. The schema could be simplified if they were to be edited to use the schema defaults.

      In particular, both minOccurs= and maxOccurs= default to "1" – so including minOccurs="1" and/or maxOccurs="1" is really clutter.

      4. Since we're early in the process, there probably should be a discussion with Mary and/or Robin regarding OASIS rules or preferences for element and attribute naming.

      Whatever the naming decisions may be, most of these changes would be quite mechanical to make to the files, although they would take some time for the early stack implementers to absorb – and for the editor to integrate into the documentation. Thus the sooner these were discussed and voted upon, the better.

            Assignee:
            Ethan Gur-esh (Inactive)
            Reporter:
            Gary Gershon (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: