From 245d5f3da16009e69332402d50c55f26deaa1f35 Mon Sep 17 00:00:00 2001 From: Matt Jones Date: Tue, 21 Aug 2018 18:49:58 -0700 Subject: [PATCH] Update rules language and formatting. --- buildDocBook.xsl | 306 +++++++++++++++++++++++------------------------ 1 file changed, 153 insertions(+), 153 deletions(-) diff --git a/buildDocBook.xsl b/buildDocBook.xsl index 78293032..c6c5ea2e 100644 --- a/buildDocBook.xsl +++ b/buildDocBook.xsl @@ -208,22 +208,22 @@ Likewise, citations are used throughout the top-level resource modules by importing the literature module. - - - - - - - - + + + + + + + +
@@ -242,30 +242,30 @@ module may be used for a particular column of a dataset, rather than the entire dataset as a whole. </para> - <!-- Get the eml-access module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-access.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-physical module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-physical.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-party module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-party.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-coverage module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-coverage.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-project module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-project.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-methods module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-methods.xsd')//doc:moduleDescription/*" - mode="copy"/> + <!-- Get the eml-access module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-access.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-physical module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-physical.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-party module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-party.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-coverage module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-coverage.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-project module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-project.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-methods module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-methods.xsd')//doc:moduleDescription/*" + mode="copy"/> </section> <section> <title> @@ -289,18 +289,18 @@ spatialRaster, spatialVector, etc...) which are described in the next section. </para> - <!-- Get the eml-entity module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-entity.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-attribute module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-attribute.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-constraint module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-constraint.xsd')//doc:moduleDescription/*" - mode="copy"/> + <!-- Get the eml-entity module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-entity.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-attribute module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-attribute.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-constraint module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-constraint.xsd')//doc:moduleDescription/*" + mode="copy"/> <!--section> <title> The stmml module - Definitions for creating a unit @@ -325,30 +325,30 @@ in both eml-spatialRaster and eml-spatialVector. It is described here in relation to those two modules. </para> - <!-- Get the eml-dataTable module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-dataTable.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-spatialRaster module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-spatialRaster.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-spatialVector module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-spatialVector.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-spatialReference module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-spatialReference.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-storedProcedure module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-storedProcedure.xsd')//doc:moduleDescription/*" - mode="copy"/> - <!-- Get the eml-view module description from the xsd file --> - <xsl:apply-templates - select="document('xsd/eml-view.xsd')//doc:moduleDescription/*" - mode="copy"/> + <!-- Get the eml-dataTable module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-dataTable.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-spatialRaster module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-spatialRaster.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-spatialVector module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-spatialVector.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-spatialReference module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-spatialReference.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-storedProcedure module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-storedProcedure.xsd')//doc:moduleDescription/*" + mode="copy"/> + <!-- Get the eml-view module description from the xsd file --> + <xsl:apply-templates + select="document('xsd/eml-view.xsd')//doc:moduleDescription/*" + mode="copy"/> </section> <section> <title> @@ -361,9 +361,9 @@ of text-based constructs to enhance a document (including sections, paragraphs, lists, subscript, superscript, emphasis, etc.) </para> - <xsl:apply-templates - select="document('xsd/eml-text.xsd')//doc:moduleDescription/*" - mode="copy"/> + <xsl:apply-templates + select="document('xsd/eml-text.xsd')//doc:moduleDescription/*" + mode="copy"/> <section> <title>Dependency Chart @@ -373,110 +373,110 @@
- +
Internationalization - Metadata in multiple languages - EML supports internationalization using the i18nNonEmptyStringType. + EML supports internationalization using the i18nNonEmptyStringType. Fields defined as this type include: - - Title - - - Keyword - - - Contact information (e.g. names, organizations, addresses) - - + + Title + + + Keyword + + + Contact information (e.g. names, organizations, addresses) + + TextType fields also support language translations. These fields include: - - Abstract - - - Methods - - - Protocol - - + + Abstract + + + Methods + + + Protocol + + - + Internationalization techniques - Core metadata should be provided in English. - The core elements can be augmented with translations in a native language. - Detailed metadata can be provided in the native language as declared using the xml:lang attribute. - Authors can opt to include English translations of this detailed metadata as they see fit. - - - The following example metadata document is provided primarily in Portuguese but includes English translations - of core metadata fields. - The xml:lang="pt_BR" attribute at the root of the EML document indicates that, unless otherwise specified, - the content of the document is supplied in Portuguese (Brazil). - The xml:lang="en_US" attributes on child elements denote that the content of that element is provided in English. + Core metadata should be provided in English. + The core elements can be augmented with translations in a native language. + Detailed metadata can be provided in the native language as declared using the xml:lang attribute. + Authors can opt to include English translations of this detailed metadata as they see fit. + + + The following example metadata document is provided primarily in Portuguese but includes English translations + of core metadata fields. + The xml:lang="pt_BR" attribute at the root of the EML document indicates that, unless otherwise specified, + the content of the document is supplied in Portuguese (Brazil). + The xml:lang="en_US" attributes on child elements denote that the content of that element is provided in English. - Core metadata (i.e. title) is provided in English, supplemented with a Portuguese translation using the - value tag with an xml:lang attribute. Note that child elements can override the - root language declaration of the document as well as the language declaration of their containing elements. - - The abstract element is primarily given in Portuguese (as inherited from the root language declaration), - with an English translation. - - - Many EML fields are repeatable (i.e. keyword) so that multiple values can be provided for the same concept. - Translations for these fields should be included as nested value tags to indicate that they are equivalent concepts - expressed in different languages rather than entirely different concepts. - - + Core metadata (i.e. title) is provided in English, supplemented with a Portuguese translation using the + value tag with an xml:lang attribute. Note that child elements can override the + root language declaration of the document as well as the language declaration of their containing elements. + + The abstract element is primarily given in Portuguese (as inherited from the root language declaration), + with an English translation. + + + Many EML fields are repeatable (i.e. keyword) so that multiple values can be provided for the same concept. + Translations for these fields should be included as nested value tags to indicate that they are equivalent concepts + expressed in different languages rather than entirely different concepts. + + <?xml version="1.0"?> <eml:eml - packageId="eml.1.1" system="knb" + packageId="eml.1.1" system="knb" xml:lang="pt_BR" xmlns:eml="eml://ecoinformatics.org/eml-2.2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="eml://ecoinformatics.org/eml-2.2.0 eml.xsd"> <dataset id="ds.1"> - - <!-- English title with Portuguese translation --> + + <!-- English title with Portuguese translation --> <title xml:lang="en-US"> - Sample Dataset Description - <value xml:lang="pt-BR">Exemplo Descrição Dataset</value> + Sample Dataset Description + <value xml:lang="pt-BR">Exemplo Descrição Dataset</value> </title> ... - <!-- Portuguese abstract with English translation --> + <!-- Portuguese abstract with English translation --> <abstract> - <para> - Neste exemplo, a tradução em Inglês é secundário - <value xml:lang="">In this example, the English translation is secondary</value> - </para> + <para> + Neste exemplo, a tradução em Inglês é secundário + <value xml:lang="">In this example, the English translation is secondary</value> + </para> </abstract> ... - <!-- two keywords, each with an equivalent translation --> + <!-- two keywords, each with an equivalent translation --> <keywordSet> - <keyword keywordType="theme"> - árvore - <value xml:lang="en-US">tree</value> - </keyword> - <keyword keywordType="theme"> - água - <value xml:lang="en-US">water</value> - </keyword> + <keyword keywordType="theme"> + árvore + <value xml:lang="en-US">tree</value> + </keyword> + <keyword keywordType="theme"> + água + <value xml:lang="en-US">water</value> + </keyword> </keywordSet> ... </dataset> </eml:eml> - +
- + @@ -515,12 +515,13 @@ - An ID is required on the eml root element. + An ID is required on the eml root element in the packageId attribute. - IDs are optional on all other elements. + IDs are optional on all other elements, except elements which are + the subject of annotations. @@ -538,8 +539,8 @@ If a user wants to reuse content to indicate the repetition of an - object, a reference must be used. Two identical ids with the same system - attribute cannot exist in a single document. + object, a reference must be used. Two identical ids with the same system + attribute cannot exist in a single document. @@ -562,7 +563,7 @@ If an element references another element, it must not have an ID itself. The system attribute must have the same value in both the - target and referencing elements or it must be absent in both. + target and referencing elements or it must be absent in both. @@ -1118,4 +1119,3 @@ -