Ordenamiento de referencias en orden alfabético
This commit is contained in:
parent
50aa59c22b
commit
ec309957d1
318
README.md
318
README.md
|
|
@ -44,7 +44,7 @@ To better understad what YASD does, see the inputs and outputs:
|
|||
|
||||
## Structure
|
||||
|
||||
### General structure
|
||||
### General Structure
|
||||
|
||||
schema:
|
||||
SCHM
|
||||
|
|
@ -57,7 +57,7 @@ To better understad what YASD does, see the inputs and outputs:
|
|||
groups:
|
||||
- GRPS
|
||||
|
||||
### Schema (SCHM) structure
|
||||
### Schema (SCHM) Structure
|
||||
|
||||
elementFormDefault: qualified|unqualified
|
||||
targetNamespace: http://a.link
|
||||
|
|
@ -65,7 +65,7 @@ To better understad what YASD does, see the inputs and outputs:
|
|||
schemaLocation: http://a-link-to.xsd
|
||||
version: 0.1
|
||||
|
||||
### Element (ELMT) structure
|
||||
### Element (ELMT) Structure
|
||||
|
||||
name: element_name
|
||||
description: Element description
|
||||
|
|
@ -86,7 +86,7 @@ To better understad what YASD does, see the inputs and outputs:
|
|||
minOccurs: INTEGER
|
||||
...
|
||||
|
||||
### Attribute (ATTR) structure
|
||||
### Attribute (ATTR) Structure
|
||||
|
||||
name: attribute_name
|
||||
description: Attribute description
|
||||
|
|
@ -97,7 +97,7 @@ To better understad what YASD does, see the inputs and outputs:
|
|||
- CONSTRAIN
|
||||
...
|
||||
|
||||
### Group (GRPS) structure
|
||||
### Group (GRPS) Structure
|
||||
|
||||
name: group_name
|
||||
attribute_group: true|false
|
||||
|
|
@ -107,96 +107,46 @@ To better understad what YASD does, see the inputs and outputs:
|
|||
maxOccurs: INTEGER|unbounded
|
||||
minOccurs: INTEGER
|
||||
|
||||
## Reference
|
||||
## Key Reference
|
||||
|
||||
### `elementFormDefault`
|
||||
### `attribute_group`
|
||||
|
||||
Indicates that any elements used by the XML instance document which were
|
||||
declared in this schema must be namespace qualified.
|
||||
Indicates if group is an attribute group.
|
||||
|
||||
Optional; if not present by default is `unqualified`.
|
||||
Optional; if not present by default is `false`.
|
||||
|
||||
### `taget_namespace`
|
||||
Allowed values:
|
||||
|
||||
Indicates that the elements defined by this schema come from the specified URL
|
||||
namespace.
|
||||
- `true`.
|
||||
- `false`.
|
||||
|
||||
### `attributeElements`
|
||||
|
||||
Indicates attributes elements for schema.
|
||||
|
||||
Optional.
|
||||
|
||||
### `xmlns`
|
||||
### `attributes`
|
||||
|
||||
Indicates that the default namespace is the specified URL.
|
||||
Indicates a list of attributes for an element.
|
||||
|
||||
Mandatory.
|
||||
### `children_order`
|
||||
|
||||
### `schemaLocation`
|
||||
Indicates order indicators for children elements.
|
||||
|
||||
Indicates the location of the XML schema to use for that namespace.
|
||||
Mandatory in `no_text` or `mixed` elements, and group.
|
||||
|
||||
Optional.
|
||||
Allowed values:
|
||||
|
||||
### `version`
|
||||
- `all`. Children elements can occur in any order.
|
||||
- `choice`. Only one children element can accur.
|
||||
- `sequence`. Children elements must occur in specified order.
|
||||
|
||||
Indicates XML schema version.
|
||||
### `children`
|
||||
|
||||
Mandatory.
|
||||
Indicates a list of children elements.
|
||||
|
||||
### `name`
|
||||
|
||||
Indicates element, attribute or group name.
|
||||
|
||||
Mandatory.
|
||||
|
||||
For elements, its name is commonly known as tag name.
|
||||
|
||||
Naming rules:
|
||||
|
||||
- Element names are case-sensitive
|
||||
- Element names must start with a letter or underscore
|
||||
- Element names cannot start with the letters xml (or XML, or Xml, etc)
|
||||
- Element names can contain letters, digits, hyphens, underscores, and
|
||||
periods
|
||||
- Element names cannot contain spaces
|
||||
|
||||
### `ref`
|
||||
|
||||
References element or attribute by name.
|
||||
|
||||
Mandatory.
|
||||
|
||||
### `description`
|
||||
|
||||
Indicates element or attribute description in human readable form.
|
||||
|
||||
Optional.
|
||||
|
||||
### `type`
|
||||
|
||||
Indicates element type.
|
||||
|
||||
Mandatory.
|
||||
|
||||
Allowed types:
|
||||
|
||||
- `simple`. Only text node allowed.
|
||||
- `empty`. Only attributes allowed.
|
||||
- `no_text`. No children text nodes allowed.
|
||||
- `no_elements`. No children elements allowed.
|
||||
- `mixed`. Children elements, text node and attributes allowed.
|
||||
|
||||
Chart:
|
||||
|
||||
| type | elements | text | attributes |
|
||||
|-------------|:--------:|:----:|:----------:|
|
||||
| simple | ✗ | ✓ | ✗ |
|
||||
| empty | ✗ | ✗ | ✓ |
|
||||
| no_text | ✓ | ✗ | ✓ |
|
||||
| no_elements | ✗ | ✓ | ✓ |
|
||||
| mixed | ✓ | ✓ | ✓ |
|
||||
|
||||
> **Note 1**: read "elements" and "text" with "direct children..." as prefix.
|
||||
|
||||
> **Note 2**: attributes are never mandatory; they could be zero or more.
|
||||
Mandatory in `no_text` or `mixed` elements, and group.
|
||||
|
||||
### `datatype`
|
||||
|
||||
|
|
@ -276,6 +226,25 @@ Optional.
|
|||
|
||||
Only allowed for simple elements or attributes.
|
||||
|
||||
### `description`
|
||||
|
||||
Indicates element or attribute description in human readable form.
|
||||
|
||||
Optional.
|
||||
|
||||
### `elementFormDefault`
|
||||
|
||||
Indicates that any elements used by the XML instance document which were
|
||||
declared in this schema must be namespace qualified.
|
||||
|
||||
Optional; if not present by default is `unqualified`.
|
||||
|
||||
### `elements`
|
||||
|
||||
Indicates elements for schema.
|
||||
|
||||
Mandatory.
|
||||
|
||||
### `fixed`
|
||||
|
||||
Indicates fixed value to element or attribute.
|
||||
|
|
@ -284,17 +253,57 @@ Optional; ignored if 'default' is present.
|
|||
|
||||
Only allowed for simple elements or attributes.
|
||||
|
||||
### `use`
|
||||
### `group`
|
||||
|
||||
Indicates that the attribute is required.
|
||||
References group name.
|
||||
|
||||
Optional; if not present by default is `optional`.
|
||||
Optional.
|
||||
|
||||
Allowed uses:
|
||||
### `groups`
|
||||
|
||||
- `optional`.
|
||||
- `required`.
|
||||
- `prohibited`.
|
||||
Indicates element or attribute groups for schema.
|
||||
|
||||
Optional.
|
||||
|
||||
### `maxOccurs`
|
||||
|
||||
Indicates max number of times a children element can accur.
|
||||
|
||||
Optional; if not present by default is `1`.
|
||||
|
||||
Valid values are non negative integer or `unbounded` for unlimited number of
|
||||
times.
|
||||
|
||||
### `minOccurs`
|
||||
|
||||
Indicates min number of times a children element can accur.
|
||||
|
||||
Optional; if not present by default is `1`.
|
||||
|
||||
Valid value is non negative integer.
|
||||
|
||||
### `name`
|
||||
|
||||
Indicates element, attribute or group name.
|
||||
|
||||
Mandatory.
|
||||
|
||||
For elements, its name is commonly known as tag name.
|
||||
|
||||
Naming rules:
|
||||
|
||||
- Element names are case-sensitive
|
||||
- Element names must start with a letter or underscore
|
||||
- Element names cannot start with the letters xml (or XML, or Xml, etc)
|
||||
- Element names can contain letters, digits, hyphens, underscores, and
|
||||
periods
|
||||
- Element names cannot contain spaces
|
||||
|
||||
### `ref`
|
||||
|
||||
References element or attribute by name.
|
||||
|
||||
Mandatory.
|
||||
|
||||
### `restriction`
|
||||
|
||||
|
|
@ -329,86 +338,77 @@ Allowed constrains:
|
|||
carriage returns) is handled; accepted values are
|
||||
`preserve|replace|collapse`.
|
||||
|
||||
### `attributes`
|
||||
|
||||
Indicates a list of attributes for an element.
|
||||
|
||||
### `children_order`
|
||||
|
||||
Indicates order indicators for children elements.
|
||||
|
||||
Mandatory in `no_text` or `mixed` elements, and group.
|
||||
|
||||
Allowed values:
|
||||
|
||||
- `all`. Children elements can occur in any order.
|
||||
- `choice`. Only one children element can accur.
|
||||
- `sequence`. Children elements must occur in specified order.
|
||||
|
||||
### `children`
|
||||
|
||||
Indicates a list of children elements.
|
||||
|
||||
Mandatory in `no_text` or `mixed` elements, and group.
|
||||
|
||||
### `maxOccurs`
|
||||
|
||||
Indicates max number of times a children element can accur.
|
||||
|
||||
Optional; if not present by default is `1`.
|
||||
|
||||
Valid values are non negative integer or `unbounded` for unlimited number of
|
||||
times.
|
||||
|
||||
### `minOccurs`
|
||||
|
||||
Indicates min number of times a children element can accur.
|
||||
|
||||
Optional; if not present by default is `1`.
|
||||
|
||||
Valid value is non negative integer.
|
||||
|
||||
### `group`
|
||||
|
||||
References group name.
|
||||
|
||||
Optional.
|
||||
|
||||
### `groups`
|
||||
|
||||
Indicates element or attribute groups for schema.
|
||||
|
||||
Optional.
|
||||
|
||||
### `attribute_group`
|
||||
|
||||
Indicates if group is an attribute group.
|
||||
|
||||
Optional; if not present by default is `false`.
|
||||
|
||||
Allowed values:
|
||||
|
||||
- `true`.
|
||||
- `false`.
|
||||
|
||||
### `elements`
|
||||
|
||||
Indicates elements for schema.
|
||||
|
||||
Mandatory.
|
||||
|
||||
### `attributeElements`
|
||||
|
||||
Indicates attributes elements for schema.
|
||||
|
||||
Optional.
|
||||
|
||||
### `schema`
|
||||
|
||||
Indicates schema general information.
|
||||
|
||||
Mandatory.
|
||||
|
||||
### `schemaLocation`
|
||||
|
||||
Indicates the location of the XML schema to use for that namespace.
|
||||
|
||||
Optional.
|
||||
|
||||
### `taget_namespace`
|
||||
|
||||
Indicates that the elements defined by this schema come from the specified URL
|
||||
namespace.
|
||||
|
||||
Optional.
|
||||
|
||||
### `type`
|
||||
|
||||
Indicates element type.
|
||||
|
||||
Mandatory.
|
||||
|
||||
Allowed types:
|
||||
|
||||
- `simple`. Only text node allowed.
|
||||
- `empty`. Only attributes allowed.
|
||||
- `no_text`. No children text nodes allowed.
|
||||
- `no_elements`. No children elements allowed.
|
||||
- `mixed`. Children elements, text node and attributes allowed.
|
||||
|
||||
Chart:
|
||||
|
||||
| type | elements | text | attributes |
|
||||
|-------------|:--------:|:----:|:----------:|
|
||||
| simple | ✗ | ✓ | ✗ |
|
||||
| empty | ✗ | ✗ | ✓ |
|
||||
| no_text | ✓ | ✗ | ✓ |
|
||||
| no_elements | ✗ | ✓ | ✓ |
|
||||
| mixed | ✓ | ✓ | ✓ |
|
||||
|
||||
> **Note 1**: read "elements" and "text" with "direct children..." as prefix.
|
||||
|
||||
> **Note 2**: attributes are never mandatory; they could be zero or more.
|
||||
|
||||
### `use`
|
||||
|
||||
Indicates that the attribute is required.
|
||||
|
||||
Optional; if not present by default is `optional`.
|
||||
|
||||
Allowed uses:
|
||||
|
||||
- `optional`.
|
||||
- `required`.
|
||||
- `prohibited`.
|
||||
|
||||
### `version`
|
||||
|
||||
Indicates XML schema version.
|
||||
|
||||
Mandatory.
|
||||
|
||||
### `xmlns`
|
||||
|
||||
Indicates that the default namespace is the specified URL.
|
||||
|
||||
Mandatory.
|
||||
|
||||
## References
|
||||
|
||||
- "XML Schema Reference", [W3ref]
|
||||
|
|
|
|||
Loading…
Reference in New Issue