Skip to content

Commit

Permalink
Initial pass at introduction, acknowledgements, and gettingStarted se…
Browse files Browse the repository at this point in the history 
…ctions.

All sections are of type TextType, which still needs to be modified to
support Markdown syntax.
  • Loading branch information
@mbjones
mbjones committed Feb 9, 2018
1 parent c54463f commit a4572f0
Show file tree
Hide file tree
Showing 2 changed files with 180 additions and 8 deletions.
103 changes: 103 additions & 0 deletions src/test/resources/eml-data-paper.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
<?xml version="1.0"?>
<eml:eml packageId="doi:10.xxxx/example/A672144.v1" system="http://knb.ecoinformatics.org" xmlns:eml="eml://ecoinformatics.org/eml-2.2.0">

<dataset>
<title>Test data paper: Assessing ocean and atmosphere coupling using carbon flux measurements in the Beaufort Sea.</title>
<creator id="http://orcid.org/0000-0003-0077-4738">
<individualName>
<salutation>Mr.</salutation>
<givenName>Matthew</givenName>
<surName>Jones</surName>
</individualName>
<address>
<deliveryPoint>National Center for Ecological Analysis and Synthesis
</deliveryPoint>
<deliveryPoint>735 State St.</deliveryPoint>
<deliveryPoint>Suite 300</deliveryPoint>
<city>Santa Barbara</city>
<administrativeArea>CA</administrativeArea>
<postalCode>93101</postalCode>
<country>USA</country>
</address>
<phone>805-893-2500</phone>
<electronicMailAddress>jones@nceas.ucsb.edu</electronicMailAddress>
<userId directory="https://orcid.org">http://orcid.org/0000-0003-0077-4738</userId>
</creator>
<creator id="julien.brun">
<individualName>
<salutation>Dr.</salutation>
<givenName>Julien</givenName>
<surName>Brun</surName>
</individualName>
<address>
<deliveryPoint>National Center for Ecological Analysis and Synthesis
</deliveryPoint>
<deliveryPoint>735 State St.</deliveryPoint>
<deliveryPoint>Suite 300</deliveryPoint>
<city>Santa Barbara</city>
<administrativeArea>CA</administrativeArea>
<postalCode>93101</postalCode>
<country>USA</country>
</address>
<phone>805-893-2500</phone>
<electronicMailAddress>brun@nceas.ucsb.edu</electronicMailAddress>
<userId directory="https://orcid.org">http://orcid.org/0000-0003-0077-4738</userId>
</creator>
<keywordSet>
<keyword>Old field grassland</keyword>
<keyword>biomass</keyword>
<keyword>productivity</keyword>
<keyword>species-area</keyword>
<keyword>species richness</keyword>
</keywordSet>
<annotation>
<propertyURI>http://purl.org/dc/elements/1.1/subject</propertyURI>
<propertyLabel>Subject</propertyLabel>
<valueURI>http://purl.obolibrary.org/obo/ENVO_01000177</valueURI>
<valueLabel>grassland biome</valueLabel>
</annotation>
<introduction>An introduction goes here.</introduction>
<gettingStarted>A getting started guide goes here.</gettingStarted>
<acknowledgements>An acknowledgements paragraph goes here.</acknowledgements>
<contact>
<references>http://orcid.org/0000-0003-0077-4738</references>
</contact>
<contact>
<references>julien.brun</references>
</contact>
<project>
<title>Arctic Data Center</title>
<personnel>
<individualName>
<salutation>Mr.</salutation>
<givenName>Matthew</givenName>
<surName>Jones</surName>
</individualName>
<address>
<deliveryPoint>National Center for Ecological Analysis and Synthesis
</deliveryPoint>
<deliveryPoint>735 State St.</deliveryPoint>
<deliveryPoint>Suite 300</deliveryPoint>
<city>Santa Barbara</city>
<administrativeArea>CA</administrativeArea>
<postalCode>93101</postalCode>
<country>USA</country>
</address>
<phone>805-893-2500</phone>
<electronicMailAddress>jones@nceas.ucsb.edu</electronicMailAddress>
<userId directory="https://orcid.org">http://orcid.org/0000-0003-0077-4738</userId>
<role>Principal Investigator</role>
</personnel>
<funding>
<para>Funding is from a grant from the National Science Foundation.</para>
</funding>
<award>
<funderName>National Science Foundation</funderName>
<funderIdentifier>https://doi.org/10.13039/00000001</funderIdentifier>
<awardNumber>1546024</awardNumber>
<title>Scientia Arctica: A Knowledge Archive for Discovery and Reproducible Science in the Arctic</title>
<awardUrl>https://www.nsf.gov/awardsearch/showAward?AWD_ID=1546024</awardUrl>
</award>
</project>
</dataset>
</eml:eml>
85 changes: 77 additions & 8 deletions xsd/eml-dataset.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,83 @@
<doc:summary>A synopsis of the purpose of this
dataset.</doc:summary>
<doc:description>A synopsis of the purpose of this
dataset. It may include one or more paragraphs as well as
inline links to table(s) and figure(s) that summarize the
data included in the data paper, including a summary of key
dataset. It may include one or more paragraphs as well as
inline links to table(s) and figure(s) that summarize the
data included in the data paper, including a summary of key
findings if appropriate. Note that this element requires DocBook style
formatting. See eml-text for more information.</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="introduction" type="txt:TextType" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Introduction</doc:tooltip>
<doc:summary>An overview of the background and context for the dataset.</doc:summary>
<doc:description>One to many paragraphs that provide background
and context for the dataset with appropriate figures and
references. This is similar to the introduction for a journal
article, and would include, for example, project objectives,
hypotheses being addressed, what is known about the pattern or
process under study, how the data have been used to date
(including references), and how they could be used in the future.
The introduction may include figure(s) and table(s) by first
attaching those entities to the dataset (e.g., dataTable,
otherEntity), providing an id attribute for that entity, and
then referencing that entity id in the text of the introduction
using Markdown's syntax for inline images. See eml-text for
more information on formatting within this section.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="gettingStarted" type="txt:TextType" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Getting Started</doc:tooltip>
<doc:summary>A high level overview of interpretation, structure,
and content of the dataset.</doc:summary>
<doc:description>One or more paragraphs that describe the overall
interpretation, content and structure of the dataset. For
example, the number and names of data files, they types of
measurements that they contain, how those data files fit
together in an overall design, and how they relate to the
data collections methods, experimental design, and sampling
design that are described in other EML sections. One might
describe any specialized software that is available and/or may
be necessary for analyzing or interpreting the data, and
possibly include a high level description of data formats if
they are unusual, keeping in mind that detailed desriptions
of data structure and format are contained in the entity
sections of EML. Citations, inline figures, and inline
images can be included via inline references in Markdown
sections. See eml-text for more information on formatting
within this section.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="acknowledgements" type="txt:TextType" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Acknowledgements</doc:tooltip>
<doc:summary>Text that acknowledges funders and other key
contributors.
</doc:summary>
<doc:description>One or more sentences that acknowledge funders
and other key contributors to the study (excluding the
dataset authors listed in the creator field). Note that
funding awards are also listed by award number in the
eml-project award element, which provides a structured
list of funders, award numbers, and award URIs for the dataset.
When displaying acknowledgements, client software should
provide both the information in this acknowledgements element
as well as links from the award element. See eml-text for
more information on formatting within this section.
</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="maintenance" type="MaintenanceType" minOccurs="0">
<xs:annotation>
<xs:appinfo>
Expand Down Expand Up @@ -303,13 +372,13 @@
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Usage Citation</doc:tooltip>
<doc:summary>A citation to articles or products in which the
<doc:summary>A citation to articles or products in which the
dataset is used or referenced.</doc:summary>
<doc:description>A citation to articles or products in which the
dataset is used or referenced. The citation element contains
general information about a literature resource that has used or
<doc:description>A citation to articles or products in which the
dataset is used or referenced. The citation element contains
general information about a literature resource that has used or
references this dataset resource. It is not expected that the list of
usageCitations will necessarily be complete, but rather they serve as
usageCitations will necessarily be complete, but rather they serve as
examples and pointers to scholarly works in which this dataset has been
used.
</doc:description>
Expand Down

0 comments on commit a4572f0

Please sign in to comment.