From 54c7cd797dd3310630c197160e2882a4526c1be1 Mon Sep 17 00:00:00 2001 From: Matt Jones Date: Fri, 9 Feb 2018 17:53:27 -0900 Subject: [PATCH] Drafted new fields for data paper support. This includes a new `markdown` element in `txt:TextType` to support Github flavored markdown. And new elements for an introduction, gettingStarted, and acknowledgements. See issue #269 and #275. --- src/test/resources/eml-data-paper.xml | 38 +- xsd/eml-text.xsd | 831 +++++++++++++------------- 2 files changed, 435 insertions(+), 434 deletions(-) diff --git a/src/test/resources/eml-data-paper.xml b/src/test/resources/eml-data-paper.xml index d2d60e9c..945f0ba8 100644 --- a/src/test/resources/eml-data-paper.xml +++ b/src/test/resources/eml-data-paper.xml @@ -1,5 +1,9 @@ - + Test data paper: Assessing ocean and atmosphere coupling using carbon flux measurements in the Beaufort Sea. @@ -56,8 +60,36 @@ http://purl.obolibrary.org/obo/ENVO_01000177 grassland biome - An introduction goes here. - A getting started guide goes here. + + + An introduction goes here. + + It can include multiple paragraphs. And these paragraphs should have enough text to wrap in a wide browser. So, repeat that last thought. And these paragraphs should have enough text to wrap in a wide browser. So, repeat that last thought. + + And bulleted lists: + + - Science + - Engineering + - Math + + Plus, it can include all of the other features of + [Github Flavored Markdown (GFM)](). + + + + + Some intro text in the getting started, then break into subsections. + + ## Level 2 heading + + We use a level 2 heading because Level 1 would be at the same level as + the main sections of the paper. + + ## Another level 2 heading + With some information. + + + An acknowledgements paragraph goes here. http://orcid.org/0000-0003-0077-4738 diff --git a/xsd/eml-text.xsd b/xsd/eml-text.xsd index 690632cc..c0632bb9 100644 --- a/xsd/eml-text.xsd +++ b/xsd/eml-text.xsd @@ -5,469 +5,438 @@ 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"> - - + + + - - - '$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/ - - '$Author: obrien $' - '$Date: 2009-02-25 23:51:54 $' - '$Revision: 1.23 $' - - 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. + + + '$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 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. + 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. - 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 - + 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. - - - eml-text - -
- The eml-text module - Text field formatting - - The eml-text module is a wrapper container that allows general - text descriptions to be used within the various modules of eml. - It can include either structured or unstructured text blocks. - It isn't really appropriate to use this module outside of the - context of a parent module, because the parent module determines - the appropriate context to which this text description applies. - The eml-text module allows one to provide structure to a text - description in order to convey concepts such as sections - (paragraphs), hierarchy (ordered and unordered lists), emphasis - (bold, superscript, subscript) etc. The structured elements - are a subset of DocBook - so the predefined DocBook stylesheets can be used to style - EML fields that implement this module. - -
- - any module - no - - - - - - - Text - A simple text desription. - 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. - - - - + 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 + - - - - Text - A simple text desription. - 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. - - + + + eml-text + +
+ The eml-text module - Text field formatting + + The eml-text module is a wrapper container that allows general text descriptions to be used within the various modules of eml. It can include either structured or unstructured text blocks. It isn't really appropriate to use this module outside of the context of a parent module, because the parent module determines the appropriate context to which this text description applies. The eml-text module allows one to provide structure to a text description in order to convey concepts such as sections (paragraphs), hierarchy (ordered and unordered lists), emphasis (bold, superscript, subscript) etc. The structured elements can be specified using a subset of DocBook 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. Combinations of plain text, docbook sections, and markdown sections can be interleaved in any order, but most people will likely + find the markdown syntax the easiest to use. + +
+ + any module + no + + - - + - - Section - A section of related text. - The "section" element allows for - grouping related paragraphs of text together, with - an optional title. This markup is a subset of DocBook. - - - - - - - - Paragraph - A simple paragraph of text. - 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. - - + + Text + A simple text desription. + 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 DocBook 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. + + - - - - + - - - - Paragraph - A simple paragraph of text. - 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. - - - - - - - - Localized string for the paragraph - Language translation for the paragraph - Language translation as specified by the xml:lang attribute - - - - - - - Itemized List - A list of items in a text paragraph. - - A list of items in a text paragraph. The - list is generally displayed as a bulleted list. - This markup is a subset of DocBook. - - - - - - - - Ordered List - An ordered list of items in a text paragraph. - - 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. - - - - - - - - Emphasis - A span of emphasized text in a paragraph. - 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. - - - - - - - - - - - - - Subscript - A subscript in a text paragraph. - A subscript in a text paragraph. - This markup is a subset of DocBook. - - - - - - - Superscript - A superscript in a text paragraph. - A superscript in a text paragraph. - This markup is a subset of DocBook. - - - - + - - literalLayout - The equivalent to <pre> in html. - This element specifies that the structure of - the text within the tag, specifically the whitespace, should not - be altered. - + + Text + A simple text desription. + 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. + + - - - - - - - + + + + + Section + A section of related text. + The "section" element allows for grouping related paragraphs of text together, with an optional title. This markup is a subset of DocBook. + + + + + + + + Paragraph + A simple paragraph of text. + 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. + + + + + + + + Markdown + A block of text formatted with Markdown directives. + 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 GitHub Flavored Markdown (GFM) extensions to the CommonMark specification. + + + + + + + + + + + + + + + + - - ulink - a link that addresses its target by means of a URL - this element and its children allow paragraphs to contain - urls and titles for anchor tags. This markup is a subset of DocBook. - + + Paragraph + A simple paragraph of text. + 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. + + - - - - - - citetitle - the title of the cited work - 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. - The Dublin Core Metadata Initiative - - + + + + + Localized string for the paragraph + Language translation for the paragraph + Language translation as specified by the xml:lang attribute + + + + + + + Itemized List + A list of items in a text paragraph. + + A list of items in a text paragraph. The list is generally displayed as a bulleted list. This markup is a subset of DocBook. + + + + + + + + Ordered List + An ordered list of items in a text paragraph. + + 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. + + + - - - - - url - the Uniform Resource Locator for the cited work - the url attribute contains the location of the work for a link. This markup is a subset of DocBook. - url="http://dublincore.org/documents/usageguide/" - - - - - - - - + + + + Emphasis + A span of emphasized text in a paragraph. + 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. + + + + + + + + + + + + + Subscript + A subscript in a text paragraph. + A subscript in a text paragraph. This markup is a subset of DocBook. + + + + + + + Superscript + A superscript in a text paragraph. + A superscript in a text paragraph. This markup is a subset of DocBook. + + + + + + + literalLayout + The equivalent to <pre> in html. + This element specifies that the structure of the text within the tag, specifically the whitespace, should not be altered. + + + + + + + + + + + + ulink + a link that addresses its target by means of a URL + this element and its children allow paragraphs to contain urls and titles for anchor tags. This markup is a subset of DocBook. + + + + + + + + citetitle + the title of the cited work + 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. + The Dublin Core Metadata Initiative + + + + + + + + url + the Uniform Resource Locator for the cited work + the url attribute contains the location of the work for a link. This markup is a subset of DocBook. + url="http://dublincore.org/documents/usageguide/" + + + + + + + + - - - - Section - A section of related text. - 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. - - - - - + - - Title - The optional title of the section. - The optional title for a section. - This markup is a subset of DocBook. - - - - - - - - Paragraph - A simple paragraph of text. - 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. - + Section + A section of related text. + 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. + - - - - + + + + + + Title + The optional title of the section. + The optional title for a section. This markup is a subset of DocBook. + + + + + + + + + Paragraph + A simple paragraph of text. + 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. + + + + + + + + Section + A section of related text. + The "section" element allows for grouping related paragraphs of text together, with an optional title. This markup is a subset of DocBook. + + + + + + + + + + + - Section - A section of related text. - The "section" element allows for - grouping related paragraphs of text together, with - an optional title. This markup is a subset of DocBook. - + ListType + A list of items in a text paragraph. + 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. + - - - - - - + + + + + + List Item + An item in a list of items. + 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. + + + + + + + + + Paragraph + A simple paragraph of text. + 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. + + + + + + + + Itemized List + A list of items in a text paragraph. + + A list of items in a text paragraph. The list is generally displayed as a bulleted list. This markup is a subset of DocBook. + + + + + + + + Ordered List + An ordered list of items in a text paragraph. + + 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. + + + + + + + + + - - - - ListType - A list of items in a text paragraph. - 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. - - - - - - + + - List Item - An item in a list of items. - 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. - + Subscript/Superscript Type + A subscript or a superscript in a text paragraph. + + 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. + - - - - + + + - - Paragraph - A simple paragraph of text. - 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. - - + + Localized string for the sub/superscript + Language translation for the sub/superscript + Language translation as specified by the xml:lang attribute + - - + + - - Itemized List - A list of items in a text paragraph. - - A list of items in a text paragraph. The - list is generally displayed as a bulleted list. - This markup is a subset of DocBook. - - + + Subscript + A subscript in a text paragraph. + A subscript in a text paragraph. This markup is a subset of DocBook. + - - + + - - Ordered List - An ordered list of items in a text paragraph. - - 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. - - + + Superscript + A superscript in a text paragraph. + A superscript in a text paragraph. This markup is a subset of DocBook. + - - - - - - + + + + - - - - Subscript/Superscript Type - A subscript or a superscript in a text paragraph. - - 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. - - - - - - - - Localized string for the sub/superscript - Language translation for the sub/superscript - Language translation as specified by the xml:lang attribute - - - - + - - Subscript - A subscript in a text paragraph. - A subscript in a text paragraph. - This markup is a subset of DocBook. - - - - - - - Superscript - A superscript in a text paragraph. - A superscript in a text paragraph. - This markup is a subset of DocBook. - + + Localized string + Language translation for the text + Language translation as specified by the xml:lang attribute + - - - - + + + + + + xml:lang + language code for element content + Specifies the language + xml:lang="en-US" + + + + + + - - - - Localized string - Language translation for the text - Language translation as specified by the xml:lang attribute - - - - - - - - xml:lang - language code for element content - Specifies the language - xml:lang="en-US" - - - - - -