: Design Rules TM-XML, A Trade Mark XML Open Standard Initiative Trade mark, trademark, XML, Standard specs TM-XML Specifications. TM-XML Schema Naming and Design Rules. Rule WIPO ST.66 Rule Rule Description Status rowsection General Rules rowodd GE-001 24 ISO/IEC 10646 – UCS – Unicode UTF-8 MUST be used for character set. ../TM-XML_Image/MustIcon.jpg Must Icon roweven GE-002 20 The W3C XML Schema definition language has become the generally accepted schema language that is experiencing the most widespread adoption. Although other schema languages exist that offer their own advantages and disadvantages, all XML Schema design rules MUST be based on the W3C XML Schema Recommendations: XML Schema Part 1: Structures and XML Schema, Part 2: Datatypes. All schemas and messages MUST be based on the W3C suite of technical specifications holding recommendation status. ../TM-XML_Image/MustIcon.jpg Must Icon rowodd GE-003 23 ISO 3166 MUST be used for address country codes and nationalities. Examples: Address Country, Nationality ../TM-XML_Image/MustIcon.jpg Must Icon roweven GE-004 25 ISO 639-1 (2-Letter Language Codes) MUST be used for Language Codes. Examples: Application, Correspondence Languages ../TM-XML_Image/MustIcon.jpg Must Icon rowodd GE-005 26 ISO 8601 - International Standard Date and Time Notation MUST be used for Date and Time Notation. W3C Schema data types include date and time and SHOULD be used in preference to ISO 8601, where there is any conflict. ../TM-XML_Image/MustIcon.jpg Must Icon roweven GE-006 22 WIPO Standard ST.3 MUST be used for priority and seniority country. ../TM-XML_Image/MustIcon.jpg Must Icon rowodd GE-007 The XML Schema should be compliant with UN/CEFACT ebXML (Electronic Business Using XML) and OASIS UBL (Universal Business Language) in particular the ebXML Message Service (ebMS) layer should be used for message packaging, routing and transport facilities. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven GE-008 13 Regarding the option between XML-DTD and XML Schema, the use of XML Schema is recommended. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd GE-009 27 ISO 4217-Alpha (3-Letter Currency Codes) MUST be used for Currency Codes. ../TM-XML_Image/MustIcon.jpg Must Icon roweven GE-010 21 Redefinition of XSD built-in data types SHOULD be avoided. Example: Use directly the native Boolean type and not an IndicatorType defined as a Boolean or a Boolean type. ../TM-XML_Image/MustIcon.jpg Must Icon rowsection Naming Rules rowodd NM-001 45 Following OASIS UBL and ebXML which derived from ISO 11179-5, the name of the tag must be as much as possible self-described and highly structured. ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-002 44 The XML tag naming conventions are based on the concepts as defined in ISO 11179 Part 5. Element, attribute and type names SHOULD consist of the Object Class, the name of the Property Term and the name of a Representation Term. An Object Class identifies the primary concept of the element. It refers to an activity or an object within a business context and may consist of one, two or three words. The Property Term identifies the characteristics of the object class. The name of a Property Term shall occur naturally in the tag definition and may consist of one, two or three words. A name of a Property Term shall be unique within the context of an Object Class but may be reused across different Object Classes. If the Representation Term uses the same word as the last one sed by the Property Term, the Representation Term shall be omitted. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd NM-003 44 d) Object class and Representation Terms should be omitted when the Property Term alone is commonly used and sufficient to express the concept without confusion in its context. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven NM-004 54 When the same word is repeated in an element name, the second or following occurrences SHOULD be removed. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd NM-005 49 Element, attribute and type names MUST be composed of words in the English language, using the primary English spellings provided in the Oxford English Dictionary, including office-specific tags (except see paragraph 57 below for acronyms). Examples: TradeMarkType, ColourClaimedText ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-006 50 Element names MUST be in upper camel case (UCC). UCC style capitalizes the first character of each word which compounds the name. Example: AddressCountryCode ../TM-XML_Image/MustIcon.jpg Must Icon rowodd NM-007 51 Type names MUST be in UCC + Suffix Type. Example : LanguageCodeType ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-008 52 Attribute names MUST be in lower camel case (LCC). LCC style capitalizes the first character of each word except the first word. Example: FeeAmount currencyCode=”EUR” ../TM-XML_Image/MustIcon.jpg Must Icon rowodd NM-009 54 A limit of 35 characters for a name is recommended ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven NM-010 45 Element, attribute and type names MUST be unique. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd NM-011 45 The names SHOULD be concise and SHOULD NOT contain consecutive redundant words, and MUST be as much as possible self-described and highly structured. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven NM-012 30 The characters used in type, element, or attribute names described in this Standard are restricted to the following set: {a-z, A-Z, 0-9, period (.), dash (-) and underscore (_)}. ../TM-XML_Image/ShouldNotIcon.jpg Should Not Icon rowodd NM-013 46 Element, attribute and type names and all their components MUST be in singular form unless the concept itself is plural. Examples: GoodsServices, TotalMarkSeries. ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-014 47 Element, attribute and type names MUST only contain nouns, adjectives and eventually verbs. Words like “and”, “of”, “the” MUST be removed. Example: GoodsServices. ../TM-XML_Image/MustIcon.jpg Must Icon rowodd NM-015 UCC & LCC Name must start with a letter (A-Z) and consist only of those characters included in the NMTOKEN datatype as defined in the W3C Schema definition. ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-016 Blank out – duplication of NM-022 rowodd NM-017 55 Element, attribute and type names MUST NOT include periods (.), spaces or other separators, or characters not allowed by W3C XML 1.0 for XML names except as specified in this Standard. For example, Office or domain prefixes (XX_UCC with XX in ST.3 code). Case 1: Country-Office or Domain prefix (XX_UCC with XX in ST3 code). ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-018 48 Element, attribute and type names MUST NOT be translated, changed or replaced for any purpose. ../TM-XML_Image/MustNotIcon.jpg Must Not Icon rowodd NM-019 53 Regarding the enumeration of values or code list text, it SHOULD be short but semantically sufficient and in English when there is no standard code list. The values and codes SHOULD be drawn from the common industrial property business language. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven NM-020 57 XML element, attribute and type names MUST NOT use acronyms, abbreviations, or other word truncations, except as specified in in the authorized list. Examples: URL, IPR. ../TM-XML_Image/MustNotIcon.jpg Must Not Icon rowodd NM-021 60 Acronyms MUST appear in all upper case for all element declarations and type definitions. ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-022 57 Abbreviations should not be used unless it is defined in the authorized abbreviations list for naming. ../TM-XML_Image/ShouldNotIcon.jpg Should Not Icon rowodd NM-023 58 The acronyms listed in the authorized acronym list MUST always be used instead of the complete extended name. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven NM-024 62 Schema and style sheet filenames are recommended to follow a six-part naming rule. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd NM-025 64 Schema file names SHOULD have their versions changed when an included modular schema is updated. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven NM-026 63 File names SHOULD follow the tag naming rules. However a mapping can be defined locally if the rules cannot be applied due to technical constraints. Such local rules MUST be well defined and published for all potential users. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd NM-027 To express a set of aggregated components or a collection of objects, a Set suffix (as an additional Representation Term) should be used. Examples: TradeMarkSet, SignatorySet. ../TM-XML_Image/MustIcon.jpg Must Icon roweven NM-028 58 When an abbreviation is defined in the authorized acronym list, it should always be used instead of the complete name. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowsection Design Rules rowodd DS-001 65 Restriction on field length MUST not be defined for the TM-XML Schema, but MAY be done for implementation schemas. ../TM-XML_Image/MustNotIcon.jpg Must Not Icon roweven DS-002 Element rather than Attribute must be used when the data is subject to extension. ../TM-XML_Image/MustIcon.jpg Must Icon rowodd DS-003 Attributes must be used only for metadata. Example: GoodsServicesDescription languageCode=”es” ../TM-XML_Image/MustIcon.jpg Must Icon roweven DS-004 66 The <any> element SHOULD be used to offer extension and to keep the TM-XML XML Schema (Appendix B) opened to additional elements. It MUST not be used in implementation schema. ../TM-XML_Image/MayIcon.jpg May Icon rowodd DS-005 64 Schema file names SHOULD have their versions changed when an included modular schema is updated. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven DS-006 67 Elements SHOULD be declared with occurrence indicators. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd DS-007 67 The occurrence indicators should not be declared explicitly when the required value is the default value. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven DS-008 68 The content or value within tags and attributes may be in any language, except enumerations. ../TM-XML_Image/MayIcon.jpg May Icon rowodd DS-009 36 All XML schemas MUST declare the W3C schema namespace. Schemas MUST declare a target namespace. ../TM-XML_Image/MustIcon.jpg Must Icon roweven DS-010 37 Namespace qualification MUST be used for W3C schema construct. ../TM-XML_Image/MustIcon.jpg Must Icon rowodd DS-011 The namespace prefixes below must be used : xs for W3C schema - XML Schema Definition bt for Business Type at for Additional Type mt for Message Type st for Standard Type ../TM-XML_Image/MustIcon.jpg Must Icon roweven DS-012 40 There SHALL be no default namespaces. That is, for example, both the XMLSchema and targetNamespace MUST be explicitly qualified. This approach, even though quite cluttered, is more consistent for all types of schema with no, one, or multiple targetNamespaces. ../TM-XML_Image/MayIcon.jpg May Icon rowodd DS-013 Postpone binding schema components to a namespace: Do not give schema a targetNamespace. Let schemas which include another one, which is with no targetNamespace, supply a targetNamespace when it is necessary. ../TM-XML_Image/MayIcon.jpg May Icon roweven DS-014 41 To hide or expose Namespaces in instance documents, use the binary switch attribute: elementFormDefault of the element <xsd:schema> (qualified or unqualified). ../TM-XML_Image/MayIcon.jpg May Icon rowodd DS-015 35 Every schema module, except internal schema modules, MUST have a namespace declared using the xsd:targetNamespace attribute. ../TM-XML_Image/MustIcon.jpg Must Icon roweven DS-016 42 External schema references SHOULD use the “Include” construct. The including and included schemas MUST have the same target namespace. Note: The including and included schemas having the same target namespace. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd DS-017 43 For simplicity, a single namespace configuration SHOULD be preferred. Multiple namespaces MAY be used for extension purposes (nationalization). ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven DS-018 40 For clarity, default namespaces must not be used. ../TM-XML_Image/MustNotIcon.jpg Must Not Icon rowodd DS-019 All attributes must be namespace qualified. ../TM-XML_Image/MustIcon.jpg Must Icon roweven DS-020 Include feature is reserved for the inclusion of TM-XML building blocks and Import feature is reserved for Office specific elements, attributes or types importation. ../TM-XML_Image/ShouldIcon.jpg Should Icon rowodd DS-021 Redefine technique should be avoided. ../TM-XML_Image/ShouldIcon.jpg Should Icon roweven DS-022 To maintain backward schema compliance, a new version may not apply the following changes: 1. Rename element or attribute 2. Adding required element or attribute 3. Changing the order of element 4. Removing element or attribute 5. Changing constraint to more restrictive: (a) Optional to required (b) Multiple to single occurrence (c) Pattern more restrictive ../TM-XML_Image/MayIcon.jpg May Icon