-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
eml-text.xsd
497 lines (485 loc) · 31.4 KB
/
eml-text.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
xmlns="eml://ecoinformatics.org/text-2.2.0"
xmlns:txt="eml://ecoinformatics.org/text-2.2.0"
xmlns:doc="eml://ecoinformatics.org/documentation-2.2.0"
xmlns:res="eml://ecoinformatics.org/resource-2.2.0"
targetNamespace="eml://ecoinformatics.org/text-2.2.0">
<xs:import namespace="eml://ecoinformatics.org/documentation-2.2.0" schemaLocation="eml-documentation.xsd"/>
<xs:import namespace="eml://ecoinformatics.org/resource-2.2.0" schemaLocation="eml-resource.xsd"/>
<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="xml.xsd"/>
<xs:annotation>
<xs:documentation>
'$RCSfile: eml-text.xsd,v $'
Copyright: 1997-2002 Regents of the University of California,
University of New Mexico, and
Arizona State University
Sponsors: National Center for Ecological Analysis and Synthesis and
Partnership for Interdisciplinary Studies of Coastal Oceans,
University of California Santa Barbara
Long-Term Ecological Research Network Office,
University of New Mexico
Center for Environmental Studies, Arizona State University
Other funding: National Science Foundation (see README for details)
The David and Lucile Packard Foundation
For Details: http://knb.ecoinformatics.org/
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</xs:documentation>
<xs:appinfo>
<doc:moduleDocs>
<doc:moduleName>eml-text</doc:moduleName>
<doc:moduleDescription>
<section xmlns="">
<title>The eml-text module - Text field formatting</title>
</section>
</doc:moduleDescription>
<doc:recommendedUsage>any module</doc:recommendedUsage>
<doc:standAlone>no</doc:standAlone>
</doc:moduleDocs>
</xs:appinfo>
</xs:annotation>
<xs:element name="text" type="TextType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Text</doc:tooltip>
<doc:summary>A simple text desription.</doc:summary>
<doc:description>The "text" element allows for both formatted and unformatted text blocks to be included in EML. It can contain a number of relevant subsections that allow the use of titles, sections, and paragraphs in the text block. The structured elements can be specified using a subset of <ulink url="http://www.docbook.org">DocBook</ulink> so the predefined DocBook stylesheets can be used to style EML fields that implement this module, or alternatively can be specified using Markdown text blocks.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:complexType name="TextType" mixed="true">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Text</doc:tooltip>
<doc:summary>A simple text desription.</doc:summary>
<doc:description>The "text" element allows for both formatted and unformatted text blocks to be included in EML. It can contain a number of relevant subsections that allow the use of titles, sections, and paragraphs in the text block. This markup is a subset of DocBook, or alternatively can be specified using Markdown text blocks.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:choice maxOccurs="unbounded">
<xs:element name="section" type="SectionType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Section</doc:tooltip>
<doc:summary>A section of related text.</doc:summary>
<doc:description>The "section" element allows for grouping related paragraphs of text together, with an optional title. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="para" type="ParagraphType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Paragraph</doc:tooltip>
<doc:summary>A simple paragraph of text.</doc:summary>
<doc:description>The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, and lists. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="markdown" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Markdown</doc:tooltip>
<doc:summary>A block of text formatted with Markdown directives.</doc:summary>
<doc:description>
<para>
Markdown is a family of text-based formatting directives that can be used to
structure and format a block of text. A single markdown element in EML can contain multiple
formatting directives that support creation of sections and subsections with headings, a
wide variety of text formatting directives, the ability to include inline links to external
content, and the ability to embed inline citations, figures, and tables. EML's markdown element
follows the <ulink url="https://github.github.com/gfm/">GitHub Flavored Markdown (GFM)</ulink> extensions to the <ulink url="http://spec.commonmark.org/">CommonMark specification</ulink>. Clients that
display EML should use a markdown preprocessor to convert the Markdown formatting into an
appropriate display format such as HTML or PDF as appropriate. When a Markdown block is interleaved
with other blocks of text such as section and paragraph elements from Docbook, the Markdown section
should be interleaved as a block-level element in the flow of the document. This allows authors to
specify, for example, an initial section in DocBook, followed by a Markdown section, and then possibly
other sections in DocBook. This will likely be uncommon because Markdown and Docbook have similar
formatting capabilities, but it may be helpful when converting legacy documents that use DocBook.
</para>
<para>
Because markdown uses special characters that might be reserved by XML processors, one
must be careful to escape such characters, which is typically done by embedding the
text in a CDATA block, or other XML escaping measures. These escape sequences must be
unescaped before parsing the text with a Markdown processor.
</para>
<para>
Within a Markdown block, one can use embedded images to specify the location where an inline image
should be displayed within the document. For example, the syntax for an embedded image uses the
markdown reference syntax, for example <code>![Figure 1][fig.1.ab567w]</code>, where "fig.1.ab567w"
is the unique <code>id</code> attribute for the entity containing the reference to the image. When
client tools process such image links, they should inline the image data from that entity at the
location specified, which may involve, for example, resolving the image url from an
<code>otherEntity</code> section. This means that there is an implied link in all Markdown
documents of the form <code>[id]: url/to/image "Optional title attribute"</code>, which is derived
from the metadata for each entity within a document. Users do not need to insert these links in
order to use them, but client software that might be generating HTML from the markdown will likely
need to generate them from the entity metadata if they are using an external Markdown pre-processor
to handle conversion to HTML and other languages.
</para>
<para>
Inline citations can also be used to cite scholarly works in the text of an EML
document. This follows the Pandoc syntax for citation keys, in which the citation keys
are in inside square brackets and separated by semicolons. Each citation is identified
by a key, which consists of an ‘@’ symbol and the citation identifier from the entry for
that citation. Citation keys may optionally have a prefix, a locator, and a suffix to
further qualify what is being cited. For example, a simple citation would be
constructed as '[@fegraus_2005]', and a list would be '[@jones_2001; @fegraus_2005]'.
The keys must be present in either the 'id' field of a
citation element in the EML document, or as the BibTex key in a 'bibtex' entry in the
EML document. It is a validation error to cite an entry for which the corresponding
citation key is not present in the EML document, and it is a validation error for the
same citation key to be reused across citation and bibtex elements in the document (each
citation identifier must be unique within the document). Clients that parse and display
EML documents should first gather up all citation and bibtex elements in the document to
create a citation database in bibtext format, and then pass that database along with the
text in markdown sections to pandoc or an equivalent tool to convert the citations into
properly formatted, human readable citations. Pandoc supports the use of Citation Style
Language (CSL) files to specify the formatting of citations upon conversion. See
http://citationstyles.org/ for more details.
</para>
<para>
Because bulleted lists and other structures within Markdown are dependent on indenting the raw
markdown text, authors and processors should pay close attention to formatting within the
markdown block. In particular, if the XML document within which the markdown block is embedded
is in an indented hierarchy, then the first non-whitespace character of the markdown block defines
the column for the leftmost column of the markdown, and all subsequent markdown should be indented
relative to that column. For example, if the first character of the markdown is in column 16
of the document, then all subsequent markdown lines in that block should also start on column 16.
A bulleted list would start on column 16, and its sublist would be indented four space to column 20.
</para>
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="res:NonEmptyStringType">
<!--
<xs:attribute name="syntax" type="i18nNonEmptyStringType" use="optional">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>url</doc:tooltip>
<doc:summary>the Uniform Resource Locator for the cited work</doc:summary>
<doc:description>the url attribute contains the location of the work for a link. This markup is a subset of DocBook.</doc:description>
<doc:example>url="http://dublincore.org/documents/usageguide/"</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
-->
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:choice>
<xs:attribute ref="xml:lang"/>
</xs:complexType>
<xs:complexType name="ParagraphType" mixed="true">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Paragraph</doc:tooltip>
<doc:summary>A simple paragraph of text.</doc:summary>
<doc:description>The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, lists and links. This
markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="value" type="i18nString" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Localized string for the paragraph</doc:tooltip>
<doc:summary>Language translation for the paragraph</doc:summary>
<doc:description>Language translation as specified by the xml:lang attribute</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="itemizedlist" type="ListType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Itemized List</doc:tooltip>
<doc:summary>A list of items in a text paragraph.
</doc:summary>
<doc:description>A list of items in a text paragraph. The list is generally displayed as a bulleted list. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="orderedlist" type="ListType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Ordered List</doc:tooltip>
<doc:summary>An ordered list of items in a text paragraph.
</doc:summary>
<doc:description>An ordered list of items in a text paragraph. The list is generally displayed as a numbered list. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="emphasis">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Emphasis</doc:tooltip>
<doc:summary>A span of emphasized text in a paragraph.</doc:summary>
<doc:description>A span of emphasized text in a paragraph. Emphasized text is generally rendered as boldfaced or otherwise distinct from the surrounding text. This markup is a subset of DocBook.</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType mixed="true">
<xs:sequence>
<xs:element name="value" type="i18nString" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute ref="xml:lang"/>
</xs:complexType>
</xs:element>
<xs:element name="subscript" type="SubSuperScriptType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Subscript</doc:tooltip>
<doc:summary>A subscript in a text paragraph.</doc:summary>
<doc:description>A subscript in a text paragraph. This markup is a subset of DocBook.</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="superscript" type="SubSuperScriptType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Superscript</doc:tooltip>
<doc:summary>A superscript in a text paragraph.</doc:summary>
<doc:description>A superscript in a text paragraph. This markup is a subset of DocBook.</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="literalLayout">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>literalLayout</doc:tooltip>
<doc:summary>The equivalent to <pre> in html.</doc:summary>
<doc:description>This element specifies that the structure of the text within the tag, specifically the whitespace, should not be altered.</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType mixed="true">
<xs:sequence>
<xs:element name="value" type="i18nString" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ulink" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>ulink</doc:tooltip>
<doc:summary>a link that addresses its target by means of a URL</doc:summary>
<doc:description>this element and its children allow paragraphs to contain urls and titles for anchor tags. This markup is a subset of DocBook.</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType mixed="true">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="citetitle" type="i18nString">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>citetitle</doc:tooltip>
<doc:summary>the title of the cited work</doc:summary>
<doc:description>the citetitle element contains a text title for the url. It can be displayed in an anchor tag. This markup is a subset of DocBook.</doc:description>
<doc:example>The Dublin Core Metadata Initiative</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="url" use="optional">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>url</doc:tooltip>
<doc:summary>the Uniform Resource Locator for the cited work</doc:summary>
<doc:description>the url attribute contains the location of the work for a link. This markup is a subset of DocBook.</doc:description>
<doc:example>url="http://dublincore.org/documents/usageguide/"</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:choice>
<xs:attribute ref="xml:lang"/>
</xs:complexType>
<xs:complexType name="SectionType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Section</doc:tooltip>
<doc:summary>A section of related text.</doc:summary>
<doc:description>The "section" element allows for grouping related paragraphs (or other sections) of text together, with an optional title. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element name="title" type="i18nString" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Title</doc:tooltip>
<doc:summary>The optional title of the section.</doc:summary>
<doc:description>The optional title for a section. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded">
<xs:element name="para" type="ParagraphType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Paragraph</doc:tooltip>
<doc:summary>A simple paragraph of text.</doc:summary>
<doc:description>The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, and lists. This markup
is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="section" type="SectionType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Section</doc:tooltip>
<doc:summary>A section of related text.</doc:summary>
<doc:description>The "section" element allows for grouping related paragraphs of text together, with an optional title. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
<xs:attribute ref="xml:lang"/>
</xs:complexType>
<xs:complexType name="ListType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>ListType</doc:tooltip>
<doc:summary>A list of items in a text paragraph.</doc:summary>
<doc:description>A list of items in a text paragraph. The ListType is used by both orderedlist elements and itemizedlist elements. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element name="listitem" minOccurs="1" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>List Item</doc:tooltip>
<doc:summary>An item in a list of items.</doc:summary>
<doc:description>An item in a list of items. Each list item is formatted as a bulleted or numbered item depending on the list type in which it resides. List items contain paragraphs which in turn can be plain text or text with a limited set of markup
tags, including emphasis, subscript, superscript, and lists. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="1" maxOccurs="unbounded">
<xs:element name="para" type="ParagraphType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Paragraph</doc:tooltip>
<doc:summary>A simple paragraph of text.</doc:summary>
<doc:description>The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, and lists. This markup
is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="itemizedlist" type="ListType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Itemized List</doc:tooltip>
<doc:summary>A list of items in a text paragraph.
</doc:summary>
<doc:description>A list of items in a text paragraph. The list is generally displayed as a bulleted list. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="orderedlist" type="ListType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Ordered List</doc:tooltip>
<doc:summary>An ordered list of items in a text paragraph.
</doc:summary>
<doc:description>An ordered list of items in a text paragraph. The list is generally displayed as a numbered list. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SubSuperScriptType" mixed="true">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Subscript/Superscript Type</doc:tooltip>
<doc:summary>A subscript or a superscript in a text paragraph.
</doc:summary>
<doc:description>A subscript or a superscript in a text paragraph. This type is used by both subscript and superscript elements to define their recursive content. This markup is a subset of DocBook.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="value" type="i18nString" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Localized string for the sub/superscript</doc:tooltip>
<doc:summary>Language translation for the sub/superscript</doc:summary>
<doc:description>Language translation as specified by the xml:lang attribute</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="subscript" type="SubSuperScriptType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Subscript</doc:tooltip>
<doc:summary>A subscript in a text paragraph.</doc:summary>
<doc:description>A subscript in a text paragraph. This markup is a subset of DocBook.</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="superscript" type="SubSuperScriptType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Superscript</doc:tooltip>
<doc:summary>A superscript in a text paragraph.</doc:summary>
<doc:description>A superscript in a text paragraph. This markup is a subset of DocBook.</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attribute ref="xml:lang"/>
</xs:complexType>
<xs:complexType name="i18nString">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Localized string</doc:tooltip>
<doc:summary>Language translation for the text</doc:summary>
<doc:description>Language translation as specified by the xml:lang attribute</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute ref="xml:lang">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>xml:lang</doc:tooltip>
<doc:summary>language code for element content</doc:summary>
<doc:description>Specifies the language</doc:description>
<doc:example>xml:lang="en-US"</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:schema>