XML Naming and Design Rules Version 2.0, 17 February 2006 XML XML Naming And Design Rules V2.0.doc Page 1 1 Status of this Documents This UN/CEFACT Technical Specification has been developed in accordance with the UN/CEFACT/TRADE/22 Open Development Process (ODP) for Technical Specifications. It has been approved by the United Nations Centre for Trade Facilitation and Electronic Business (UN/CEFACT) Applied Techniques Group (ATG) for promulgation as a UN/CEFACT standard in accordance with Step 7 of the ODP. Distribution of this document is unlimited. The document formatting is based on the Internet Society’s Standard RFC format. This version: XML Naming and Design Rules, Version 2.0 of 17 February 2006 Previous version: XML Naming and Design Rules, Version 2.0 of 20 January 2006 (Candidate) Document identifier: NamingAndDesignRules_2.0.doc Location: http://www.disa.org/cefact-groups/atg/downloads/index.cfm XML XML Naming And Design Rules V2.0.doc Page 2 2 UN/CEFACT – XML Naming and Design Rules Project Team Participants We would like to recognise the following for their significant participation to the development of this Technical Specification. Project Team Leader: Mark Crawford SAP Labs U.S. Lead Editor: Paula Heilig Worldspan Editors: Gunther Stuhec SAP AG Margaret Pemberton Diskray Garret Minakawa Oracle/OAGI Contributors: Hisanao Sugamata ECOM-Japan Frank Lin GCOM K.K. Suen EAN Hong Kong Luc Mouchot CNAM-TS Thomas Bikeev EAN.UCC Jostein Frømyr EDISYS Sue Probert SEPIA eb Alain Dechamps CEN Michael Dill GEFEG 2.1 Acknowledgements The UN/CEFACT - XML Naming and Design Rules were developed in close coordination with other XML standards efforts. In particular, the OASIS Universal Business Language Technical Committee Naming and Design Rules were instrumental in developing this document. Additionally, contributions were also received from: SWIFT U.S. Department of the Navy U.S. Environmental Protection Agency U.S. Federal CIO Council XML Working Group OpenTravel Alliance Australian Electricity & Gas Industry CIDX EAN/UCC European Transmission System Operators PIDX XML XML Naming And Design Rules V2.0.doc Page 3 3 Table of Contents 1 STATUS OF THIS DOCUMENTS......................................................................................... 2 2 UN/CEFACT – XML NAMING AND DESIGN RULES PROJECT TEAM PARTICIPANTS.3 2.1 Acknowledgements .............................................................................................................................3 3 TABLE OF CONTENTS ........................................................................................................ 4 4 INTRODUCTION ................................................................................................................... 8 4.1 Scope and Focus..................................................................................................................................8 4.2 Audience ..............................................................................................................................................8 4.3 Structure of this Specification ...........................................................................................................8 4.4 Terminology and Notation.................................................................................................................9 4.5 Related Documents.............................................................................................................................9 4.6 Conformance.......................................................................................................................................9 4.7 Guiding Principles ..............................................................................................................................9 5 GENERAL XML CONSTRUCT........................................................................................... 11 5.1 Overall Schema Structure................................................................................................................11 5.2 Relationship to the CCTS ................................................................................................................11 5.2.1 CCTS..................................................................................................................................................11 5.2.2 Business Information Entities.............................................................................................................12 5.2.3 The XML Constructs..........................................................................................................................13 5.3 Naming and Modelling Constraints ................................................................................................15 5.3.1 Element Naming Conventions............................................................................................................17 5.4 Reusability Scheme...........................................................................................................................17 5.5 Modularity Model.............................................................................................................................19 5.5.1 Root Schema.......................................................................................................................................20 5.5.2 Internal Schema ..................................................................................................................................21 5.5.3 External Schema.................................................................................................................................21 5.6 Namespace Scheme...........................................................................................................................24 5.6.1 UN/CEFACT Namespace Scheme .....................................................................................................25 5.6.2 Declaring Namespace.........................................................................................................................26 5.6.3 Namespace Persistence.......................................................................................................................26 5.6.4 Namespace Uniform Resource Identifiers..........................................................................................26 5.6.5 Namespace Constraint ........................................................................................................................27 5.6.6 UN/CEFACT XSD Schema Namespace Tokens ...............................................................................27 XML XML Naming And Design Rules V2.0.doc Page 4 5.7 Schema Location...............................................................................................................................28 5.8 Versioning .........................................................................................................................................28 5.8.1 Major Versions ...................................................................................................................................28 5.8.2 Minor Versions...................................................................................................................................29 6 GENERAL XML SCHEMA LANGUAGE CONVENTIONS................................................. 30 6.1 Schema Construct.............................................................................................................................30 6.1.1 Constraints on Schema Construction..................................................................................................30 6.2 Attribute and Element Declarations ...............................................................................................30 6.2.1 Attributes ............................................................................................................................................30 6.2.2 Elements .............................................................................................................................................31 6.3 Type Definitions................................................................................................................................32 6.3.1 Usage of Types ...................................................................................................................................32 6.3.2 Simple Type Definitions.....................................................................................................................32 6.3.3 Complex Type Definitions .................................................................................................................32 6.4 Use of XSD Extension and Restriction............................................................................................33 6.4.1 Extension ............................................................................................................................................33 6.4.2 Restriction...........................................................................................................................................33 6.5 Annotation.........................................................................................................................................33 6.5.1 Documentation ...................................................................................................................................33 7 XML SCHEMA MODULES.................................................................................................