Skip to content

Commit

Permalink
Link to module images and diagrams in docs
Browse files Browse the repository at this point in the history
Addresses #316
  • Loading branch information
amoeba committed Aug 30, 2019
1 parent cfbb742 commit 1b163e7
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/build_book.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ bookdown::render_book("index.Rmd", "bookdown::gitbook")

# Copy the HTML Bookdown produces from the ../README.md file to index.html
file.copy("../dist/eml-ecological-metadata-language.html", "../dist/index.html", overwrite = TRUE)
file.copy(dir("../img", full.names = TRUE), "../dist/images", recursive = TRUE)
40 changes: 40 additions & 0 deletions docs/eml-modules-data-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ section.

## The eml-entity module - Entity level information within datasets

Links:

- [Module Diagram](./images/eml-entity.png)
- [Interactive Module Documentation](./schema/eml-entity_xsd.html)

The eml-entity module defines the logical characteristics of each entity
in the dataset. Entities are usually tables of data (eml-dataTable).
Data tables may be ascii text files, relational database tables,
Expand All @@ -43,6 +48,11 @@ via its ID.

## The eml-attribute module - Attribute level information within dataset entities

Links:

- [Module Diagram](./images/eml-attribute.png)
- [Interactive Module Documentation](./schema/eml-attribute_xsd.html)

The eml-attribute module describes all attributes (variables) in a data
entity: dataTable, spatialRaster, spatialVector, storedProcedure, view
or otherEntity. The description includes the name and definition of each
Expand Down Expand Up @@ -141,6 +151,11 @@ into their appropriate components (e.g., days, months, years)./

## The eml-constraint module - Relationships among and within dataset entities

Links:

- [Module Diagram](./images/eml-constraint.png)
- [Interactive Module Documentation](./schema/eml-constraint_xsd.html)

The eml-constraint schema defines the integrity constraints between
entities (e.g., data tables) as they would be maintained in a relational
management system. These constraints include primary key constraints,
Expand All @@ -149,6 +164,11 @@ not null constraints, among potential others.

## The eml-dataTable module - Logical information about data table entities

Links:

- [Module Diagram](./images/eml-dataTable.png)
- [Interactive Module Documentation](./schema/eml-dataTable_xsd.html)

The eml-dataTable module is used to describe the logical characteristics
of each tabular set of information in a dataset. A series of
comma-separated text files may be considered a dataset, and each file
Expand All @@ -165,6 +185,11 @@ information such as its orientation, case sensitivity, etc.

## The eml-spatialRaster module - Logical information about regularly gridded geospatial image data

Links:

- [Module Diagram](./images/eml-spatialRaster.png)
- [Interactive Module Documentation](./schema/eml-spatialRaster_xsd.html)

The eml-spatialRaster module allows for the description of entities
composed of rectangular grids of data values that are usually
georeferenced to a portion of the earth\'s surface. Specific attributes
Expand All @@ -175,6 +200,11 @@ bands.

## The eml-spatialVector module - Logical information about non-gridded geospatial image data

Links:

- [Module Diagram](./images/eml-spatialVector.png)
- [Interactive Module Documentation](./schema/eml-spatialVector_xsd.html)

The eml-spatialVector module allows for the description of spatial
objects in a GIS system that are not defined in a regularly gridded
pattern. These geometries include points and vectors and the
Expand All @@ -194,6 +224,11 @@ schema for any projection that does not appear in this dictionary.

## The eml-storedProcedure module - Data tables resulting from procedures stored in a database

Links:

- [Module Diagram](./images/eml-storedProcedure.png)
- [Interactive Module Documentation](./schema/eml-storedProcedure_xsd.html)

The storedProcedure module is meant to capture information on procedures
that produce data output in the form of a data table. In an RDBMS one
can code complex queries and transactions into stored procedures and
Expand All @@ -203,6 +238,11 @@ the procedure when it is called.

## The eml-view module - Data tables resulting from a database query

Links:

- [Module Diagram](./images/eml-view.png)
- [Interactive Module Documentation](./schema/eml-view_xsd.html)

The eml-view module describes a view from a database management system.
A view is a query statement that is stored as a database object and
executed each time the view is called.
Expand Down
30 changes: 30 additions & 0 deletions docs/eml-modules-discovery-interpret.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ a dataset, rather than the entire dataset as a whole.

## The eml-access module - Access control rules for resources

Links:

- [Module Diagram](./images/eml-access.png)
- [Interactive Module Documentation](./schema/eml-access_xsd.html)

The eml-access module describes the level of access that is to be
allowed or denied to a resource for a particular user or group of users,
and can be described independently for metadata and data. The eml-access
Expand Down Expand Up @@ -157,6 +162,11 @@ those entities.

## The eml-physical module - Physical file format

Links:

- [Module Diagram](./images/eml-physical.png)
- [Interactive Module Documentation](./schema/eml-physical_xsd.html)

The eml-physical module describes the external and internal physical
characteristics of a data object as well as the information required for
its distribution. Examples of the external physical characteristics of a
Expand All @@ -180,6 +190,11 @@ document via its ID.

## The eml-party module - People and organization information

Links:

- [Module Diagram](./images/eml-party.png)
- [Interactive Module Documentation](./schema/eml-party_xsd.html)

The eml-party module describes a responsible party and is typically used
to name the creator of a resource or metadata document. A responsible
party may be an individual person, an organization or a named position
Expand All @@ -194,6 +209,11 @@ ID.

## The eml-coverage module - Geographic, temporal, and taxonomic extents of resources

Links:

- [Module Diagram](./images/eml-coverage.png)
- [Interactive Module Documentation](./schema/eml-coverage_xsd.html)

The eml-coverage module contains fields for describing the coverage of a
resource in terms of time, space, and taxonomy. These coverages
(temporal, spatial, and taxonomic) represent the extent of applicability
Expand Down Expand Up @@ -243,6 +263,11 @@ document via its ID.

## The eml-project module - Research context information for resources

Links:

- [Module Diagram](./images/eml-project.png)
- [Interactive Module Documentation](./schema/eml-project_xsd.html)

The eml-project module describes the research context in which the
dataset was created, including descriptions of over-all motivations and
goals, funding, personnel, description of the study area etc. This is
Expand All @@ -258,6 +283,11 @@ document via its ID.

## The eml-methods module - Methodological information for resources

Links:

- [Module Diagram](./images/eml-methods.png)
- [Interactive Module Documentation](./schema/eml-methods_xsd.html)

The eml-methods module describes the methods followed in the creation of
the dataset, including description of field, laboratory and processing
steps, sampling methods and units, quality control procedures. The
Expand Down
30 changes: 30 additions & 0 deletions docs/eml-modules-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

## The eml module - A metadata container

Links:

- [Module Diagram](./images/eml.png)
- [Interactive Module Documentation](./schema/eml_xsd.html)

The eml module is a wrapper container that allows the inclusion of any
metadata content in a single EML document. The eml module is used as a
container to hold structured descriptions of ecological resources. In
Expand Down Expand Up @@ -29,6 +34,11 @@ internally extend fields within the EML standard.

## The eml-resource module - Base information for all resources

Links:

- [Module Diagram](./images/eml-resource.png)
- [Interactive Module Documentation](./schema/eml-resource_xsd.html)

The eml-resource module contains general information that describes
dataset resources, literature resources, protocol resources, and
software resources. Each of the above four types of resources share a
Expand All @@ -54,6 +64,11 @@ module.

## The eml-dataset module - Dataset specific information

Links:

- [Module Diagram](./images/eml-dataset.png)
- [Interactive Module Documentation](./schema/eml-dataset_xsd.html)

The eml-dataset module contains general information that describes
dataset resources. It is intended to provide overview information about
the dataset: broad information such as the title, abstract, keywords,
Expand All @@ -76,6 +91,11 @@ its ID.

## The eml-literature module - Citation-specific information

Links:

- [Module Diagram](./images/eml-literature.png)
- [Interactive Module Documentation](./schema/eml-literature_xsd.html)

The eml-literature module contains information that describes literature resources. It is intended to provide overview information about the literature citation, including title, abstract, keywords, and contacts. Citation types follow the conventions laid out by [EndNote](http://www.endnote.com), and there is an attempt to represent a compatible subset of the EndNote citation types. These citation types include: article, book, chapter, edited book, manuscript, report, thesis, conference proceedings, personal communication, map, generic, audio visual, and presentation. The generic citation type would be used when one of the other types will not work.

There are three unique CitationType elements that may be employed within a eml-dataset module, including the \<literatureCited\>, \<usageCitation\>, and \<referencePublication\> elements. The purpose and examples of each CitationType element type are detailed below.
Expand Down Expand Up @@ -239,6 +259,11 @@ A citation to an article or other resource that serves as an important reference

## The eml-software module - Software specific information

Links:

- [Module Diagram](./images/eml-software.png)
- [Interactive Module Documentation](./schema/eml-software_xsd.html)

The eml-software module contains general information that describes
software resources. This module is intended to fully document software
that is needed in order to view a resource (such as a dataset) or to
Expand All @@ -253,6 +278,11 @@ document via its ID.

## The eml-protocol module - Research protocol specific information

Links:

- [Module Diagram](./images/eml-protocol.png)
- [Interactive Module Documentation](./schema/eml-protocol_xsd.html)

The EML Protocol Module is used to define abstract, prescriptive
procedures for generating or processing data. Conceptually, a protocol
is a standardized method.
Expand Down
11 changes: 11 additions & 0 deletions docs/eml-modules-utility.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ paragraphs, lists, subscript, superscript, emphasis, etc.)

## The eml-text module - Text field formatting

Links:

- [Module Diagram](./images/eml-text.png)
- [Interactive Module Documentation](./schema/eml-text_xsd.html)

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
Expand All @@ -25,6 +30,12 @@ sections can be interleaved in any order, but most people will likely
find the markdown syntax the easiest to use.

## The eml-semantics module - Semantic annotations for formalized statements about EML components

Links:

- [Module Diagram](./images/eml-semantics.png)
- [Interactive Module Documentation](./schema/eml-semantics_xsd.html)

The eml-semantics module defines types and elements for
annotating other structures within EML with semantically-precise
statements from various controlled vocabularies. This is
Expand Down

0 comments on commit 1b163e7

Please sign in to comment.