Skip to content

Commit 582c8db

Browse files
committed
Update schema naming conventions
1 parent 08f1e39 commit 582c8db

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

schema_naming_conventions.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# ODM XML v2 Schema Naming Conventions
22

3-
This document defines naming conventions for the ODM v2 schema. The names and case sensitivity of the XML elements, attributes and types from other standards used by ODM v2 are governed by their respective standards. For example, *complexType* is the name defined by XML Schema. The names from the vendor extensions are not governed by this. However, it is recommended that they follow this naming convention.
3+
This document defines naming conventions for the ODM v2 XML schema. The names and case sensitivity of the XML elements, attributes and types from other standards used by ODM v2 are governed by their respective standards. For example, *complexType* is the name defined by XML Schema. The names from the vendor extensions are not governed by this. However, it is recommended that they follow this naming convention.
44

55
## Case Sensitivity
66

7-
All names defined by ODMv2 are case sensitive.
7+
All names defined by ODM v2 are case sensitive.
88

99
## Element and Attribute Names
1010

11-
ODMv2 element and attribute names use pascal case. Pascal case requires the first letter in the name and the first letter of each subsequent concatenated word to be capitalized, for example, *GlobalVariables*. There are some exceptions allowed in order to maintain backward compatibility, for example, *MetaDataVersion* element. Sometimes the names need to contain acronyms, for example *ODM* or *StudyOID*. Acronyms in the *ODM* element and attribute names are always written in upper case.
11+
ODM v2 element and attribute names use Pascal case. Pascal case requires the first letter in the name and the first letter of each subsequent concatenated word to be capitalized, for example, *GlobalVariables*. There are some exceptions allowed in order to maintain backward compatibility, for example, *MetaDataVersion* element. Sometimes the names need to contain acronyms, for example *ODM* or *StudyOID*. Acronyms in the *ODM* element or attribute names are always written in upper case.
1212

1313
## Namespace prefix
1414

15-
The namespace prefixes are in lower case.
16-
17-
The following table contains the ODMv2 namespaces with their prefixes
15+
The namespace prefixes are in lower case. The namespaces used in ODM v2 and their prefixes are shown in the following table:
1816

1917
| Namespace URI | Prefix |
2018
|----------------------------------------------------|---------|
@@ -28,4 +26,4 @@ The following table contains the ODMv2 namespaces with their prefixes
2826

2927
## Type Name
3028

31-
Type names use pascal case in the majority of cases. Camel case is used to override the standard xml types or, in some cases, for historical reasons, such as *datetime* and *repeatKey*.
29+
Type names use Pascal case in most cases. Camel case is used to override the standard xml types and some types due to historical reasons such as *datetime* and *repeatKey*.

0 commit comments

Comments
 (0)