Changes between Version 1 and Version 2 of LibYAML

Timestamp:

05/16/06 12:18:57 (7 years ago)

Author:

xi

Comment:

--

LibYAML

@@ -7 +7 @@
 == Scope ==
 
-LibYAML covers ''presenting'' and ''parsing'' processes (see http://yaml.org/spec/cvs/current.html#id859458).
+LibYAML covers ''presenting'' and ''parsing'' [http://yaml.org/spec/cvs/current.html#id859458 processes].
 Thus LibYAML defines the following two processors:
 
@@ -24 +24 @@
 
 == Events ==
+
+=== Event Types ===
 
 The Parser produces while the Emitter accepts the following types of events:
@@ -46 +48 @@
 mapping ::= MAPPING-START (node node)* MAPPING-END
 }}}
+
+=== Essential Event Attributes ===
+
+The following attributes affect the intepretation of a YAML document.
+
+ * `ALIAS`
+   * `anchor` - the alias anchor; `[0-9a-zA-Z_-]+`; not `NULL`.
+ * `SCALAR`
+   * `anchor` - the node anchor; `[0-9a-zA-Z_-]+`; may be `NULL`.
+   * `tag` - the node tag; should either start with `!` (local tag) or be a valid URL (global tag);
+     may be `NULL` or `!` in which case either `plain_implicit` or `quoted_implicit` should be `True`.
+   * `plain_implicit` - `True` if the node tag may be omitted whenever the scalar value
+     is presented in the plain style.
+   * `quoted_implicit` - `True` if the node tag may be omitted whenever the scalar value
+     is presented in any non-plain style.
+   * `value` - the scalar value; a valid utf-8 sequence; `NULL` means empty.
+ * `SEQUENCE-START`
+   * `anchor` - the node anchor; `[0-9a-zA-Z_-]+`; may be `NULL`.
+   * `tag` - the node tag; should either start with `!` (local tag) or be a valid URL (global tag);
+     may be `NULL` or `!` in which case `implicit` should be `True`.
+   * `implicit` - `True` if the node tag may be omitted.
+ * `MAPPING-START`
+   * `anchor` - the node anchor; `[0-9a-zA-Z_-]+`; may be `NULL`.
+   * `tag` - the node tag; should either start with `!` (local tag) or be a valid URL (global tag);
+     may be `NULL` or `!` in which case `implicit` should be `True`.
+   * `implicit` - `True` if the node tag may be omitted.
+
+=== Stylistic Event Attributes ===
+
+The following attributes don't affect the interpretation of a YAML document. While parsing a YAML
+document, an application should not consider these attributes for resolving implicit tags and
+constructing representation graphs or native objects. The Emitter may ignore these attributes
+if they cannot be satisfied.
+
+ * `STREAM-START`
+   * `encoding` - the document encoding; `utf-8|utf-16-le|utf-16-be`.
+ * `DOCUMENT-START`
+   * `version` - the version specified with the `%YAML` directive; the only valid value is `1.1`; may be `NULL`.
+   * `tag` - a set of tag handles and the corresponding tag prefixes specified with the `%TAG` directive;
+     tag handles should match `!|!!|![0-9a-zA-Z_-]+!` while tag prefixes should be prefixes of valid local
+     or global tags; may be `NULL`.
+   * `implicit` - `True` if the document start indicator `---` is not present.
+ * `DOCUMENT-END`
+   * `implicit` - `True` if the document end indicator `...` is not present.
+ * `SCALAR`
+   * `style` - the value style; `plain|single-quoted|double-quoted|literal|folded`.
+ * `SEQUENCE-START`
+   * `style` - the sequence style; `block|flow`.
+ * `MAPPING-START`
+   * `style` - the mapping style; `block|flow`.
+ * ''any event''
+   * `start_mark` - the position of the event beginning; `offset` (in bytes), `index` (in characters),
+     `line` and `column` (starting from `0`).
+   * `end_mark` - the position of the event end; `offset` (in bytes), `index` (in characters),
+     `line` and `column` (starting from `0`).