root/trunk/spec/type.dbk

Revision 7, 8.6 KB (checked in by oren, 8 months ago)

April 06, 2008 draft.

Implemented by YamlReference? 0.9.

Contains new productions, new examples, all the changes collected throughout
the last 3 years, and of course JSON compatibility.
Line 
1<?xml version="1.0"?>
2<!DOCTYPE article
3  PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6<article>
7  <articleinfo>
8    <title>
9      Language-Independent Types for
10      <trademark>YAML</trademark>&nbsp;Version&nbsp;1.1
11    </title>
12
13    <subtitle>Last Updated On 2005-01-18</subtitle>
14
15    <copyright>
16      <year>2001-2005</year>
17      <holder>Oren Ben-Kiki<fo>,&nbsp;</fo></holder>
18      <holder>Clark Evans<fo>,&nbsp;</fo></holder>
19      <holder>Brian Ingerson</holder>
20    </copyright>
21
22    <legalnotice>
23      This document may be freely copied provided it is not modified.
24    </legalnotice>
25  </articleinfo>
26
27  <section>
28    <title>Introduction</title>
29
30    <para>
31      The following is the list of language-independent YAML tags defined under
32      the domain <userinput>yaml.org</userinput>. The use of these tags is not
33      mandatory. However these tags represent types that are useful across a
34      wide range of applications and it is strongly recommended they be used
35      whenever appropriate to promote interoperability.
36    </para>
37
38    <para>
39      New language-independent tags may be proposed on the <ulink
40      url="http://lists.sourceforge.net/lists/listinfo/yaml-core">yaml-core
41      mailing list</ulink>. This mailing list is also the forum for raising any
42      question regarding these types.
43    </para>
44  </section>
45
46  <section>
47    <title>Collection Types</title>
48
49    <variablelist>
50      <varlistentry>
51        <term>
52          <para>
53            <userinput>!!map</userinput>
54            <ulink url="http://yaml.org/type/map.html">html</ulink>
55            <ulink url="http://yaml.org/type/map.pdf">pdf</ulink>
56            <ulink url="http://yaml.org/type/map.ps">ps</ulink>
57          </para>
58        </term>
59
60        <listitem>
61          <para>
62            Unordered set of key:&nbsp;value pairs without duplicates.
63          </para>
64        </listitem>
65      </varlistentry>
66
67      <varlistentry>
68        <term>
69          <para>
70            <userinput>!!omap</userinput>
71            <ulink url="http://yaml.org/type/omap.html">html</ulink>
72            <ulink url="http://yaml.org/type/omap.pdf">pdf</ulink>
73            <ulink url="http://yaml.org/type/omap.ps">ps</ulink>
74          </para>
75        </term>
76
77        <listitem>
78          <para>
79            Ordered sequence of key:&nbsp;value pairs without duplicates.
80          </para>
81        </listitem>
82      </varlistentry>
83
84      <varlistentry>
85        <term>
86          <para>
87            <userinput>!!pairs</userinput>
88            <ulink url="http://yaml.org/type/pairs.html">html</ulink>
89            <ulink url="http://yaml.org/type/pairs.pdf">pdf</ulink>
90            <ulink url="http://yaml.org/type/pairs.ps">ps</ulink>
91          </para>
92        </term>
93
94        <listitem>
95          <para>
96            Ordered sequence of key:&nbsp;value pairs allowing duplicates.
97          </para>
98        </listitem>
99      </varlistentry>
100
101      <varlistentry>
102        <term>
103          <para>
104            <userinput>!!set</userinput>
105            <ulink url="http://yaml.org/type/set.html">html</ulink>
106            <ulink url="http://yaml.org/type/set.pdf">pdf</ulink>
107            <ulink url="http://yaml.org/type/set.ps">ps</ulink>
108          </para>
109        </term>
110
111        <listitem>
112          <para>
113            Unordered set of non-equal values.
114          </para>
115        </listitem>
116      </varlistentry>
117
118      <varlistentry>
119        <term>
120          <para>
121            <userinput>!!seq</userinput>
122            <ulink url="http://yaml.org/type/seq.html">html</ulink>
123            <ulink url="http://yaml.org/type/seq.pdf">pdf</ulink>
124            <ulink url="http://yaml.org/type/seq.ps">ps</ulink>
125          </para>
126        </term>
127
128        <listitem>
129          <para>
130            Sequence of arbitrary values.
131          </para>
132        </listitem>
133      </varlistentry>
134    </variablelist>
135  </section>
136
137  <section>
138    <title>Scalar Types</title>
139
140    <variablelist>
141      <varlistentry>
142        <term>
143          <para>
144            <userinput>!!binary</userinput>
145            <ulink url="http://yaml.org/type/binary.html">html</ulink>
146            <ulink url="http://yaml.org/type/binary.pdf">pdf</ulink>
147            <ulink url="http://yaml.org/type/binary.ps">ps</ulink>
148          </para>
149        </term>
150
151        <listitem>
152          <para>
153            A sequence of zero or more octets (8 bit values).
154          </para>
155        </listitem>
156      </varlistentry>
157
158      <varlistentry>
159        <term>
160          <para>
161            <userinput>!!bool</userinput>
162            <ulink url="http://yaml.org/type/bool.html">html</ulink>
163            <ulink url="http://yaml.org/type/bool.pdf">pdf</ulink>
164            <ulink url="http://yaml.org/type/bool.ps">ps</ulink>
165          </para>
166        </term>
167
168        <listitem>
169          <para>
170            Mathematical Booleans.
171          </para>
172        </listitem>
173      </varlistentry>
174
175      <varlistentry>
176        <term>
177          <para>
178            <userinput>!!float</userinput>
179            <ulink url="http://yaml.org/type/float.html">html</ulink>
180            <ulink url="http://yaml.org/type/float.pdf">pdf</ulink>
181            <ulink url="http://yaml.org/type/float.ps">ps</ulink>
182          </para>
183        </term>
184
185        <listitem>
186          <para>
187            Floating-point approximation to real numbers.
188          </para>
189        </listitem>
190      </varlistentry>
191
192      <varlistentry>
193        <term>
194          <para>
195            <userinput>!!int</userinput>
196            <ulink url="http://yaml.org/type/int.html">html</ulink>
197            <ulink url="http://yaml.org/type/int.pdf">pdf</ulink>
198            <ulink url="http://yaml.org/type/int.ps">ps</ulink>
199          </para>
200        </term>
201
202        <listitem>
203          <para>
204            Mathematical integers.
205          </para>
206        </listitem>
207      </varlistentry>
208
209      <varlistentry>
210        <term>
211          <para>
212            <userinput>!!merge</userinput>
213            <ulink url="http://yaml.org/type/merge.html">html</ulink>
214            <ulink url="http://yaml.org/type/merge.pdf">pdf</ulink>
215            <ulink url="http://yaml.org/type/merge.ps">ps</ulink>
216          </para>
217        </term>
218
219        <listitem>
220          <para>
221            Specify one or more mappings to be merged with the current one.
222          </para>
223        </listitem>
224      </varlistentry>
225
226      <varlistentry>
227        <term>
228          <para>
229            <userinput>!!null</userinput>
230            <ulink url="http://yaml.org/type/null.html">html</ulink>
231            <ulink url="http://yaml.org/type/null.pdf">pdf</ulink>
232            <ulink url="http://yaml.org/type/null.ps">ps</ulink>
233          </para>
234        </term>
235
236        <listitem>
237          <para>
238            Devoid of value.
239          </para>
240        </listitem>
241      </varlistentry>
242
243      <varlistentry>
244        <term>
245          <para>
246            <userinput>!!str</userinput>
247            <ulink url="http://yaml.org/type/str.html">html</ulink>
248            <ulink url="http://yaml.org/type/str.pdf">pdf</ulink>
249            <ulink url="http://yaml.org/type/str.ps">ps</ulink>
250          </para>
251        </term>
252
253        <listitem>
254          <para>
255            A sequence of zero or more Unicode characters.
256          </para>
257        </listitem>
258      </varlistentry>
259
260      <varlistentry>
261        <term>
262          <para>
263            <userinput>!!timestamp</userinput>
264            <ulink url="http://yaml.org/type/timestamp.html">html</ulink>
265            <ulink url="http://yaml.org/type/timestamp.pdf">pdf</ulink>
266            <ulink url="http://yaml.org/type/timestamp.ps">ps</ulink>
267          </para>
268        </term>
269
270        <listitem>
271          <para>
272            A point in time.
273          </para>
274        </listitem>
275      </varlistentry>
276
277      <varlistentry>
278        <term>
279          <para>
280            <userinput>!!value</userinput>
281            <ulink url="http://yaml.org/type/value.html">html</ulink>
282            <ulink url="http://yaml.org/type/value.pdf">pdf</ulink>
283            <ulink url="http://yaml.org/type/value.ps">ps</ulink>
284          </para>
285        </term>
286
287        <listitem>
288          <para>
289            Specify the default value of a mapping.
290          </para>
291        </listitem>
292      </varlistentry>
293
294      <varlistentry>
295        <term>
296          <para>
297            <userinput>!!yaml</userinput>
298            <ulink url="http://yaml.org/type/yaml.html">html</ulink>
299            <ulink url="http://yaml.org/type/yaml.pdf">pdf</ulink>
300            <ulink url="http://yaml.org/type/yaml.ps">ps</ulink>
301          </para>
302        </term>
303
304        <listitem>
305          <para>
306            Keys for encoding YAML in YAML.
307          </para>
308        </listitem>
309      </varlistentry>
310    </variablelist>
311  </section>
312</article>
Note: See TracBrowser for help on using the browser.