Chapter 3 of the specification contains the description of the repository schema. The first 4 subchapters (3.1-3.4) define the root element and global elements such as pedigree and annotations. Some of the subchapters of Chapters 3.1-3.4 are proposed to be moved further down (see below). The subsequent chapters 3.5-3.12 describe the main elements types, some of them in their own section (e.g. fields) and others in a message context (e.g. components).
The proposal is to reorder and refactor these subchapters to start with the smallest element (datatypes) and end with the largest element (sections). Higher-level features should come after that and be ordered by complexity.
Furthermore, the concept of scenarios should be described in a single subchapter at the end and not as integral part of the individual element descriptions. This should make it easier for a beginner to get a basic understanding of Orchestra.
The new order is proposed as follows (they could also be partially grouped, e.g. into basic and advanced topics):
- Datatypes
- Code Sets
- Fields
- Components
- Groups
- Messages
- Categories (from Chapter 3.3.1)
- Sections (from Chapter 3.3.1)
- Member Presence
- Expressions
- Naming Rules (from Chapter 3.2.3)
- Support for XInclude (from Chapter 3.1.4)
- Scenarios
- Workflows
- Semantic Concepts
Chapter 3 of the specification contains the description of the repository schema. The first 4 subchapters (3.1-3.4) define the root element and global elements such as pedigree and annotations. Some of the subchapters of Chapters 3.1-3.4 are proposed to be moved further down (see below). The subsequent chapters 3.5-3.12 describe the main elements types, some of them in their own section (e.g. fields) and others in a message context (e.g. components).
The proposal is to reorder and refactor these subchapters to start with the smallest element (datatypes) and end with the largest element (sections). Higher-level features should come after that and be ordered by complexity.
Furthermore, the concept of scenarios should be described in a single subchapter at the end and not as integral part of the individual element descriptions. This should make it easier for a beginner to get a basic understanding of Orchestra.
The new order is proposed as follows (they could also be partially grouped, e.g. into basic and advanced topics):