diff --git a/.github/workflows/dev-build.yml b/.github/workflows/dev-build.yml index 66d7dd2..276d46b 100644 --- a/.github/workflows/dev-build.yml +++ b/.github/workflows/dev-build.yml @@ -17,12 +17,12 @@ jobs: id: adocbuild-datasets uses: avattathil/asciidoctor-action@master with: - program: "asciidoctor -a variant-dataset -a stylesheet=assets/gemini.css -a docinfo1 'docs/*.asciidoc' 'docs/*.adoc'" + program: "asciidoctor -a variant-dataset -a docinfo1 -T docs/templates -E slim 'docs/*.asciidoc' 'docs/*.adoc'" - name: Build services variant id: adocbuild-services uses: avattathil/asciidoctor-action@master with: - program: "asciidoctor -a variant-service -a stylesheet=assets/gemini.css -a docinfo1 'docs/*.asciidoc' 'docs/*.adoc'" + program: "asciidoctor -a variant-service -a docinfo1 -T docs/templates -E slim 'docs/*.asciidoc' 'docs/*.adoc'" - name: Deploy docs to ghpages uses: peaceiris/actions-gh-pages@v3 with: diff --git a/docs/1037-uk-gemini-standard-and-inspire-implementing-rules.asciidoc b/docs/1037-uk-gemini-standard-and-inspire-implementing-rules.asciidoc index adc41eb..58ecb1a 100644 --- a/docs/1037-uk-gemini-standard-and-inspire-implementing-rules.asciidoc +++ b/docs/1037-uk-gemini-standard-and-inspire-implementing-rules.asciidoc @@ -1,5 +1,4 @@ = UK-GEMINI Standard and Inspire Implementing Rules - include::./includes/attributes.asciidoc[] == Introduction{nbsp} _(GEMINI 2.3, June 2018)_ @@ -50,7 +49,7 @@ a{nbsp}link:1055-uk-gemini-major-changes-since-1-0.html[summary of changes]{nbsp}from earlier versions. Here is -a{nbsp}https://www.agi.org.uk/gemini/40-gemini/1250-element-summary/[summary]{nbsp}of +a{nbsp}link:1250-element-summary.html[summary]{nbsp}of the GEMINI elements (similar to Table 1 and Table 2 in GEMINI 2.2). Note: in GEMINI 2.3, the GEMINI Element number is called "GEMINI id"; @@ -66,32 +65,32 @@ follow{nbsp}link:1052-metadata-guidelines-for-geospatial-data-resources-part-1.h link]{nbsp}to gain a general introduction to metadata for geographic information before going any further. The{nbsp}link:1056-glossary.html[glossary of -terms]{nbsp}and{nbsp}https://www.agi.org.uk/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[list +terms]{nbsp}and{nbsp}link:1047-metadata-guidelines-for-geospatial-data-resources-part-3.html[list of references]{nbsp}may also be useful; * *starting to compile metadata conforming to UK GEMINI2*{nbsp}and are unfamiliar with the standard, then follow{nbsp}link:1051-uk-gemini-v2-2-specification-for-discovery-metadata-for-geospatial-resources.html[this link]{nbsp}to understand the scope, terms used and the requirements and also{nbsp}link:1049-metadata-guidelines-for-geospatial-data-resources-part-2.html[this -one]{nbsp}which provides general guidance;https://www.agi.org.uk/40-gemini/ +one]{nbsp}which provides general guidance; * *familiar with UK GEMINI*{nbsp}and require specific information about the requirements and guidance for the metadata elements, then follow one of these links: to -describe{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series[datasets +describe{nbsp}link:1062-gemini-datasets-and-data-series.html[datasets or series]{nbsp}or -for{nbsp}https://www.agi.org.uk/40-gemini/1063-gemini-services[services]; +for{nbsp}link:1063-gemini-services.html[services]; * *encoding UK GEMINI metadata in XML*, then{nbsp}link:1048-uk-gemini-encoding-guidance.html[general guidance]{nbsp}is supplemented with detailed guidance for each metadata element -at{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series[datasets +at{nbsp}link:1062-gemini-datasets-and-data-series.html[datasets or series]{nbsp}or -for{nbsp}https://www.agi.org.uk/40-gemini/1063-gemini-services[services] +for{nbsp}link:1063-gemini-services.html[services] * *quality assuring metadata*, then information on common metadata errors can found{nbsp}link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html[here]. * *Schematron rules*{nbsp}which check many of the constraints in GEMINI is -available as a{nbsp}https://github.com/AGIGemini/Schematron[on GitHub (free +available{nbsp}https://github.com/AGIGemini/Schematron[on GitHub (free link)], under a Creative Commons license. === Feedback @@ -108,8 +107,6 @@ therefore we would like to hear from you if you spot any of these or you would like to see improvements in terms of presentation and usability. Please send any comments -to{nbsp}mailto:gemini@agi.org.uk?subject=GEMINI2.3%20Release%20candidate[gemini@agi.org.uk], -copied to Peter Parslow at Ordnance Survey (chair of AGI Standards -Committee) +to{nbsp}mailto:gemini@agi.org.uk?subject=GEMINI2.3[gemini@agi.org.uk] _Last updated: May 2018_ \ No newline at end of file diff --git a/docs/1046-xml-element-order.asciidoc b/docs/1046-xml-element-order.asciidoc new file mode 100644 index 0000000..6be7ed6 --- /dev/null +++ b/docs/1046-xml-element-order.asciidoc @@ -0,0 +1,126 @@ += XML element order +include::./includes/attributes.asciidoc[] + +== Dataset and Dataset Series Metadata + +Return +to{nbsp}link:1037-uk-gemini-standard-and-inspire-implementing-rules.html[GEMINI +2.3 home page] + +[cols=",,",] +|=== +|*ISO 19139 XML Element* |*GEMINI2 Item Number* |*GEMINI2 Item Name* +|*_gmd:MD_Metadata_* | | +|gmd:fileIdentifier |45 |File Identifier +|gmd:language |33 |Metadata language +|gmd:parentIdentifier |49 |Parent identifier +|gmd:hierarchyLevel |39 |Resource type +|gmd:hierarchyLevelName |47 |Hierarchy level name +|gmd:contact |35 |Metadata point of contact +|gmd:dateStamp |30 |Metadata date +|gmd:referenceSystemInfo |17 |Spatial reference system +|gmd:identificationInfo | | +|*_gmd:MD_DataIdentification_* | | +|_  gmd:citation_ | | +|_    gmd:CI_Citation_ | | +|      gmd:title |1 |Title +|      gmd:alternateTitle |2 |Alternative title +|      gmd:date |8 |Dataset reference date +|      gmd:identifier |36 |Unique resource identifier +|  gmd:abstract |4 |Abstract +|  gmd:pointOfContact |23 |Responsible organisation +|  gmd:resourceMaintenance |24 |Frequency of update +|  gmd:descriptiveKeywords |6 |Keyword +|  _gmd:resourceConstraints_ | | +|   _gmd:MD_LegalConstraints_ | | +|     _gmd:accessConstraints_ | | +|      gmd:otherConstraints |25 |Limitations on public access +|  _gmd:resourceConstraints_ | | +|   _gmd:MD_Constraints_ | | +|      gmd:useLimitation |26 |Use constraints +| gmd:spatialRepresentationType |50 |Spatial representation type +| _ gmd:spatialResolution_ | | +|   _ gmd:MD_Resolution_ | | +|      gmd:distance |18 |Spatial resolution +|  _gmd:spatialResolution_ | | +|_    gmd:MD_Resolution_ | | +|      gmd:equivalentScale |43 |Equivalent scale +|  gmd:language |3 |Dataset language +|  gmd:characterSet |51 |Character encoding +|  gmd:topicCategory |5 |Topic category +|_  gmd:extent_ | | +|   _gmd:EX_Extent_ | | +|     _gmd:geographicElement_ | | +|        gmd:EX_GeographicDescription |15 |Extent +|_      _  gmd:EX_GeographicBoundingBox |44 |Bounding box +|      gmd:temporalElement |7 |Temporal extent +|      gmd:verticalElement |16 |Vertical extent information +|  gmd:supplementalInformation |27 |Additional information source +|_gmd:distributionInfo_ | | +|  gmd:distributionFormat |21 |Data format +|  gmd:transferOptions |19 |Resource locator +|_gmd:dataQualityInfo_ | | +|  gmd:scope |48 |Quality scope +|  _gmd:report_ | | +|   gmd:DQ_DomainConsistency |41 |Conformity +|  gmd:lineage |10 |Lineage +|_gmd:dataQualityInfo_ | | +|_  gmd:report_ | | +|   gmd:DQ__XXXXXX_ |52 |Data quality +|=== + +== Service Metadata + +[cols=",,",] +|=== +|*ISO 19139 XML Element* |*GEMINI2 Item Number* |*GEMINI2 Item Name* +|*_gmd:MD_Metadata_* | | +|gmd:fileIdentifier |45 |File Identifier +|gmd:language |33 |Metadata language +|gmd:parentIdentifier |49 |Parent identifier +|gmd:hierarchyLevel |39 |Resource type +|gmd:hierarchyLevelName |47 |Hierarchy level name +|gmd:contact |35 |Metadata point of contact +|gmd:dateStamp |30 |Metadata date +|gmd:referenceSystemInfo |17 |Spatial reference system +|gmd:identificationInfo | | +|*_srv:SV_Identification_* | | +|_  gmd:citation_ | | +|_    gmd:CI_Citation_ | | +|      gmd:title |1 |Title +|      gmd:alternateTitle |2 |Alternative title +|      gmd:date |8 |Dataset reference date +|      gmd:identifier |- |- +|  gmd:abstract |4 |Abstract +|  gmd:pointOfContact |23 |Responsible organisation +|  gmd:resourceMaintenance |- |- +|  gmd:descriptiveKeywords |6 |Keyword +|  _gmd:resourceConstraints_ | | +|   _gmd:MD_LegalConstraints_ | | +|     _gmd:accessConstraints_ | | +|      gmd:otherConstraints |25 |Limitations on public access +|  _gmd:resourceConstraints_ | | +|   _gmd:MD_Constraints_ | | +|      gmd:useLimitation |26 |Use constraints +|  srv:serviceType |37 |Spatial data service type +|_ srv:extent_ | | +|   _gmd:EX_Extent_ | | +|     _gmd:geographicElement_ | | +|        gmd:EX_GeographicDescription |15 |Extent +|_      _  gmd:EX_GeographicBoundingBox |44 |(the bounding coordinates) +|      gmd:temporalElement |7 |Temporal extent +|      gmd:verticalElement |16 |Vertical extent information +|    srv:couplingType |- |- +|    srv:containsOperations |- |- +|    srv:operatesOn |38 |Coupled resource +|_gmd:distributionInfo_ | | +|  gmd:distributionFormat |- |- +|  gmd:transferOptions |19 |Resource locator +|_gmd:dataQualityInfo_ | | +|  gmd:scope |48 |Quality scope (including levelDescription) +|  _gmd:report_ | | +|   gmd:DQ_DomainConsistency |41 |Conformity +|=== + +_Last updated: April 2018_ + diff --git a/docs/1053-common-metadata-errors-uk-location-discovery-metadata-service.asciidoc b/docs/1053-common-metadata-errors-uk-location-discovery-metadata-service.asciidoc index f7f1f26..ec1f52a 100644 --- a/docs/1053-common-metadata-errors-uk-location-discovery-metadata-service.asciidoc +++ b/docs/1053-common-metadata-errors-uk-location-discovery-metadata-service.asciidoc @@ -1,32 +1,33 @@ -== Common Metadata Errors UK Location Discovery Metadata Service += Common Metadata Errors UK Location Discovery Metadata Service include::./includes/attributes.asciidoc[] Return -to{nbsp}https://www.agi.org.uk/gemini/40-gemini/1037-uk-gemini-standard-and-inspire-implementing-rules[GEMINI +to{nbsp}link:1037-uk-gemini-standard-and-inspire-implementing-rules.html[GEMINI 2.3 home page] -https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#Intro[1. +link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#Intro[1. Introduction] -https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#schema_errors[2. +link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#schema_errors[2. Schema errors] -https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#ISO_errors[3. +link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#ISO_errors[3. ISO 19139 Schematron errors] -https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#proc_errors[4. +link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#proc_errors[4. Processing Errors] -https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#inspire_warnings[5. +link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#inspire_warnings[5. European INSPIRE Geoportal errors and warnings] -https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#soft_errors[6. +link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#soft_errors[6. "Soft" errors] -https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#winner[7. +link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#winner[7. And the winner?] -=== [#Intro]####1. Introduction +== 1. Introduction +[#Intro] The UK Location Discovery Metadata Service (DMS) lies at the heart of UK Location and the delivery of the UK Location Strategy and INSPIRE - 'to @@ -36,31 +37,31 @@ The DMS operates by collecting valid metadata records from data publishers and making them available on data.gov.uk, and for further collection to the European INSPIRE Geoportal. -==== 1.1 Target Audience +=== 1.1 Target Audience The primary audience for this document are those responsible for creating and maintaining metadata records, located within data provider organisations, and their technical partners. -==== 1.2 Background +=== 1.2 Background This document is largely based on an analysis of validation failures when metadata validation was first run on the records that had already been collected into{nbsp}https://data.gov.uk/[data.gov.uk]. Approximately half the records present in data.gov.uk at that time initially failed. -==== 1.3 Assumed Knowledge +=== 1.3 Assumed Knowledge This guide assumes that the reader is familiar with the creation and management of metadata and has read the{nbsp}UK Location “Getting Started' series of -guides{nbsp}[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[27]], +guides{nbsp}link:1047-metadata-guidelines-for-geospatial-data-resources-part-3.html[27]], and the DMS Operational Guide. Readers requiring an introduction to discovery metadata for geospatial data resources are referred to the UK GEMINI guide “Metadata Guidelines for Geospatial Data Resources, Introduction – Part 1” -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[1]]. +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3.html[1]]. Other useful reading includes AGI’s Guidelines for UK GEMINI Part 3 Metadata Quality @@ -68,9 +69,8 @@ Metadata Quality *GEMINI 2.3 note: the DMS Operational Guide, UK GEMINI Encoding Guidance and AGI's Guidelines - Part 2 have all been consolidated into this content. + -* -==== 1.4 Where to Obtain More Information +=== 1.4 Where to Obtain More Information The latest information, and additional resources, can be obtained by visiting the{nbsp}UK Location{nbsp}web site. @@ -78,7 +78,7 @@ visiting the{nbsp}UK Location{nbsp}web site. If you would like to contact the UK Location Coordination Unit, contact details are at{nbsp}http://data.gov.uk/location/contact_points -==== 1.5 Validation +=== 1.5 Validation ==== GEMINI 2.3 @@ -134,9 +134,10 @@ metadata may be misleading. With GEMINI 2.3,{nbsp}a second (supplemental) schematron is provided to test for recommendations. -=== [#schema_errors]####2. Schema errors +== 2. Schema errors +[#schema_errors] -==== 2.1 Confusion of Date and DateTime +=== 2.1 Confusion of Date and DateTime In ISO 19115, Date and DateTime are distinct types. Although in many elements, either is allowed, the XML encoding needs to be explicit about @@ -145,31 +146,33 @@ DateTime element. Example of invalid structure: -`` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} 2012-11-15` - -`` +[source,xml] +---- + + 2012-11-15 + +---- Examples of valid structure: This should either include the time, e.g. -`` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} 2012-11-15T13:50:38` - -`` +[source,xml] +---- + + 2012-11-15T13:50:38 + +---- Or be explicit that it doesn’t: +[source,xml] +---- + + 2012-11-15 + +---- -`` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} 2012-11-15` - -`` - -==== 2.2 Elements in the wrong order +=== 2.2 Elements in the wrong order Although there is no “logical” ordering of the elements in ISO 19115, INSPIRE, or GEMINI, the XML pattern adopted by ISO 19139 means that the @@ -181,13 +184,14 @@ used by GEMINI. The example found contained the ISO 19115 metadata characterSet element before the metadata language element. -=== [#ISO_errors]####3. ISO 19139 Schematron errors +== 3. ISO 19139 Schematron errors +[#ISO_errors] See -also{nbsp}https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service#soft_errors[“Empty +also{nbsp}link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html#soft_errors[“Empty strings”]. -==== 3.1 No level description +=== 3.1 No level description ISO 19115 requires that a “level description” is given for any quality statement that is not describing the “dataset” or “series” level. @@ -195,34 +199,26 @@ INSPIRE and GEMINI use the quality statement for both lineage and conformity. This means that any “service” record must provide a gmd:DQ_Scope/gmd:levelDescription element, such as: -`` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} service` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} Geographic web service` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`` +[source,xml] +---- + + + service + + + + + Geographic web service + + + + +---- A similar rule applies to “hierarchyLevelName”, which must be provided for any record that is not describing a dataset. -==== 3.4 No Format provided +=== 3.2 No Format provided ISO 19139 requires that a format is given, either within the “distribution” section or the “distributor” section. INSPIRE & UK GEMINI @@ -230,12 +226,13 @@ encoding guidance only expects the distribution section, as the place to encode the Resource locator, which effectively renders distribution format mandatory. -=== [#proc_errors]####4. Processing errors +== 4. Processing errors +[#proc_errors] These errors do not result in invalid records on an individual basis, but may well result in the wrong records being available to the public. -==== 4.1 Non-compliant Web Accessible Folder (WAF) +=== 4.1 Non-compliant Web Accessible Folder (WAF) The collection definition is very precise. Just because you can browse to a page that appears to contain the records, it does not mean that the @@ -245,7 +242,7 @@ links to records that are elsewhere. Similarly, collection differentiates between a single XML record at the end of a URL, and a WAF. -==== 4.2 FileIdentifier +=== 4.2 FileIdentifier This is the identifier for a metadata record through time, so do ensure that it remains the same when you update a record, and is different in @@ -257,7 +254,7 @@ the old one. If you accidently provide two records with the same identifier, one will replace the other. -==== 4.3 Metadata date +=== 4.3 Metadata date This is used to distinguish which of two records with the same fileIdentifier the system will keep. @@ -266,9 +263,10 @@ Even if the records are moved to a different server, if the fileIdentifier and metadata date are the same, the harvester will not collect the new files. -=== [#inspire_warnings]####5. European INSPIRE Geoportal errors & warnings +== 5. European INSPIRE Geoportal errors & warnings +[#inspire_warnings] -==== 5.1 Conformity statement missing +=== 5.1 Conformity statement missing INSPIRE requires a ‘conformity’ statement, which can say that the resource conforms, does not conform, or has not been evaluated against, @@ -284,7 +282,7 @@ incomplete but it is required”. This can be ignored. *GEMINI Consolidation Note: The INSPIRE Encoding Guidelines were updated in 2013; GEMINI 2.3 will be updated on this point.* -==== 5.2 Missing “coupled resource” +=== 5.2 Missing “coupled resource” INSPIRE requires “Coupled resource” to be populated “where relevant”. This effectively makes it mandatory for View & Download services, and @@ -292,9 +290,10 @@ the INSPIRE Geoportal reports this as a validation issue. However, the Geoportal also reports this issue for a Discovery service metadata record, where coupled resource is not mandatory. -=== [#soft_errors]####6. “Soft” errors +== 6. “Soft” errors +[#soft_errors] -==== 6.1 Empty strings +=== 6.1 Empty strings When first run, approximately half the rejections were down to this error. UK Location decided to remove this check, so the records can be @@ -312,36 +311,40 @@ empty”. The most common examples were structures like: -`` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`` - -(in this case, as gmd:phone is optional, it should be entirely missing) - -and - -`` +[source,xml] +---- + + + +---- -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` +(in this case, as gmd:phone is optional, it should be entirely missing), and: -`` +[source,xml] +---- + + + +---- Examples of valid structures are: -`` +[source,xml] +---- + +---- (although again, it would be equally valid to leave the element out entirely) -`` +[source,xml] +---- + + Explorer House, Adanac Drive + +---- -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} Explorer House, Adanac Drive` - -`` - -==== 6.2 Short relative URLs +=== 6.2 Short relative URLs The issues discussed here have just been noted whilst browsing the records in data.gov.uk @@ -352,37 +355,42 @@ mostly these are populated with a local path, which is then impossible to use once the dataset is harvested to any other location – even if it did work in the data publisher’s original location. For example: -`` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} Council_Housing_s.png` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} ` - -`{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp}{nbsp} …` - -`` +[source,xml] +---- + + + Council_Housing_s.png + + ... + +---- -==== 6.3 Incorrect code list URL +=== 6.3 Incorrect code list URL The INSPIRE encoding guidance, and therefore earlier versions of the GEMINI Encoding Guidance had a minor spelling (capitalisation) mistake in the path for the code list dictionary. This is used a number of times in most records. -`information` +[source,xml] +---- +information +---- Should be -`information` +[source,xml] +---- +information +---- (a lower case ‘c’ in the first occurrence of ‘codelist’ within the URL) *GEMINI Consolidation Note: The INSPIRE Encoding Guidelines have been updated to correct this, in 2016.* -=== [#winner]####7. And the winner? +== 7. And the winner? +[#winner] This table, for interest, gives the approximate error rate for each of the above errors, in the sample tested in late 2012. This does not diff --git a/docs/1054-operational-guide.asciidoc b/docs/1054-operational-guide.asciidoc index 46dce00..baab29f 100644 --- a/docs/1054-operational-guide.asciidoc +++ b/docs/1054-operational-guide.asciidoc @@ -1,99 +1,71 @@ -== Operational Guide += Operational Guide include::./includes/attributes.asciidoc[] == UK Location Discovery Metadata Service -Return -to{nbsp}https://www.agi.org.uk/gemini/40-gemini/1037-uk-gemini-standard-and-inspire-implementing-rules[GEMINI +Return to link:1037-uk-gemini-standard-and-inspire-implementing-rules.html[GEMINI 2.3 home page] Contents -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#Intro[1. -Introduction] +link:1054-operational-guide.html#Intro[1.Introduction] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#1.1[1.1 -Target audience] +link:1054-operational-guide.html#1.1[1.1 Target audience] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#1.2[1.2 -Assumed knowledge] +link:1054-operational-guide.html#1.2[1.2 Assumed knowledge] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#1.3[1.3 -DMS resources] +link:1054-operational-guide.html#1.3[1.3 DMS resources] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#1.4[1.4 -Where to obtain more information] +link:1054-operational-guide.html#1.4[1.4 Where to obtain more information] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#Pub_Dis_Met[2. -Publishing Discovery Metadata] +link:1054-operational-guide.html#Pub_Dis_Met[2. Publishing Discovery Metadata] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#2.1[2.1 -Requirements on data providers and publishers] +link:1054-operational-guide.html#2.1[2.1 Requirements on data providers and publishers] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#2.2[2.2 -Accountability] +link:1054-operational-guide.html#2.2[2.2 Accountability] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#2.3[2.3 -Publishing discovery metadata for data] +link:1054-operational-guide.html#2.3[2.3 Publishing discovery metadata for data] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#2.4[2.4 -Publishing discovery metadata for on-line services] +link:1054-operational-guide.html#2.4[2.4 Publishing discovery metadata for on-line services] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#2.5[2.5 -Maintaining discovery metadata] +link:1054-operational-guide.html#2.5[2.5 Maintaining discovery metadata] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#2.6[2.6 -Data sharing and charging and licensing] +link:1054-operational-guide.html#2.6[2.6 Data sharing and charging and licensing] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#Dis_Met_Req[3. -Discovery Metadata Requirements] +link:1054-operational-guide.html#Dis_Met_Req[3. Discovery Metadata Requirements] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#3.1[3.1 -Elements of importance to the DMS] +link:1054-operational-guide.html#3.1[3.1 Elements of importance to the DMS] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#3.2[3.2 -Data provider licence information] +link:1054-operational-guide.html#3.2[3.2 Data provider licence information] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#3.3[3.3 -Metadata encoding] +link:1054-operational-guide.html#3.3[3.3 Metadata encoding] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#3.4[3.4 -Metadata validation] +link:1054-operational-guide.html#3.4[3.4 Metadata validation] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#3.5[3.5 -Community extensions to UK GEMINI2] +link:1054-operational-guide.html#3.5[3.5 Community extensions to UK GEMINI2] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#3.6[3.6 -Extensions to code lists] +link:1054-operational-guide.html#3.6[3.6 Extensions to code lists] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#3.7[3.7 -Local guidance] +link:1054-operational-guide.html#3.7[3.7 Local guidance] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#Pub_Dis_Met_rec[4. -Publishing Discovery Metadata records] +link:1054-operational-guide.html#Pub_Dis_Met_rec[4. Publishing Discovery Metadata records] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#4.1[4.1 -Publishing discovery metadata records] +link:1054-operational-guide.html#4.1[4.1 Publishing discovery metadata records] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#4.2[4.2 -Registering the harvest location] +link:1054-operational-guide.html#4.2[4.2 Registering the harvest location] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#4.3[4.3 -Collection] +link:1054-operational-guide.html#4.3[4.3 Collection] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#Met_Pub_Tec[5. -Metadata Publishing and Technology Choices] +link:1054-operational-guide.html#Met_Pub_Tec[5. Metadata Publishing and Technology Choices] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#5.1[5.1 -UK Location metadata editor] +link:1054-operational-guide.html#5.1[5.1 UK Location metadata editor] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#5.2[5.2 -Geonetwork publishing solution] +link:1054-operational-guide.html#5.2[5.2 Geonetwork publishing solution] -https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#5.3[5.3 -Third party solutions] +link:1054-operational-guide.html#5.3[5.3 Third party solutions] -=== [#Intro]####1. Introduction +== 1. Introduction +[#Intro] The UK Location Discovery Metadata Service (DMS) lies at the heart of UK Location and the delivery of the UK Location Strategy and INSPIRE - 'to @@ -123,7 +95,8 @@ publishing mechanisms to those described here. Therefore in the first instance, please use the appropriate contact information listed under “Where to obtain more information” below. -==== *[#1.1]####1.1 Target Audience* +=== 1.1 Target Audience +[#1.1] The primary audience for the Guide are business managers and information officers, located within data provider organisations, and their @@ -137,33 +110,34 @@ The guide will also be of interest to anyone who requires a general understanding of the UK Location Discovery Metadata Service and how it is intended to operate. -==== *[#1.2]####1.2 Assumed Knowledge* +=== 1.2 Assumed Knowledge +[#1.2] This guide assumes that the reader is familiar with the creation and management of metadata and has read the UK Location “Getting Started' series of -guides[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[27]]. +guides[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[27]]. Readers requiring an introduction to discovery metadata for geospatial data resources are referred to the UK GEMINI guide -“https://www.agi.org.uk/gemini/40-gemini/1052-metadata-guidelines-for-geospatial-data-resources-part-1[Metadata +“link:1052-metadata-guidelines-for-geospatial-data-resources-part-1[Metadata Guidelines for Geospatial Data Resources, Introduction – Part -1]”[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[1]] +1]”[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[1]] . -===== *1.2.1 Do you know your “Data Provider” from your “Data Publisher”* +=== 1.2.1 Do you know your “Data Provider” from your “Data Publisher” Throughout this guide we refer to “Data Providers” and “Data Publishers”. Within UK Location, the definition and distinction being made between these two roles is very important.{nbsp} So what is the difference?: -====== The Data Provider +==== The Data Provider The organisation that creates the data and supplies the data for web publication, along with its metadata -====== The Data Publisher +==== The Data Publisher The organisation that publishes the data on the web and supplies data services to data users @@ -171,14 +145,16 @@ services to data users If you as a Data Provider publish directly, then you will perform both the roles of Data Provider and Data Publisher. -==== *[#1.3]####1.3 DMS Resources* +=== 1.3 DMS Resources +[#1.3] The latest versions of all the UK Location resources referred to in this guide can be found via the UK Location Resource Centre: https://data.gov.uk/[http://data.gov.uk/location] -==== *[#1.4]####1.4 Where to Obtain More Information* +=== 1.4 Where to Obtain More Information +[#1.4] The latest information, and additional resources, can be obtained by visiting the{nbsp}UK Location{nbsp}web site. @@ -206,7 +182,8 @@ E-mail:{nbsp}[#cloak0de48b02b62ff6b0733df4ab33e5b829]#mailto:Bill.Oates@wales.gs Email:{nbsp}[#cloak4e2ac9d8ddb12cb122f38a77142a18f4]#ProgrammeOffice@dfpni.gov.uk#{nbsp}or visit the{nbsp}Spatial NI{nbsp}website at{nbsp}https://www.spatialni.gov.uk/ -=== [#Pub_Dis_Met]####2. Publishing Discovery Metadata +== 2. Publishing Discovery Metadata +[#Pub_Dis_Met] Data Providers publish their data and on-line services into UK Location by creating and publishing discovery metadata. These resources are @@ -214,7 +191,8 @@ registered with UK Location and made discoverable through its central metadata catalogue, which forms part of the public data access portal, data.gov.uk. -==== *[#2.1]####2.1 Requirements on Data Providers and Publishers* +=== 2.1 Requirements on Data Providers and Publishers +[#2.1] Deciding to publish data into UK Location is a major commitment. INSPIRE and UK Location is not a simple cataloguing service of what data exists @@ -233,7 +211,7 @@ data.gov.uk the resources you publish, based on the feedback you receive, as this will be beneficial to both data provider and user * You -will{nbsp}https://www.agi.org.uk/gemini/40-gemini/1054-operational-guide#2.5[maintain +will{nbsp}link:1054-operational-guide.html#2.5[maintain your discovery metadata]: ** assuring its quality against appropriate standards ** reviewing it and updating it regularly and ensuring it is updated @@ -257,19 +235,20 @@ Coordination Unit * For all data: ** compliance with the INSPIRE Metadata Regulation -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[6]] +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[6]] and the UK Location operational requirements as set out in this guide ** if publishing INSPIRE Network (on-line) Services, compliance with the INSPIRE Network Services Regulation -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[9]] +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[9]] ** the publishing of INSPIRE View Services for a given dataset or data series * For data that comes under an INSPIRE Theme and contains features listed in the INSPIRE Data Specifications: ** legal compliance with the INSPIRE Directive -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[8]] +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[8]] -==== *[#2.2]####2.2 Accountability* +=== 2.2 Accountability +[#2.2] Accountability for publishing data and associated resources rests with you the Data Provider. If you are a Data Provider and are publishing @@ -279,7 +258,8 @@ services published.{nbsp} Accountability at all times remains with you as Data Provider, e.g. in relation to INSPIRE compliance and conformance to INSPIRE and UK Location technical guidance. -==== *[#2.3]####2.3 Publishing Discovery Metadata for Data* +=== 2.3 Publishing Discovery Metadata for Data +[#2.3] The process for publishing metadata records for data is shown as a process model below. @@ -329,7 +309,8 @@ becomes discoverable through the UK Location discovery service.{nbsp} If errors are found, then the Data Publisher will need to correct these and re-submit the resource. -==== *[#2.4]####2.4 Publishing Discovery Metadata for On-line Services* +=== 2.4 Publishing Discovery Metadata for On-line Services +[#2.4] The process for publishing metadata records for on-line services is shown as a process model below. @@ -356,7 +337,8 @@ Collection of the service metadata record is as for data, unless it is an existing service, in which case it will be an update of the existing registration. -==== *[#2.5]####2.5 Maintaining Discovery Metadata* +==== 2.5 Maintaining Discovery Metadata +[#2.5] UK Location requires that Data Providers and their Data Publishers maintain their published metadata records in line with the INSPIRE @@ -366,7 +348,8 @@ change your published dataset, or move the location of a resource e.g. view service, then you are responsible for ensuring that these changes are updated in your metadata. -==== *[#2.6]####2.6 Data Sharing and Charging and Licensing* +==== 2.6 Data Sharing and Charging and Licensing +[#2.6] Data sharing, including charging and licensing, 3rd party intellectual property, and e-commerce issues are covered under separate UK Location @@ -374,7 +357,8 @@ data sharing operational guidance. This is in the process of being published.{nbsp} Please visit the UK Location Resource Centre for more details. -=== [#Dis_Met_Req]####3. Discovery Metadata Requirements +== 3. Discovery Metadata Requirements +[#Dis_Met_Req] UK Location discovery metadata will be used by potential data users to discover and evaluate published location information for use in a range @@ -389,45 +373,47 @@ needs an application profile. *Considerable care needs to be taken over the creation of discovery metadata. It is strongly recommended that you use a metadata editor tool, that fully supports the encoding requirements defined in -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[28]] +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[28]] and uses the UK Location XSD and Schematron schemas -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[28,30]], +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[28,30]], to ensure that your metadata is fully compliant with UKL and INSPIRE requirements.* GEMINI 2.3 metadata is encoded in XML, as described in -the{nbsp}https://www.agi.org.uk/gemini/40-gemini/1048-uk-gemini-encoding-guidance[encoding +the{nbsp}link:1048-uk-gemini-encoding-guidance[encoding guidance{nbsp}]{nbsp}and a Schematron ruled-based validation Schema -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[30]] +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[30]] can be used to check these XML instances. For a detailed explanation of each element, please refer to -the{nbsp}https://www.agi.org.uk/gemini/40-gemini/1037-uk-gemini-standard-and-inspire-implementing-rules[UK +the{nbsp}link:1037-uk-gemini-standard-and-inspire-implementing-rules[UK GEMINI2 standard{nbsp}]and associated guidance. For metadata describing data (datasets and services), -click{nbsp}https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series[here]. +click{nbsp}link:1062-gemini-datasets-and-data-series[here]. For metadata describing services, -click{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services[here]. +click{nbsp}link:1063-gemini-services[here]. -==== [#3.1]####3.1 Elements of importance to the DMS +=== 3.1 Elements of importance to the DMS +[#3.1] Some metadata elements are particularly important to the operation of the DMS, rather than to the users of the DMS. -===== 3.1.1 Metadata record File Identifier +==== 3.1.1 Metadata record File Identifier To support the operation of UK Location and INSPIRE, discovery metadata records must include a File Identifier for the resource. The file identifier is the unique persistant identifier of the metadata record; it must not change when the record is updated. -===== 3.1.2 Metadata date +==== 3.1.2 Metadata date This must be updated when ever the metadata record is edited. Data.gov.uk harvesting will only collect the new record if the Metadata date is more recent than the old one. -===== [#data_servce_linking]####3.1.3 Data and Service Linking +==== 3.1.3 Data and Service Linking +[#data_servce_linking] UK Location and INSPIRE is a network of distributed on-line services that provide access to published location information. To provide this @@ -460,7 +446,8 @@ e.g.service=WMS&request=GetCapabilities&, or the location of further information about a service. |=== -==== *[#3.2]####3.2 Data Provider Licence information* +=== 3.2 Data Provider Licence information +[#3.2] The following Data Provider licensing information must be provided: @@ -479,15 +466,17 @@ categorise your data as open, ensure these licence titles are stated in the Use Constraints text field exactly as quoted here, for example “Open Government Licence”. -==== *[#3.3]####3.3 Metadata Encoding* +=== 3.3 Metadata Encoding +[#3.3] UK Location discovery metadata records must be published as an Extensible Markup Language (XML) document. This must follow -the{nbsp}https://www.agi.org.uk/gemini/40-gemini/1048-uk-gemini-encoding-guidance[UK +the{nbsp}link:1048-uk-gemini-encoding-guidance[UK Location UK GEMINI Encoding -Guidance]{nbsp}[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[28]]. +Guidance]{nbsp}[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3.html[28]]. -==== *[#3.4]####3.4 Metadata Validation* +=== 3.4 Metadata Validation +[#3.4] Published discovery metadata XML document resources will be validated in a three stage process, using: @@ -495,14 +484,15 @@ a three stage process, using: * The ISO XML schemas * The UK Location variant of the ISO Schematron rules * A{nbsp}UK Location GEMINI Schematron schema -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[30]] +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[30]] Data Publishers are required to validate their metadata records using these before resource registration. UK Location has published guidance on using its Schematron rules -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[29]]. +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[29]]. -==== *[#3.5]####3.5 Community Extensions to UK GEMINI2* +=== 3.5 Community Extensions to UK GEMINI2 +[#3.5] Within a given organisation or thematic community, there may be the need to record additional items of metadata to meet local requirements. @@ -514,7 +504,8 @@ UK Location will accept additional metadata elements within a metadata record XML document. These elements must be taken from ISO 19115 and be encoded in conformance with ISO 19139. -==== *[#3.7]####3.6 Extension to Code Lists* +=== 3.6 Extension to Code Lists +[#3.7] UK GEMINI2 includes a number of code lists taken from ISO 19115. Within a given organisation or thematic community, you may wish to extend these @@ -523,14 +514,16 @@ and/or UK Location specified code lists before they can be used.{nbsp} If you wish to extend a code list for an INSPIRE metadata element, please contact the UK Location Coordination Unit. -==== *[#3.7]####3.7 Local Guidance* +=== 3.7 Local Guidance +[#3.7] The type of data being published will have a strong bearing on the content of the metadata created. It is strongly recommended that data providers create local guidance, based on UK GEMINI2 and this operational guide. -=== [#Pub_Dis_Met_rec]####4. Publishing Discovery Metadata records +== 4. Publishing Discovery Metadata records +[#Pub_Dis_Met_rec] Publishing discovery metadata for UK Location for data and services is a three stage process: @@ -543,7 +536,8 @@ data.gov.uk collects the metadata records from the registered location, makes them available within data.gov.uk, and for further collection on to Europe. -==== *[#4.1]####4.1 Publishing Discovery Metadata records* +=== 4.1 Publishing Discovery Metadata records +[#4.1] This involves transferring your completed discovery metadata records to an on-line location, which can be machine accessed through the Internet. @@ -556,9 +550,9 @@ These mechanisms will be used by the Discovery Metadata Service, to collect registered discovery metadata records. For more information about this interface, please refer to the DMS Collection Interface Specification -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[26]]. +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[26]]. -===== 4.1.1 Discovery Metadata Harvest location +==== 4.1.1 Discovery Metadata Harvest location This can take a number of forms. It may be local to your business unit, or organisation, or a community resource, shared across a number of @@ -573,7 +567,7 @@ If publishing elsewhere, e.g. to thematic or regional catalogues and information portals, you should consider using this same control point – applying the ‘publish only once principle’. -====== *_Record Organisation_* +===== *_Record Organisation_* How you organise your records will be subject to your own local needs and practices. Possible catalogue/file directory structures include: @@ -605,7 +599,8 @@ If you have an immediate requirement for UK Location to support CSW Filtering, by category or element, please contact the UK Location Coordination Unit, using the contact form at:{nbsp}https://defra.gov.uk/. -==== *[#4.2]####4.2 Registering the harvest location* +=== 4.2 Registering the harvest location +[#4.2] UK Location discovery metadata records are registered using the UK Government data publishing and discovery @@ -624,7 +619,7 @@ records for data and services, using data.gov.uk, is shown below. image:https://www.agi.org.uk/images/xslt/RegisterDiscoveryMetadata.jpg[Register Discovery Metadata Records,width=960,height=720] -===== 4.2.1 Data.gov.uk Publisher Accounts +==== 4.2.1 Data.gov.uk Publisher Accounts Data and services are published against a registered organisation, e.g. government department or agency. This is the organisation{nbsp}*legally @@ -651,7 +646,7 @@ lets you edit publisher’s details (including name, description, and contact information), and authorize access for other users to be editor or administrator for the organisation. -====== *_Special Guidance for Third Party Publishers_* +==== *_Special Guidance for Third Party Publishers_* If you are a third party Data Publisher, i.e. publishing on behalf of a Data Provider, you will need to adopt a different approach for data and @@ -663,22 +658,22 @@ You will need to ensure that you have formal approval to publish from your Data Provider. This will be checked by The National Archives before approval is given. -====== *_Signing up for{nbsp}__data.gov.uk accounts_* +==== *_Signing up for{nbsp}__data.gov.uk accounts_* Before you can publish data and services on data.gov.uk, you will need to sign up and associate yourself with one or more Publishers. For further information, see the data.gov.uk User Guide -[https://www.agi.org.uk/gemini/40-gemini/1047-metadata-guidelines-for-geospatial-data-resources-part-3[31]] +[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[31]] -====== *_Creating a Publisher_* +==== *_Creating a Publisher_* If there is not an existing data.gov.uk Publisher for the UK Location Data Provider, you will need to contact the Cabinet Office data.gov.uk team to request the addition of your publisher: http://data.gov.uk/publisher/apply/cabinet-office -====== *_Publisher Administrators and Editors_* +==== *_Publisher Administrators and Editors_* Publishers are associated with two tiers of user: @@ -702,7 +697,7 @@ The addition of Administrators and Editors can only be done by the account Administrators; you can request this via the data.gov.uk site, or by contacting the account administrator directly. -===== 4.2.2 Registering Metadata Harvesting Resources +==== 4.2.2 Registering Metadata Harvesting Resources Having created an account on data.gov.uk and gained editor rights to the relevant Publisher, you are now in a position to register metadata @@ -739,14 +734,15 @@ at an interval specified by the Data Publisher * Response handling – automatic forwarding of error messages to an address specified by the Data Publisher, e.g. to a central error log -==== *[#4.3]####4.3 Collection* +=== 4.3 Collection +[#4.3] The collection task created as described above is only run when requested, that is, when you click the ‘Refresh’ button for that harvest source, which is on the list of harvesting sources visible to the administrators of the publisher. -===== 4.3.1 Validation +==== 4.3.1 Validation Once collected, the individual data and service discovery metadata records will be subject to the following validation checks: @@ -769,7 +765,7 @@ be added to the data.gov.uk metadata catalogue and the XML documents stored for subsequent use. Resources will take approximately 30 minutes to appear on data.gov.uk once successfully collected. -===== 4.3.2 Error Handling +==== 4.3.2 Error Handling If, having harvested from a metadata resource, the collection task fails, errors will be returned to the Discovery Metadata status panel. @@ -786,7 +782,7 @@ at{nbsp}http://inspire-geoportal.ec.europa.eu/proxybrowser/ProxyBrowser/; this includes validation reports on metadata records, services, and layers within services. -===== 4.3.3 Maintaining Registered Discovery Metadata records +==== 4.3.3 Maintaining Registered Discovery Metadata records To maintain previous discovery metadata registrations, first select [Data] then [Dataset Harvesting] from the Publisher tools sub-menu. @@ -805,7 +801,7 @@ at:{nbsp}http://location.defra.gov.uk/resources/contact-us/. the source. An updated record is one with the same file identifier, but a more recent metadata date. -====== *_Withdrawing Discovery Metadata records_* +==== *_Withdrawing Discovery Metadata records_* Once a discovery metadata record has been registered, the record should not be removed from the source location. If, in exceptional cases, you @@ -845,7 +841,7 @@ weblink and the unique Harvest GUID for the metadata record that you would like to withdraw, and email to the UK Location Helpdesk:{nbsp}[#cloak8b865acef497806498058eabbfa4f7da]#UKLocation.Helpdesk@defra.gsi.gov.uk# -====== *_Reinstating a withdrawn record_* +==== *_Reinstating a withdrawn record_* This should be an even rarer exception. If your harvest source contains a metadata record with the same file identifier as has been used before, @@ -853,7 +849,8 @@ but with a more recent metadata date, then when that record is harvested, it will be re-instated at data.gov.uk, and from there will appear in the Catalogue Publishing Service and the INSPIRE GeoPortal. -=== [#Met_Pub_Tec]####5. Metadata Publishing and Technology Choices +== 5. Metadata Publishing and Technology Choices +[#Met_Pub_Tec] There are a number of technical solution options that will help you create UK Location discovery metadata records and publish them to UK @@ -869,7 +866,8 @@ These options are outlined below. Using the information provided here, it is recommended that you then discuss your specific requirements with your IT department and/or system supplier. -==== *[#5.1]####5.1 UK Location Metadata Editor* +=== 5.1 UK Location Metadata Editor +[#5.1] UK Location includes its own Metadata Editor that can be used by Data Providers and Publishers to create compliant discovery metadata records. @@ -882,23 +880,25 @@ server-based installation of Geonetwork. For more information, to register for the on-line service or to download the configuration package, please visit the UK Location Resource Centre. -==== *[#5.2]####5.2 Geonetwork Publishing Solution* +=== 5.2 GeoNetwork Publishing Solution +[#5.2] -The use of Geonetwork as the basis for the UK Location Metadata Editor +The use of GeoNetwork as the basis for the UK Location Metadata Editor provides the option for Data Providers and Publishers to extend a local instance of the editor to provide cataloguing, change and release management and publishing (using CSW) services. This is all -out-of-the-box Geonetwork functionality.{nbsp} In addition, there are other -open source products that enable you to integrate Geonetwork with your +out-of-the-box GeoNetwork functionality.{nbsp} In addition, there are other +open source products that enable you to integrate GeoNetwork with your existing GIS and build a full data publishing environment, supporting the delivery of on-line services, e.g. View (WMS) and Download (WFS) services. -For more information on Geonetwork and links to other open source Geoweb +For more information on GeoNetwork and links to other open source Geoweb products, please visit:{nbsp}http://geonetwork-opensource.org/[http://geonetwork-opensource.org] -==== *[#5.3]####5.3 Third Party Solutions* +=== 5.3 Third Party Solutions +[#5.3] Most of the providers of Geospatial Information Systems provide metadata creation and publishing tools as part of their solution packages. @@ -907,7 +907,7 @@ UK Location have created a number of resources to help solution providers integrate the support for UK Location discovery metadata creation and publishing into these existing packages: -* https://www.agi.org.uk/gemini/40-gemini/1048-uk-gemini-encoding-guidance[UK +* link:1048-uk-gemini-encoding-guidance.html[UK GEMINI Encoding Guidance] * http://data.gov.uk/library/uk-gemini-schematron-schema-technical-guidance[UK GEMINI Schematron Schema and Guidance] diff --git a/docs/1055-uk-gemini-major-changes-since-1-0.asciidoc b/docs/1055-uk-gemini-major-changes-since-1-0.asciidoc index 77c3eb3..1af7b3b 100644 --- a/docs/1055-uk-gemini-major-changes-since-1-0.asciidoc +++ b/docs/1055-uk-gemini-major-changes-since-1-0.asciidoc @@ -1,8 +1,7 @@ -== UK GEMINI Changes Log += [[top]]UK GEMINI Changes Log include::./includes/attributes.asciidoc[] -Return -to{nbsp}https://www.agi.org.uk/gemini/40-gemini/1037-uk-gemini-standard-and-inspire-implementing-rules[GEMINI +Return to link:1037-uk-gemini-standard-and-inspire-implementing-rules.html[GEMINI 2.3 home page] == UK GEMINI 2.3 @@ -61,34 +60,34 @@ longer just be the century. ==== April 2020 Changed -the{nbsp}https://www.agi.org.uk/40-gemini/1048-uk-gemini-encoding-guidance[XML +the{nbsp}link:1048-uk-gemini-encoding-guidance.html[XML guidance]{nbsp}and examples to cope with the disappearance of the XML resources from{nbsp}http://standards.iso.org/ittf/PubliclyAvailableStandards/ISO_19139_Schemas/. The authoritative location is now on{nbsp}https://schemas.isotc211.org/. -Note: I didn't mark this as a revision to each element. +Note: this hasn't been marked as a revision to each element. Fixed example file on{nbsp}https://github.com/AGIGemini/Schematron[GitHub], and changed links to point there. -https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#53[Maintenance +link:1062-gemini-datasets-and-data-series.html#53[Maintenance information]: * corrected maximum multiplicity; * expanded the description of the domain -https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#25[Limitations +link:1062-gemini-datasets-and-data-series.html#25[Limitations on public access]: * clarified guidance on how to express more than one limitation, and added an example -https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#54[Metadata +link:1062-gemini-datasets-and-data-series.html#54[Metadata standard name]: * minor change to guidance and example -https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#41[Conformity]: +link:1062-gemini-datasets-and-data-series.html#41[Conformity]: * correct the description of what has changed in cases where the resource has not been tested against an INSPIRE specification @@ -98,68 +97,68 @@ relate to an INSPIRE document ==== January 2020 Added guidance for two additional -elements:{nbsp}https://www.agi.org.uk/1062-gemini-datasets-and-data-series#54[Metadata +elements:{nbsp}link:1062-gemini-datasets-and-data-series.html#54[Metadata standard name], -and{nbsp}https://www.agi.org.uk/1062-gemini-datasets-and-data-series#54[Metadata +and{nbsp}link:1062-gemini-datasets-and-data-series.html#54[Metadata standard version] -https://www.agi.org.uk/1062-gemini-datasets-and-data-series#6[Keyword]{nbsp}for +link:1062-gemini-datasets-and-data-series.html#6[Keyword]{nbsp}for INSPIRE theme: fixed the URL in the encoding example -https://www.agi.org.uk/1062-gemini-datasets-and-data-series#47[Hierarchy +link:1062-gemini-datasets-and-data-series.html#47[Hierarchy level name]: changed guidance and example to match INSPIRE. Note: this means the value is fixed depending on the value chosen for Resource type (Hierarchy level). + -https://www.agi.org.uk/1062-gemini-datasets-and-data-series#41[Conformity]{nbsp}to +link:1062-gemini-datasets-and-data-series.html#41[Conformity]{nbsp}to an INSPIRE specification: minor fix to guidance, and added a new 'known error' -https://www.agi.org.uk/1062-gemini-datasets-and-data-series#25[Limitations +link:1062-gemini-datasets-and-data-series.html#25[Limitations on public access]: improve guidance by listing the allowable INSPIRE reasons, with a hyperlink to the register ==== March 2019 Change -to{nbsp}https://www.agi.org.uk/40-gemini/1048-uk-gemini-encoding-guidance#2.1,[https://www.agi.org.uk/1048-uk-gemini-encoding-guidance#2.1,]{nbsp}to +to{nbsp}link:1048-uk-gemini-encoding-guidance#2.1,[1048-uk-gemini-encoding-guidance#2.1],{nbsp}to describe a wider choice of relevant XML Schema Definition Files (XSDs) that can be used to validate GEMINI instances. -https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#8[_Dataset_{nbsp}reference +link:1062-gemini-datasets-and-data-series.html#8[_Dataset_{nbsp}reference date]: removed mention of the maximum occurrence for service records, when viewing this element for dataset records. Corrected the INSPIRE "corresponding element" entry -for{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#41[Conformity],{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#4[Abstract],{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#5[Topic -category],{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#6[Keyword],{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#17[Spatial +for{nbsp}link:1062-gemini-datasets-and-data-series.html#41[Conformity],{nbsp}link:1062-gemini-datasets-and-data-series.html#4[Abstract],{nbsp}link:1062-gemini-datasets-and-data-series.html#5[Topic +category],{nbsp}link:1062-gemini-datasets-and-data-series.html#6[Keyword],{nbsp}link:1062-gemini-datasets-and-data-series.html#17[Spatial reference -system],{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#21[Data -format],{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#45[File -Identifier],{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#47[Hierarchy +system],{nbsp}link:1062-gemini-datasets-and-data-series.html#21[Data +format],{nbsp}link:1062-gemini-datasets-and-data-series.html#45[File +Identifier],{nbsp}link:1062-gemini-datasets-and-data-series.html#47[Hierarchy level name], -and{nbsp}https://www.agi.org.uk/40-gemini/1062-gemini-datasets-and-data-series#48[Quality +and{nbsp}link:1062-gemini-datasets-and-data-series.html#48[Quality scope]. Corrected the "corresponding element" entries for service elements to reference ISO 19119 -for{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services#15[Extent],{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services#16[Vertical +for{nbsp}link:1063-gemini-services.html#15[Extent],{nbsp}link:1063-gemini-services.html#16[Vertical extent -information],{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services#37[Spatial +information],{nbsp}link:1063-gemini-services.html#37[Spatial data service type], -and{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services#38[Coupled +and{nbsp}link:1063-gemini-services.html#38[Coupled resource]. Corrected the ISO 19139 "corresponding element" entries for service -elements{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services#15[Extent],{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services#16[Vertical +elements{nbsp}link:1063-gemini-services.html#15[Extent],{nbsp}link:1063-gemini-services.html#16[Vertical extent information], -and{nbsp}https://www.agi.org.uk/gemini/40-gemini/1063-gemini-services#18[Spatial +and{nbsp}link:1063-gemini-services.html#18[Spatial resolution] Corrected the ISO 19139 "corresponding element" entries -for{nbsp}https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#1[Title],{nbsp}https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#2[Alternative +for{nbsp}link:1062-gemini-datasets-and-data-series.html#1[Title],{nbsp}link:1062-gemini-datasets-and-data-series.html#2[Alternative title], -and{nbsp}https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#4[Abstract]. +and{nbsp}link:1062-gemini-datasets-and-data-series.html#4[Abstract]. _Note: these are all minor corrections of the way the element is referenced, rather than substantive changes to which element we consider @@ -176,10 +175,10 @@ should use it didn't. ==== October 2018 -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#27[Additional -information]{nbsp}(source) -and{nbsp}https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#19[Resource -locator]* +*link:1062-gemini-datasets-and-data-series.html#27[Additional +information]*{nbsp}(source) +and{nbsp}**link:1062-gemini-datasets-and-data-series.html#19[Resource +locator]** Clarified that, in line with the underlying ISO standards, Resource locator is for links to access the resource, or obtain more information @@ -199,7 +198,7 @@ than by citation or link. Note: additional information is not available for services. -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#36[Resource +*link:1062-gemini-datasets-and-data-series.html#36[Resource identifier]* Fixed two typos. @@ -209,26 +208,25 @@ another, into hyperlinks. ==== September 2018 -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#3[Dataset -language]{nbsp}and{nbsp}https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#33[metadata]https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#33[{nbsp}language]* +*link:1062-gemini-datasets-and-data-series.html#3[Dataset +language]*{nbsp}and{nbsp}**link:1062-gemini-datasets-and-data-series.html#33[metadata]link:1062-gemini-datasets-and-data-series.html#33[{nbsp}language]** Corrected the name of the Irish language. -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#17[Spatial +*link:1062-gemini-datasets-and-data-series.html#17[Spatial reference -system]{nbsp}and{nbsp}https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#48[Quality -scope] + -* +system]*{nbsp}and{nbsp}**link:1062-gemini-datasets-and-data-series.html#48[Quality +scope]** Corrected that there is an equivalent INSPIRE requirement, although not a 'named' metadata element. -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#25[Limitations +*link:1062-gemini-datasets-and-data-series.html#25[Limitations on public access]* Corrected the equivalent ISO 19115 & 19139 elements -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#26[Use +*link:1062-gemini-datasets-and-data-series.html#26[Use constraints]* Corrected encoding rules & examples, from "gmd:LegalConstraints" (which @@ -243,7 +241,7 @@ Corrected the equivalent ISO 19115 & 19139 elements. *Description of validation* Fixed the description in section 1.5 of -the{nbsp}https://www.agi.org.uk/gemini/40-gemini/1053-common-metadata-errors-uk-location-discovery-metadata-service[Common +the{nbsp}link:1053-common-metadata-errors-uk-location-discovery-metadata-service.html[Common Metadata Errors article], which only described the GEMINI 2.2 / UK Location / data.gov.uk validation. @@ -268,11 +266,10 @@ Metadata TG, not the Regulations ==== July 2018 -*https://www.agi.org.uk/40-gemini/1048-uk-gemini-encoding-guidance[UK +*link:1048-uk-gemini-encoding-guidance.html[UK GEMINI Encoding Guidance]* -*first line*: remove misleading phrase "using XSD schemas"* + -* +*first line*: remove misleading phrase "using XSD schemas" *section 2.2.14*: minor clarifications, and improved the placement of figure captions. @@ -280,19 +277,19 @@ figure captions. *Change log{nbsp}*(this article): reordered to bring newest to top; added this section (editorial changes) -https://www.agi.org.uk/gemini/40-gemini/1037-uk-gemini-standard-and-inspire-implementing-rules["*Home +link:1037-uk-gemini-standard-and-inspire-implementing-rules.html["*Home page*"]: fixed link to encoding guidance -*https://www.agi.org.uk/gemini/40-gemini/1052-metadata-guidelines-for-geospatial-data-resources-part-1[Guidelines +*link:1052-metadata-guidelines-for-geospatial-data-resources-part-1.html[Guidelines - part 1 Introduction to Metadata]*: clarifications & general update *All pages*: introduce a link back to the GEMINI 2.3 "home page". -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#3[Guidance +*link:1062-gemini-datasets-and-data-series.html#3[Guidance for element 3 Dataset language]*: fix typo in anchor text for ISO 639 link -*https://www.agi.org.uk/gemini/40-gemini/1062-gemini-datasets-and-data-series#44[Guidance +*link:1062-gemini-datasets-and-data-series.html#44[Guidance for element 44 Bounding box]*: fix typos in two domain sub element names == UK GEMINI 2.2 @@ -310,7 +307,7 @@ Box for which multiple occurrences are allowed. == UK GEMINI 2.1 -{nbsp}Resource language, Metadata language: +Resource language, Metadata language: * The code for the Ulster Scots language was changed to "sco". diff --git a/docs/1056-glossary.asciidoc b/docs/1056-glossary.asciidoc index 3556e38..8735f51 100644 --- a/docs/1056-glossary.asciidoc +++ b/docs/1056-glossary.asciidoc @@ -1,13 +1,13 @@ -= Glossary += [[top]]Glossary include::./includes/attributes.asciidoc[] -https://www.agi.org.uk/40-gemini/1056-glossary#A[A]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#B[B]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#C[C]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#D[D]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#E[E]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#F[F]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#G[G]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#H[H]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#I[I]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#J[J]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#K[K]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#L[L]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#M[M]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#N[N]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#O[O]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#P[P]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#Q[Q]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#R[R]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#S[S]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#T[T]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#U[U]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#V[V]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#W[W]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#X[X]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#Y[Y]{nbsp}https://www.agi.org.uk/40-gemini/1056-glossary#Z[Z] +<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<>{nbsp}<> -Return -to{nbsp}https://www.agi.org.uk/gemini/40-gemini/1037-uk-gemini-standard-and-inspire-implementing-rules[GEMINI +Return to link:1037-uk-gemini-standard-and-inspire-implementing-rules.html[GEMINI 2.3 home page] -[#A]##*acceptable quality level (AQL)* +*acceptable quality level (AQL)* +[#A] threshold value applied to the results of testing data quality to determine whether the data meets criteria determined from a standard, @@ -18,7 +18,8 @@ specification or user requirements acceptable quality level for aggregated results from a number of tests, e.g. 100% correct -[#C]##*Coordinate Reference System* +*Coordinate Reference System* +[#C] a coordinate system that is related to an object by a datum [ISO 19111] @@ -33,7 +34,8 @@ for OGC Catalogue Service. Note: see{nbsp}http://www.opengeospatial.org/standards/specifications/catalog -[#D]##*Data Provider* +*Data Provider* +[#D] the organisation that creates the data and supplies the data for web publication, along with its metadata. @@ -85,7 +87,8 @@ blocks of an XML document. It is not relevant in the context of GEMINI2 metadata instances where{nbsp}_XSD_{nbsp}schemas are used to define the structure of XML documents. -*[#E]####EDEN* +*EDEN* +[#E] l’Equipe D’Experts en Normalisation @@ -106,7 +109,8 @@ Note: examples are given of the use of EPSG{nbsp}__URI__s in{nbsp}_metadata instances_. This does not imply that the EPSG registry is the{nbsp}_de jure_{nbsp}registry of geodetic parameters for UK Location. -*[#G]####GEMET* +*GEMET* +[#G] General Multilingual Environmental Thesaurus. @@ -138,7 +142,8 @@ Geography Markup Language [ISO 19136] resolution in terms of density or frequency -*[#I]####INSPIRE* +*INSPIRE* +[#I] infrastructure for Spatial Information in Europe @@ -155,11 +160,13 @@ Notes: ISO Technical Committee 211 is responsible for standardisation in the field of digital geographic information. The home page of ISO / TC 211 is{nbsp}http://www.isotc211.org/ -*[#L]####location* +*location* +[#L] identifiable geographic place -*[#M]####metadata* +*metadata* +[#M] data about data [ISO 19115] @@ -195,7 +202,8 @@ service that supplies information about data resources identifiable set of metadata relating to a single data resource -*[#O]####OGC* +*OGC* +[#O] Open Geospatial Consortium. @@ -208,12 +216,14 @@ IT. See{nbsp}http://www.opengeospatial.org/ International Association of Oil and Gas Producers -*[#P]####profile* +*profile* +[#P] set of one or more base standards or subsets of base standards for a particular application -*[#Q]####quality assessment* +*quality assessment* +[#Q] review of quality of a data resource @@ -234,7 +244,8 @@ overall process for assessing and controlling quality value of a quality measure -*[#S]####Schematron* +*Schematron* +[#S] a{nbsp}language for making assertions about patterns in XML documents; ISO 19757 Document Schema Definition Language @@ -251,7 +262,8 @@ Spatial Reference System. Note: a system for specifying position in the real world [ISO 19112] -*[#U]####UK Information Infrastructure* +*UK Information Infrastructure* +[#U] Infrastructure for the publication of location information as part of the implementation of the UK Location Strategy.{nbsp} Incorporates the UK @@ -301,7 +313,8 @@ generated twice by any computer in existence. * Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx * Example: 3ce4f380-b394-4e5d-b222-6914ea311156 -*[#W]####WAF* +*WAF* +[#W] a Web Accessible Folder (WAF) is an HTTP accessible directory of files @@ -318,7 +331,8 @@ Web Mapping Service Web Feature Service -*[#X]####XLink* +*XLink* +[#X] XML Linking Language @@ -354,8 +368,6 @@ XML Schema Definition language. Note: an XSD is a document written in XML that defines the structure of an XML document. -_Last updated: March 2017_ - http://creativecommons.org/licenses/by/4.0/[image:https://i.creativecommons.org/l/by/4.0/88x31.png[Creative Commons Licence]] + This work is licensed under diff --git a/docs/datasets.adoc b/docs/1062-gemini-datasets-and-data-series.adoc similarity index 96% rename from docs/datasets.adoc rename to docs/1062-gemini-datasets-and-data-series.adoc index f19bef9..013c881 100644 --- a/docs/datasets.adoc +++ b/docs/1062-gemini-datasets-and-data-series.adoc @@ -1,6 +1,5 @@ -== [[top]]UK GEMINI 2.3 2020-04-07 dataset or series dev version - -include::includes/attributes.asciidoc[] += [[top]]UK GEMINI 2.3 2020-04-07 dataset or series dev version +include::./includes/attributes.asciidoc[] == Contents diff --git a/docs/services.adoc b/docs/1063-gemini-services.adoc similarity index 68% rename from docs/services.adoc rename to docs/1063-gemini-services.adoc index c94ef14..45dddfd 100644 --- a/docs/services.adoc +++ b/docs/1063-gemini-services.adoc @@ -1,4 +1,4 @@ -== [[top]]UK GEMINI 2.3 2020-04-07 service += [[top]]UK GEMINI 2.3 2020-04-07 service include::./includes/attributes.asciidoc[] == Contents @@ -6,65 +6,35 @@ include::./includes/attributes.asciidoc[] [width="100%",cols="50%,50%",options="header",] |=== |Metadata about the metadata record |Metadata about the resource -|<<45, File Identifier>> -|<<4, Abstract>> - -|<<47, Hierarchy level name>> -|<<2, Alternative title>> - -|<<30, Metadata date>> -|<<44, Bounding box>> - -|<<33, Metadata language>> -|<<41, Conformity>> - -|<<35, Metadata point of contact>> -|<<38, Coupled resource>> - -|<<54, Metadata standard name>> -|<<8, Dataset reference date>> - -|<<55, Metadata standard version>> -|<<43, Equivalent scale>> - -|<<49, Parent identifier>> -|<<15, Extent>> - -|<<39, Resource type>> -|<<6, Keyword>> - -| -|<<25, Limitations on public access>> - -| -|<<48, Quality scope>> - -| -|<<19, Resource locator>> - -| -|<<23, Responsible organisation>> - -| -|<<37, Spatial data service type>> - -| -|<<17, Spatial reference system>> - -| -|<<18, Spatial resolution>> - -| -|<<7, Temporal extent>> - -| -|<<1, Title>> - -| -|<<26, Use constraints>> - -| -|<<16, Vertical extent information>> +|<<45, File Identifier>> + +<<47, Hierarchy level name>> + +<<30, Metadata date>> + +<<33, Metadata language>> + +<<35, Metadata point of contact>> + +<<54, Metadata standard name>> + +<<55, Metadata standard version>> + +<<39, Resource type>> + +|<<4, Abstract>> + +<<2, Alternative title>> + +<<44, Bounding box>> + +<<41, Conformity>> + +<<38, Coupled resource>> + +<<8, Dataset reference date>> + +<<43, Equivalent scale>> + +<<49, Parent identifier>> + +<<15, Extent>> + +<<6, Keyword>> + +<<25, Limitations on public access>> + +<<48, Quality scope>> + +<<19, Resource locator>> + +<<23, Responsible organisation>> + +<<37, Spatial data service type>> + +<<17, Spatial reference system>> + +<<18, Spatial resolution>> + +<<7, Temporal extent>> + +<<1, Title>> + +<<26, Use constraints>> + +<<16, Vertical extent information>> + |=== Return to link:1037-uk-gemini-standard-and-inspire-implementing-rules.html[GEMINI diff --git a/docs/1250-element-summary.asciidoc b/docs/1250-element-summary.asciidoc new file mode 100644 index 0000000..a982fff --- /dev/null +++ b/docs/1250-element-summary.asciidoc @@ -0,0 +1,115 @@ += Element Summary +include::./includes/attributes.asciidoc[] + +Return +to{nbsp}link:1037-uk-gemini-standard-and-inspire-implementing-rules.html[GEMINI +2.3 home page] + +[cols=",,,,,,",] +|=== +|UK GEMINI id |Element name |Obligation |Number of occurrences |Dataset +and series |Service |Revision date + +|1 |Title |Mandatory |Single |✓ |✓ |March 2019 + +|2 |Alternative title |Optional |Multiple |✓ |✓ |April 2020 + +|3 |Dataset language |Mandatory |Multiple |✓ |n/a |September 2018 + +|4 |Abstract |Mandatory |Single |✓ |✓ |March 2019 + +|5 |Topic Category |Mandatory when the data resource is a dataset or +dataset series. Not applicable to services. |Multiple |✓ |n/a |March +2019 + +|6 |Keyword |Mandatory |Multiple |✓ |✓ |May 2019 + +|7 |Temporal extent |Mandatory for datasets and dataset series |Multiple +|✓ |✓ |May 2018 + +|8 |Dataset reference date |Mandatory |Multiple |✓ |✓ |March 2019 + +|10 |Lineage |Mandatory |Single |✓ |n/a |March 2019 + +|15 |Extent |Optional |Multiple |✓ |✓ |August 2010 + +|16 |Vertical extent information |Optional |Multiple |✓ |✓ |March 2019 + +|17 |Spatial reference system |At least one coordinate reference system +shall be given |Multiple |✓ |✓ |March 2019 + +|18 |Spatial resolution |Conditional - where a resolution distance can +be specified |Multiple |✓ |✓ |March 2019 + +|19 |Resource locator |Conditional - Must be supplied when online access +is available |Multiple |✓ |✓ |July 2009 + +|21 |Data format |Mandatory |Multiple |✓ |n/a |March 2019 + +|23 |Responsible organisation |Mandatory |Multiple |✓ |✓ |July 2009 + +|25 |Limitations on public access |Mandatory |Multiple |✓ |✓ |January +2020 + +|26 |Use constraints |Mandatory |Multiple |✓ |✓ |September 2018 + +|27 |Additional information |Optional |Single |✓ |n/a |October 2018 + +|30 |Metadata date* |Mandatory |Single |✓ |✓ |May 2018 + +|33 |Metadata language* |Mandatory |Single |✓ |✓ |September 2018 + +|35 |Metadata point of contact* |Mandatory |Multiple |✓ |✓ |July 2009 + +|36 |Resource identifier |Mandatory for datasets and dataset series +|Multiple |✓ |n/a |May 2018 + +|37 |Spatial data service type |Mandatory |Single |n/a |✓ |July 2009 + +|38 |Coupled resource |Conditional - mandatory for View and Download +services, optional for other service types. |Multiple |n/a |✓ |March +2019 + +|39 |Resource type* |Mandatory |Single |✓ |✓ |July 2009 + +|41 |Conformity |Mandatory |Multiple |✓ |✓ |April 2020 + +|43 |Equivalent scale |Optional |Multiple |✓ |✓ |July 2009 + +|44 |Bounding box |Mandatory |Multiple |✓ |✓ |December 2012 + +|45 |File Identifier* |Mandatory |Single |✓ |✓ |March 2019 + +|47 |Hierarchy level name* |Conditional, required when Resource type +(ISO hierarchyLevel) is not "dataset". |Single |✓ |✓ |April 2020 + +|48 |Quality scope |Mandatory |Multiple |✓ |✓ |March 2019 + +|49 |Parent identifier* |Optional |Single |✓ |✓ |May 2018 + +|50 |Spatial representation type |Mandatory |Multiple |✓ |n/a |May 2018 + +|51 |Character encoding |Conditional (mandatory if an encoding is used +that is not based on UTF-8, otherwise optional) |Multiple |✓ |n/a |May +2018 + +|52 |Data quality |Conditional: Topological consistency report is +mandatory if the dataset includes types from the INSPIRE Generic Network +Model and does not assure centerline topology (connectivity of +centrelines) for the network, otherwise optional |Multiple |✓ |n/a |May +2018 + +|53 |Maintenance information |Optional |Single |✓ |n/a |April 2020 + +|54 |Metadata standard name* |Optional |Single |✓ |✓ |January 2020 + +|55 |Metadata standard version* |Optional |Single |✓ |✓ |January 2020 +|=== + +* indicates metadata on metadata + +Note. Element numbers 9, 11, 12, 13, 14, 20, 22, 28, 29, 31, 32, 40 and +42 have been omitted because they were used to identify elements that +have now been deleted from the Standard, and have not been reallocated +to avoid confusion. + diff --git a/docs/Gemini.css b/docs/Gemini.css deleted file mode 100644 index 838f6fd..0000000 --- a/docs/Gemini.css +++ /dev/null @@ -1,89 +0,0 @@ - .gem .box { - display:block; - padding:9.5px; - margin:20px 0 10px; - font-size:16px; - line-height:1.5; - color:#333; - word-break:break-all; - word-wrap:break-word; - background-color:#f5f5f5; - border:1px solid #ccc; - border-radius:4px - } - .gem .spacer { padding-bottom: 80px } - .gem .box a { - text-decoration:none; - color:inherit; - } - .gem .readmore { - padding-left:10px; - } - .gem .readmore a { - cursor:pointer; - } - .gem .gemini-list { - /* background:#e5e1e0; */ - padding:10px 0; - border-top:1px solid #7f7f7f; - border-bottom:1px solid #7f7f7f; - margin-bottom:20px; - } - .gem .gemini-item { - border-bottom:1px solid #7f7f7f; - padding-bottom:15px; - margin-bottom:15px; - } - .gem .gemini-expander { - display: none; - } - .gem .gemini-mono { - font-size:12px; - font-weight:bold; - } - .gem .gemini-xml { - font-family: monospace; - font-size:12px; - color:red; - } - # moved - .gem pre { - font-family: monospace; - font-size:12px; - color:red; - overflow: auto; - word-wrap: normal; - white-space: pre; - } - # moved - .gem table { - border: 1px solid #ddd; - border-collapse: collapse; - margin:15px 0; - } - .gem table table { - margin:0; - } - .gem th, - .gem td { - border: 1px solid #ddd; - padding: 3px; - text-align: left; - vertical-align: top; - font-size:12px; - } - .gem .thOther { - background-color: #7f7f7f; - color: white; - } - .gem .tbold { - font-size:12px; - font-weight:bold; - background-color: #7f7f7f; - color: white; - } - .gem .tgrey { - font-size:12px; - background-color: #cdcdcd; - color: grey; - } diff --git a/docs/README.md b/docs/README.md index 3411357..5de8b16 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,8 @@ # Gemini documentation DEV branch -* [Services](https://agiorguk.github.io/gemini-dev/services.html) -* [Datasets](https://agiorguk.github.io/gemini-dev/datasets.html) +* [Services](https://agiorguk.github.io/gemini-dev/1063-gemini-services.html) +* [Datasets](https://agiorguk.github.io/gemini-dev/1062-gemini-datasets-and-data-series.html) The files below have been converted but have not been altered to work using the new workflow. Consequently internal links will go to the agi website and there may be other errors. * [1037-uk-gemini-standard-and-inspire-implementing-rules](https://agiorguk.github.io/gemini-dev/1037-uk-gemini-standard-and-inspire-implementing-rules.html) @@ -14,6 +14,8 @@ The files below have been converted but have not been altered to work using the * [1054-operational-guide](https://agiorguk.github.io/gemini-dev/1054-operational-guide.html) * [1055-uk-gemini-major-changes-since-1-0](https://agiorguk.github.io/gemini-dev/1055-uk-gemini-major-changes-since-1-0.html) * [1056-glossary](https://agiorguk.github.io/gemini-dev/1056-glossary.html) +* [1046-xml-element-order](https://agiorguk.github.io/gemini-dev/1046-xml-element-order.html) +* [1250-element-summary](https://agiorguk.github.io/gemini-dev/1250-element-summary.html) Links above this are to the GitHub pages published in https://agiorguk.github.io/gemini-dev/ @@ -29,13 +31,13 @@ Where content differs between datasets and services, an [asciidoctor conditional To generate using the asciidoctor docker container, use the `-a` parameter, from the docs folder: ``` -docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -a stylesheet=./assets/gemini.css -a variant-dataset *.adoc +docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -a stylesheet=./assets/gemini.css -T templates -E slim -a variant-dataset *.adoc *.asciidoc ``` Then repeat for services: ``` -docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -a stylesheet=./assets/gemini.css -a variant-service *.adoc +docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -a stylesheet=./assets/gemini.css -T templates -E slim -a variant-service *.adoc *.asciidoc ``` ## Styling diff --git a/docs/assets/gemini.css b/docs/assets/gemini.css index e8502d3..6c6f079 100644 --- a/docs/assets/gemini.css +++ b/docs/assets/gemini.css @@ -17,15 +17,40 @@ table th, table td { } table { - border: 1px solid #f2f2​f2; + border: 1px solid #f2f2f2; } details { color: rgb(40,158,197); cursor: pointer; - list-style: disclosure-closed inside; + /*list-style: disclosure-closed inside;*/ } details .content { color: rgb(103, 97, 97); -} \ No newline at end of file +} + +/*.highlight pre { + background-color: transparent !important; + white-space: normal; +} */ + +code[data-lang="xml"] { + font-size: 0.75em !important; + white-space: pre !important; + line-height: 1.0 !important; + background-color: transparent !important; +} + +#content { + max-width: 1500px; + margin-right: auto; + margin-left: auto; +} + +#header { + max-width: 1500px; + margin-right: auto; + margin-left: auto; +} + diff --git a/docs/assets/pygments-default.css b/docs/assets/pygments-default.css new file mode 100644 index 0000000..089a2d2 --- /dev/null +++ b/docs/assets/pygments-default.css @@ -0,0 +1,69 @@ +pre.pygments .hll { background-color: #ffffcc } +pre.pygments { background: #f8f8f8; } +pre.pygments .tok-c { color: #408080; font-style: italic } /* Comment */ +pre.pygments .tok-err { border: 1px solid #FF0000 } /* Error */ +pre.pygments .tok-k { color: #008000; font-weight: bold } /* Keyword */ +pre.pygments .tok-o { color: #666666 } /* Operator */ +pre.pygments .tok-ch { color: #408080; font-style: italic } /* Comment.Hashbang */ +pre.pygments .tok-cm { color: #408080; font-style: italic } /* Comment.Multiline */ +pre.pygments .tok-cp { color: #BC7A00 } /* Comment.Preproc */ +pre.pygments .tok-cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ +pre.pygments .tok-c1 { color: #408080; font-style: italic } /* Comment.Single */ +pre.pygments .tok-cs { color: #408080; font-style: italic } /* Comment.Special */ +pre.pygments .tok-gd { color: #A00000 } /* Generic.Deleted */ +pre.pygments .tok-ge { font-style: italic } /* Generic.Emph */ +pre.pygments .tok-gr { color: #FF0000 } /* Generic.Error */ +pre.pygments .tok-gh { color: #000080; font-weight: bold } /* Generic.Heading */ +pre.pygments .tok-gi { color: #00A000 } /* Generic.Inserted */ +pre.pygments .tok-go { color: #888888 } /* Generic.Output */ +pre.pygments .tok-gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +pre.pygments .tok-gs { font-weight: bold } /* Generic.Strong */ +pre.pygments .tok-gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +pre.pygments .tok-gt { color: #0044DD } /* Generic.Traceback */ +pre.pygments .tok-kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +pre.pygments .tok-kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +pre.pygments .tok-kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +pre.pygments .tok-kp { color: #008000 } /* Keyword.Pseudo */ +pre.pygments .tok-kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +pre.pygments .tok-kt { color: #B00040 } /* Keyword.Type */ +pre.pygments .tok-m { color: #666666 } /* Literal.Number */ +pre.pygments .tok-s { color: #BA2121 } /* Literal.String */ +pre.pygments .tok-na { color: #7D9029 } /* Name.Attribute */ +pre.pygments .tok-nb { color: #008000 } /* Name.Builtin */ +pre.pygments .tok-nc { color: #0000FF; font-weight: bold } /* Name.Class */ +pre.pygments .tok-no { color: #880000 } /* Name.Constant */ +pre.pygments .tok-nd { color: #AA22FF } /* Name.Decorator */ +pre.pygments .tok-ni { color: #999999; font-weight: bold } /* Name.Entity */ +pre.pygments .tok-ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +pre.pygments .tok-nf { color: #0000FF } /* Name.Function */ +pre.pygments .tok-nl { color: #A0A000 } /* Name.Label */ +pre.pygments .tok-nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +pre.pygments .tok-nt { color: #008000; font-weight: bold } /* Name.Tag */ +pre.pygments .tok-nv { color: #19177C } /* Name.Variable */ +pre.pygments .tok-ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +pre.pygments .tok-w { color: #bbbbbb } /* Text.Whitespace */ +pre.pygments .tok-mb { color: #666666 } /* Literal.Number.Bin */ +pre.pygments .tok-mf { color: #666666 } /* Literal.Number.Float */ +pre.pygments .tok-mh { color: #666666 } /* Literal.Number.Hex */ +pre.pygments .tok-mi { color: #666666 } /* Literal.Number.Integer */ +pre.pygments .tok-mo { color: #666666 } /* Literal.Number.Oct */ +pre.pygments .tok-sa { color: #BA2121 } /* Literal.String.Affix */ +pre.pygments .tok-sb { color: #BA2121 } /* Literal.String.Backtick */ +pre.pygments .tok-sc { color: #BA2121 } /* Literal.String.Char */ +pre.pygments .tok-dl { color: #BA2121 } /* Literal.String.Delimiter */ +pre.pygments .tok-sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +pre.pygments .tok-s2 { color: #BA2121 } /* Literal.String.Double */ +pre.pygments .tok-se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +pre.pygments .tok-sh { color: #BA2121 } /* Literal.String.Heredoc */ +pre.pygments .tok-si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +pre.pygments .tok-sx { color: #008000 } /* Literal.String.Other */ +pre.pygments .tok-sr { color: #BB6688 } /* Literal.String.Regex */ +pre.pygments .tok-s1 { color: #BA2121 } /* Literal.String.Single */ +pre.pygments .tok-ss { color: #19177C } /* Literal.String.Symbol */ +pre.pygments .tok-bp { color: #008000 } /* Name.Builtin.Pseudo */ +pre.pygments .tok-fm { color: #0000FF } /* Name.Function.Magic */ +pre.pygments .tok-vc { color: #19177C } /* Name.Variable.Class */ +pre.pygments .tok-vg { color: #19177C } /* Name.Variable.Global */ +pre.pygments .tok-vi { color: #19177C } /* Name.Variable.Instance */ +pre.pygments .tok-vm { color: #19177C } /* Name.Variable.Magic */ +pre.pygments .tok-il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/highlighttest.adoc b/docs/highlighttest.adoc new file mode 100644 index 0000000..55615e4 --- /dev/null +++ b/docs/highlighttest.adoc @@ -0,0 +1,4 @@ += Testing syntax highlighting for text in tables +include::./includes/attributes.asciidoc[] + +include::./partials/abstract.asciidoc[] diff --git a/docs/includes/attributes.asciidoc b/docs/includes/attributes.asciidoc index f6d997e..4d4e458 100644 --- a/docs/includes/attributes.asciidoc +++ b/docs/includes/attributes.asciidoc @@ -1,13 +1,8 @@ -:assetdir: ./assets -:stylesdir: {assetdir} +:stylesdir: assets :figure-caption: Figure -:toc: left :docinfo: shared -:safe-mode-unsafe: :iconfont-remote!: :stylesheet: gemini.css -:scriptsdir: {assetdir} -:linkcss: :data-uri: :iconfont-name: font-awesome.min :imagesdir: media @@ -15,6 +10,6 @@ :sectnumlevels: 3 :sectlinks: :sectanchors: -:experimental: -:stem: -:toclevels: 4 \ No newline at end of file +:toclevels: 4 +:source-highlighter: pygments +:pygments-style: default diff --git a/docs/partials/abstract.asciidoc b/docs/partials/abstract.asciidoc index 5e32934..b1b5e25 100644 --- a/docs/partials/abstract.asciidoc +++ b/docs/partials/abstract.asciidoc @@ -1,4 +1,4 @@ -= Abstract +== Abstract include::includes/partials-attributes.adoc[] [#4] @@ -82,20 +82,20 @@ Change history... .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines |Cannot be empty - -|Example a| - -.... +| Guidelines | Cannot be empty +| Example +| +[source,xml] +---- ifdef::variant-dataset[] include::../snippets/dataset-abstract.xml[] endif::[] ifdef::variant-service[] include::../snippets/service-abstract.xml[] endif::[] -.... - +---- |=== ==== diff --git a/docs/partials/additionalinformation.asciidoc b/docs/partials/additionalinformation.asciidoc index bc69d03..68590b9 100644 --- a/docs/partials/additionalinformation.asciidoc +++ b/docs/partials/additionalinformation.asciidoc @@ -1,4 +1,4 @@ -= Additional information +== Additional information include::includes/partials-attributes.adoc[] [#27] @@ -65,23 +65,22 @@ MD_DataIdentification.supplementalInformation |Equivalent .Encoding guidelines... [%collapsible] ==== -[width="100%",cols="50%,50%",] +[cols="a,a"] |=== |Guidelines |No specific rules for this metadata element - -|Example a| -Example one - -.... +|Example One +| +[source,xml] +---- include::../snippets/additionalinformation-characterstring.xml[] -.... - -Example two - a link, using gmx:Anchor - -.... +---- +|Example two - a link, using gmx:Anchor +| +[source,xml] +---- include::../snippets/additionalinformation-anchor.xml[] .... - +---- |=== ==== diff --git a/docs/partials/alternatetitle.asciidoc b/docs/partials/alternatetitle.asciidoc index 26e0238..de7e2cb 100644 --- a/docs/partials/alternatetitle.asciidoc +++ b/docs/partials/alternatetitle.asciidoc @@ -1,4 +1,4 @@ -= Alternative title +== Alternative title include::includes/partials-attributes.adoc[] [#2] @@ -63,35 +63,43 @@ endif::[] ==== .Change history... -[%collapsible]ncoding guidelines... +[%collapsible] +==== +==== +.Encoding guidelines... [%collapsible] ==== -[width="100%",cols="50%,50%",] +[cols="a,a"] |=== |Guidelines |Note that more than one alternative title may be presented, as shown in the example below. - -|Example a| +|Example ifdef::variant-dataset[] -Example one -.... +| +|Example one +| +[source,xml] +---- include::../snippets/dataset-alternatetitle-multi.xml[] -.... - -Example two - -.... +---- +|Example two +| +[source,xml] +---- include::../snippets/dataset-alternatetitle-multi.xml[] -.... +---- +|=== endif::[] ifdef::variant-service[] -.... +| +[source,xml] +---- include::../snippets/service-alternatetitle-multi.xml[] .... -endif::[] - +---- |=== +endif::[] ==== .Metadata errors observed... diff --git a/docs/partials/boundingbox.asciidoc b/docs/partials/boundingbox.asciidoc index a13c081..70ec692 100644 --- a/docs/partials/boundingbox.asciidoc +++ b/docs/partials/boundingbox.asciidoc @@ -1,4 +1,4 @@ -= Bounding box +== Bounding box include::includes/partials-attributes.adoc[] [#44] @@ -105,8 +105,10 @@ Bounding box, which was made multiple .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . The encoding example for geographic bounding box for datasets is shown in the example . Note that the extent XML element is in the gmd namespace. This differs @@ -129,18 +131,17 @@ property of MD_DataIdentification (ISO 19115) and SV_ServiceIdentification (ISO 19119/Amd 1:2008), not a property of the parent MD_Identification. endif::[] - -|Example a| - -.... +|Example +| +[source,xml] +---- ifdef::variant-dataset[] include::../snippets/dataset-boundingbox.xml[] endif::[] ifdef::variant-service[] include::../snippets/service-boundingbox.xml[] endif::[] -.... - +---- |=== ==== diff --git a/docs/partials/characterencoding.asciidoc b/docs/partials/characterencoding.asciidoc index a2909e7..3c74364 100644 --- a/docs/partials/characterencoding.asciidoc +++ b/docs/partials/characterencoding.asciidoc @@ -1,4 +1,4 @@ -= Character encoding +== Character encoding include::includes/partials-attributes.adoc[] [#51] @@ -59,16 +59,16 @@ New element in GEMINI 2.3 .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |Only the codeListValue is required, the codeList and the free text content are optional and informative only - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/characterencoding.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/conformity.asciidoc b/docs/partials/conformity.asciidoc index 814e8c8..926c133 100644 --- a/docs/partials/conformity.asciidoc +++ b/docs/partials/conformity.asciidoc @@ -1,4 +1,4 @@ -= Conformity +== Conformity include::includes/partials-attributes.adoc[] [#41] @@ -124,9 +124,10 @@ been tested against the relevant INSPIRE specification .Encoding guidelines... [%collapsible] ==== -[width="100%",cols="50%,50%",] +[cols="a,a"] |=== -|Guidelines a| +| Guidelines +| . The encoding for Conformity is shown in the example. . Note that the encoding of conformity requires a specification (encoded using gmd:CI_Citation), an explanation and a pass. @@ -134,7 +135,6 @@ using gmd:CI_Citation), an explanation and a pass. possible conformance results: conformant, not conformant and not evaluated. Not evaluated is expressed by a conformity statement with a nilReason (unknown) specified in the pass element. - ifdef::variant-dataset[] . All gmd:dataQualityInfo XML element shall have a gmd:scope XML element, set to 'dataset' or 'series' as appropriate. @@ -146,35 +146,38 @@ element, set to 'service'. information is 'service' then the gmd:levelDescription XML element is required, as shown below. endif::[] -|Example a| - -.... +|Example +| +[source,xml] +---- ifdef::variant-dataset[] include::../snippets/dataset-conformity-inspire-ortho.xml[] +---- endif::[] ifdef::variant-service[] include::../snippets/service-conformity-abstracttestsuite.xml[] +---- +|=== endif::[] -.... ifdef::variant-dataset[] - -Example of a conformity report for Implementing Rule 1089/2010, where +| Example of a conformity report for Implementing Rule 1089/2010, where conformance is not evaluated. + Example follows updated guidance to use gmx:Anchor over gco:CharacterString for Citation titles - -.... +| +[source,xml] +---- include::../snippets/dataset-conformity-inspire-notevaluated.xml[] -.... - -Example three ~ Topological consistency, showing mandatory elements for +---- +| Example three ~ Topological consistency, showing mandatory elements for a descriptive topological consistency report - -.... +| +[source,xml] +---- include::../snippets/dataset-conformity-inspire-topo.xml[] -.... -endif::[] +---- |=== +endif::[] ==== .Metadata errors observed... diff --git a/docs/partials/coupledresource.asciidoc b/docs/partials/coupledresource.asciidoc index eb04801..49db919 100644 --- a/docs/partials/coupledresource.asciidoc +++ b/docs/partials/coupledresource.asciidoc @@ -1,4 +1,4 @@ -= Coupled resource +== Coupled resource include::includes/partials-attributes.adoc[] [#38] @@ -56,11 +56,13 @@ This may be: GEMINI 1 to 2.0: New element, required for INSPIRE ==== -.Encoding guidelines... +Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +| Guidelines +| . https://inspire.ec.europa.eu/documents/inspire-metadata-implementing-rules-technical-guidelines-based-en-iso-19115-and-en-iso-1[INSPIRE guidance] link:component/content/article?id=1047[[9]] states that Coupled resource shall be implemented by reference, i.e. through a URL @@ -109,35 +111,32 @@ obtain from the metadata instance. In the case of GEMINI and INSPIRE metadata it will be the first MD_DataIdentification element in the instance (XPath //gmd:identificationInfo[1]) unless a fragment identifier is used, in which case it may be in any location. - -|Example a| -`Example One using the by reference mechanism and an OGC CSW request ` - -.... +| Example One using the by reference mechanism and an OGC CSW request +| +[source,xml] +---- include::../snippets/coupledresource-cswrequest.xml[] -.... - -Example Two using WAF - -.... +---- +| Example Two using WAF +| +[source,xml] +---- include::../snippets/coupledresource-waf.xml[] -.... - -Example Three using the by reference mechanism and an OGC CSW request +---- +| Example Three using the by reference mechanism and an OGC CSW request with a fragment identifier. - -.... +| +[source,xml] +---- include::../snippets/coupledresource-cswrequest-fragment.xml[] -.... - +---- In this example the fragment identifier #BGS-13480426 would correspond to the value of the id attribute of the gmd:MD_DataIdentification element of the dataset metadata record, like below - -.... +[source,xml] +---- -.... - +---- |=== ==== diff --git a/docs/partials/dataformat.asciidoc b/docs/partials/dataformat.asciidoc index 2d91377..90426df 100644 --- a/docs/partials/dataformat.asciidoc +++ b/docs/partials/dataformat.asciidoc @@ -1,4 +1,4 @@ -= Data format +== Data format include::includes/partials-attributes.adoc[] [#21] @@ -67,23 +67,22 @@ versioned, a nil reason attribute shall be specified with either .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |Both a gmd:name and gmd:version shall be provided for the format - -|Example a| -Example One - -.... +|Example One +| +[source,xml] +---- include::../snippets/dataformat-name-version.xml[] -.... - -Example Two - unknown version - -.... +---- +|Example Two - unknown version +| +[source,xml] +---- include::../snippets/dataformat-name-unknownversion.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/dataquality.asciidoc b/docs/partials/dataquality.asciidoc index e14a93e..3badb17 100644 --- a/docs/partials/dataquality.asciidoc +++ b/docs/partials/dataquality.asciidoc @@ -1,4 +1,4 @@ -= Data quality +== Data quality include::includes/partials-attributes.adoc[] [#52] @@ -257,9 +257,10 @@ New element in GEMINI 2.3 .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| -There shall be exactly one gmd:dataQualityInfo/gmd:DQ_DataQuality +|Guidelines +| There shall be exactly one gmd:dataQualityInfo/gmd:DQ_DataQuality element scoped to the entire described data set or data set series. So if the scope of the quality measure is the entire dataset or series, then the result shall be in the same DQ_DataQuality element as the @@ -285,26 +286,25 @@ declared as xs:double. As well as the mandatory elements, it is also recommended to supply a name of the measure, a short description of the evaluation method, and a date for the evaluation of the consistency check - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/dataquality-mixed.xml[] -.... - -Example two - Topological consistency - -.... +---- +| Example two - Topological consistency +| +[source,xml] +---- include::../snippets/dataquality-topo-qualitative.xml[] -.... - -Example three ~ Topological consistency, showing a quantitative +---- +| Example three ~ Topological consistency, showing a quantitative topological consistency report with recommended elements included - -.... +| +[source,xml] +---- include::../snippets/dataquality-topo-quantitative.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/datasetlanguage.asciidoc b/docs/partials/datasetlanguage.asciidoc index 47aa9c3..8d995a0 100644 --- a/docs/partials/datasetlanguage.asciidoc +++ b/docs/partials/datasetlanguage.asciidoc @@ -1,4 +1,4 @@ -= Dataset language +== Dataset language include::includes/partials-attributes.adoc[] [#3] @@ -80,9 +80,10 @@ content; not applicable" shall be used. .Encoding guidelines... [%collapsible] ==== -[width="100%",cols="50%,50%",] +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . Note that according to the ISO 19115 logical model the language property is typed as a CharacterString. The use of the gco:CharacterString type is permitted by the ISO 19139 schemas but this @@ -95,14 +96,12 @@ value in GEMINI2 metadata instances: http://www.loc.gov/standards/iso639-2/php/code_list.php . Note however, that this URL resolves to an HTML web page rather than a service endpoint providing ISO 639-2 language codes. - -|Example a| -Example following the INSPIRE recommendation of using the name of the language as the content of the gmd:LanguageCode - -.... +|Example following the INSPIRE recommendation of using the name of the language as the content of the gmd:LanguageCode +| +[source,xml] +---- include::../snippets/datasetlanguage.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/datasetreferencedate.asciidoc b/docs/partials/datasetreferencedate.asciidoc index 1834048..abd5911 100644 --- a/docs/partials/datasetreferencedate.asciidoc +++ b/docs/partials/datasetreferencedate.asciidoc @@ -1,4 +1,4 @@ -= Dataset reference date +== Dataset reference date include::includes/partials-attributes.adoc[] [#8] @@ -109,8 +109,10 @@ GEMINI 1 to 2.0: Addition of date type .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| * The encoding for dataset reference date is shown in Example One. * Dates may be expressed with low precision, as shown in the example. GEMINI2 also allows the date and time to be published in metadata. In @@ -120,34 +122,34 @@ link:component/content/article?id=1048#2.2.3[Dates and Times] * Dataset reference date shall include a date type. The content of this XML element is drawn from a link:component/content/article?id=1048#2.2.9[code list]. - -|Example a| ifdef::variant-dataset[] -Example One (datasets/series): dataset reference date encoding example - -.... +| Example One: date +| +[source,xml] +---- include::../snippets/dataset-datasetreferencedate-date.xml[] -.... - -Example Two - date and time - -.... -... +---- +| Example Two - date and time +| +[source,xml] +---- include::../snippets/datasetreferencedate-datetime.xml[] -... -.... +---- endif::[] ifdef::variant-service[] -Example One: date - -.... +| Example One: date +| +[source,xml] +---- include::../snippets/service-datasetreferencedate-date.xml[] -... +---- +| Example Two - date and time +| +[source,xml] +---- include::../snippets/datasetreferencedate-datetime.xml[] -... -.... +---- endif::[] - |=== ==== diff --git a/docs/partials/equivalentscale.asciidoc b/docs/partials/equivalentscale.asciidoc index ce9d8b9..0f6d3fc 100644 --- a/docs/partials/equivalentscale.asciidoc +++ b/docs/partials/equivalentscale.asciidoc @@ -1,4 +1,4 @@ -= Equivalent scale +== Equivalent scale include::includes/partials-attributes.adoc[] [#43] @@ -64,17 +64,21 @@ GEMINI 1 to 2.0: New element .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== ifdef::variant-dataset[] -|Guidelines | -|Example a| - -.... +|Guidelines +| +|Example +| +[source,xml] +---- include::../snippets/equivalentscale.xml[] -.... +---- endif::[] ifdef::variant-service[] -|Guidelines a| +|Guidelines +| * For services, it is not possible to express the restriction of a service concerning the spatial resolution when using the ISO 19139 XML Schema. @@ -83,7 +87,7 @@ Schema. equivalent scale as integer valued scale denominator or a resolution distance using a numerical length value and with a unit of length. endif::[] - +| |=== ==== diff --git a/docs/partials/extent.asciidoc b/docs/partials/extent.asciidoc index cb9a900..d98ef87 100644 --- a/docs/partials/extent.asciidoc +++ b/docs/partials/extent.asciidoc @@ -1,4 +1,4 @@ -= Extent +== Extent include::includes/partials-attributes.adoc[] [#15] @@ -92,8 +92,10 @@ GEMINI 1 to 2.0: Made optional .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . The examples shown below use codes (URIs in URL form) from the http://data.os.uk[Ordnance Survey Linked Data] link:component/content/article?id=1047[[22]] @@ -120,35 +122,34 @@ Note that the extent XML element is in the srv namespace. This differs from dataset metadata instances where the extent XML element will be in the gmd namespace. endif::[] - -|Example a| ifdef::variant-dataset[] -Example One (datasets/series) - -.... +|Example One +| +[source,xml] +---- include::../snippets/dataset-extent-code.xml[] -.... - -Example Two (datasets/series) - Extent encoding example with authority - -.... +---- +| Example Two- Extent encoding example with authority +| +[source,xml] +---- include::../snippets/dataset-extent-codeauthority.xml[] -.... +---- endif::[] ifdef::variant-service[] -Example One (services) ` - -.... +| Example One +| +[source,xml] +---- include::../snippets/service-extent-code.xml[] -.... - -Example Two (services) - Extent encoding example with authority - -.... +---- +|Example Two - Extent encoding example with authority +| +[source,xml] +---- include::../snippets/service-extent-codeauthority.xml[] -.... +---- endif::[] - |=== ==== diff --git a/docs/partials/fileidentifier.asciidoc b/docs/partials/fileidentifier.asciidoc index 9f40bff..7413752 100644 --- a/docs/partials/fileidentifier.asciidoc +++ b/docs/partials/fileidentifier.asciidoc @@ -1,4 +1,4 @@ -= File Identifier +== File Identifier include::includes/partials-attributes.adoc[] [#45] @@ -67,9 +67,10 @@ resource being described. + .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| -. The first XML child element of any GEMINI2 metadata instance shall be +|Guidelines +|. The first XML child element of any GEMINI2 metadata instance shall be gmd:fileIdentifier. The content of this XML element is the identifier of the metadata instance. File identifier is not a metadata item of GEMINI2. It is not to be confused with the metadata item @@ -77,14 +78,13 @@ link:#36[Resource identifier]. . The content of the XML element shall be a unique managed identifier, such as a system generated UUID. Once the identifier has been set for a metadata instance it shall not change. - -|Example a| -.... +|Example +| +[source,xml] +---- include::../snippets/fileidentifier.xml[] -.... - +---- |=== -[%collapsible] ==== .Metadata errors observed... diff --git a/docs/partials/hierarchylevelname.asciidoc b/docs/partials/hierarchylevelname.asciidoc index cd7214e..e80c2d7 100644 --- a/docs/partials/hierarchylevelname.asciidoc +++ b/docs/partials/hierarchylevelname.asciidoc @@ -1,4 +1,4 @@ -= Hierarchy level name +== Hierarchy level name include::includes/partials-attributes.adoc[] [#47] @@ -57,38 +57,36 @@ New element in GEMINI 2.3 .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |No specific rules for this metadata element -|Example a| ifdef::variant-dataset[] - -Example 1 - dataset, where hierarchyLevelName could just be omitted - -.... +|Example 1 - dataset, where hierarchyLevelName could just be omitted +| +[source,xml] +---- include::../snippets/dataset-hierarchylevelname.xml[] - -.... - -Example 2 - series, where hierarchyLevelName is required - -.... +---- +|Example 2 - series, where hierarchyLevelName is required +| +[source,xml] +---- include::../snippets/series-hierarchylevelname.xml[] -.... +---- endif::[] ifdef::variant-service[] -|Example a| -.... +|Example +| +[source,xml] +---- include::../snippets/service-hierarchylevelname.xml[] - -.... +---- endif::[] - - - |=== ==== -Metadata errors observed... - -[[errors47]] -No error information available \ No newline at end of file +.Metadata errors observed... +[%collapsible] +==== +No error information available +==== \ No newline at end of file diff --git a/docs/partials/includes/partials-attributes.adoc b/docs/partials/includes/partials-attributes.adoc index f3f8d29..1ed5726 100644 --- a/docs/partials/includes/partials-attributes.adoc +++ b/docs/partials/includes/partials-attributes.adoc @@ -1,15 +1,8 @@ -:assetdir: ../assets -:stylesdir: {assetdir} +:stylesdir: assets :figure-caption: Figure -:toc: left :docinfo: shared -:docinfodir: {assetdir} -:docinfosubs: attributes -:safe-mode-unsafe: :iconfont-remote!: -:stylesheet: ../assets/gemini.css -:scriptsdir: {assetdir} -:linkcss: +:stylesheet: gemini.css :data-uri: :iconfont-name: font-awesome.min :imagesdir: media @@ -17,5 +10,6 @@ :sectnumlevels: 3 :sectlinks: :sectanchors: -:experimental: -:stem: \ No newline at end of file +:toclevels: 4 +:source-highlighter: pygments +:pygments-style: default \ No newline at end of file diff --git a/docs/partials/keyword.asciidoc b/docs/partials/keyword.asciidoc index c06a992..a7927f1 100644 --- a/docs/partials/keyword.asciidoc +++ b/docs/partials/keyword.asciidoc @@ -1,4 +1,4 @@ -= Keyword +== Keyword include::includes/partials-attributes.adoc[] [#6] @@ -117,9 +117,11 @@ controlled vocabulary .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines a| ifdef::variant-dataset[] +[arabic] . The GEMINI2 keyword item comprises keyword value(s) and, conditionally, the specification of an originating controlled vocabulary. If keywords are not selected from a controlled vocabulary @@ -150,6 +152,7 @@ controlled vocabulary. An example from the Marine Geospatial community is http://seadatanet.maris2.nl/v_bodc_vocab_v2/search.asp?lib=P02 endif::[] ifdef::variant-service[] +| . The GEMINI2 keyword item comprises keyword value(s) and, conditionally, the specification of an originating controlled vocabulary. If keywords are not selected from a controlled vocabulary the encoding shown in Example One shall be used. . In the context of INSPIRE the presence of at least one keyword is mandated. For service metadata there shall be at least one keyword defining the category or subcategory of the service using its language neutral name as defined in Part D 4 of the Metadata Implementing Rules (the language neutral names are the words in brackets using lower camel case notation). The keyword shown in Example Two is an example of this . Where keywords do originate from a controlled vocabulary the encoding shown in Example Two shall be used. Note the inclusion of the gmd:thesaurusName XML element which contains the XML element gmd:CI_Citation. This element must contain at least a title, reference date and date type. In the example keywords have been selected from the GEMET Concepts controlled vocabulary. @@ -159,50 +162,54 @@ ifdef::variant-service[] . This case arises because the XML element gmd:descriptiveKeywords is a an instance of the property (or role in fact) on the ISO 19115 abstract class MD_Identification, from which both SV_ServiceIdentification and MD_DataIdentification inherit. Therefore, SV_ServiceIdentification inherits the descriptiveKeywords property and adds a similar property called keywords. . Recommended best practice is to select a human readable value from a controlled vocabulary. An example from the Marine Geospatial community is http://seadatanet.maris2.nl/v_bodc_vocab_v2/search.asp?lib=P02 endif::[] - - -|Example a| ifdef::variant-dataset[] -` Example One (datasets/series) - without originating controlled vocabulary ` - -.... +| Example One (datasets/series) - without originating controlled vocabulary +| +[source,xml] +---- include::../snippets/dataset-keyword-freetext.xml[] -.... - -Example Two (datasets/series) - INSPIRE theme - -.... +---- +| Example Two (datasets/series) - INSPIRE theme +| +[source,xml] +---- include::../snippets/dataset-keyword-freetext.xml[] -.... - -Example Three (datasets/series) - keywords from 2 controlled +---- +| Example Three (datasets/series) - keywords from 2 controlled vocabularies - -.... +| +[source,xml] +---- include::../snippets/dataset-keyword-controlled.xml[] -.... +---- endif::[] ifdef::variant-service[] -`Example One (services) - without controlled vocabulary -.... +|Example One (services) - without controlled vocabulary +| +[source,xml] +---- include::../snippets/service-keyword-freetext.xml[] -.... -Example Two (services) - service keyword from part D4 on the INSPIRE +---- +| Example Two (services) - service keyword from part D4 on the INSPIRE Metadata Implementing Rules -.... +| +[source,xml] +---- include::../snippets/service-keyword-inspire.xml[] -.... -Example Three (services) - GEMET concepts -.... +---- +| Example Three (services) - GEMET concepts +| +[source,xml] +---- include::../snippets/service-keyword-gemet.xml[] -.... - -Example Four (services) - keywords from two controlled vocabularies -.... +---- +| Example Four (services) - keywords from two controlled vocabularies +| +[source,xml] +---- include::../snippets/service-keyword-controlled.xml[] -.... +---- endif::[] - |=== ==== diff --git a/docs/partials/limitationsonpublicaccess.asciidoc b/docs/partials/limitationsonpublicaccess.asciidoc index 23ae226..cd0b03a 100644 --- a/docs/partials/limitationsonpublicaccess.asciidoc +++ b/docs/partials/limitationsonpublicaccess.asciidoc @@ -1,4 +1,4 @@ -= Limitations on public access +== Limitations on public access include::includes/partials-attributes.adoc[] [#25] @@ -90,9 +90,10 @@ accessConstraint making domain free text. .Encoding guidelines... [%collapsible] ==== -[width="100%",cols="50%,50%",] +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . This element shall be encoded in a different resourceConstraints/MD_LegalConstraints XML element to GEMINI element 26 Use constraints @@ -110,32 +111,29 @@ http://inspire.ec.europa.eu/metadata-codelist/LimitationsOnPublicAccess . Free text content cannot be empty . To encode multiple limitations, include more than one gmd:otherConstraints element - -|Example a| -Example One - -.... +|Example One +| +[source,xml] +---- ifdef::variant-dataset[] include::../snippets/dataset-limitationsonpublicaccess.xml[] endif::[] ifdef::variant-service[] include::../snippets/service-limitationsonpublicaccess.xml[] endif::[] - -.... - -Example Two - no limitations - -.... +---- +| Example Two - no limitations +| +[source,xml] +---- include::../snippets/limitationsonpublicaccess-nolimitations.xml[] -.... - -Example Three - two limitations - -.... +---- +| Example Three - two limitations +| +[source,xml] +---- include::../snippets/limitationsonpublicaccess-twolimitations.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/lineage.asciidoc b/docs/partials/lineage.asciidoc index 6951e72..244f779 100644 --- a/docs/partials/lineage.asciidoc +++ b/docs/partials/lineage.asciidoc @@ -1,4 +1,4 @@ -= Lineage +== Lineage include::includes/partials-attributes.adoc[] [#10] @@ -74,9 +74,10 @@ conform to INSPIRE .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| -. The encoding for lineage is shown in the example below. +|Guidelines +|. The encoding for lineage is shown in the example below. . Note that, in addition to the lineage statement, the data quality scope shall be encoded. For dataset metadata instances the MD_ScopeCode code list value shall be 'dataset'. For series metadata instances the @@ -84,13 +85,12 @@ code list value shall be 'series'. . For INSPIRE, the lineage statement must appear in the gmd:dataQualityInfo/gmd:DQ_DataQuality element scoped to the entire described dataset or series - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/lineage.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/maintenanceinformation.asciidoc b/docs/partials/maintenanceinformation.asciidoc index 82ca392..a4e5e6b 100644 --- a/docs/partials/maintenanceinformation.asciidoc +++ b/docs/partials/maintenanceinformation.asciidoc @@ -1,4 +1,4 @@ -= Maintenance information +== Maintenance information include::includes/partials-attributes.adoc[] [#53] @@ -84,15 +84,15 @@ New element in GEMINI 2.3 .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |No specific rules for this metadata element - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/maintenanceinformation.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/metadatadate.asciidoc b/docs/partials/metadatadate.asciidoc index 820fb49..cf87d83 100644 --- a/docs/partials/metadatadate.asciidoc +++ b/docs/partials/metadatadate.asciidoc @@ -1,4 +1,4 @@ -= Metadata Date +== Metadata Date include::includes/partials-attributes.adoc[] [#30] @@ -62,24 +62,23 @@ GEMINI 1 to 2.0: Change of name from Date of last update of metadata .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |The encoding example for metadata date is shown in Example One. Note that it is possible to record the date and time of the metadata instance using the encoding shown in Example Two. - -|Example a| -`Example One - -.... +|Example One +| +[source,xml] +---- include::../snippets/metadatadate.xml[] -.... - -Example Two (date and time) - -.... +---- +|Example Two (date and time) +| +[source,xml] +---- include::../snippets/metadatadatetime.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/metadatalanguage.asciidoc b/docs/partials/metadatalanguage.asciidoc index 2df2bba..9cee1f5 100644 --- a/docs/partials/metadatalanguage.asciidoc +++ b/docs/partials/metadatalanguage.asciidoc @@ -1,4 +1,4 @@ -= Metadata language +== Metadata language include::includes/partials-attributes.adoc[] [#33] @@ -80,17 +80,16 @@ GEMINI 1 to 2.0: New element .Encoding guidelines... [%collapsible] ==== -[width="100%",cols="50%,50%",] +[cols="a,a"] |=== |Guidelines |INSPIRE recommends providing the name of the language as content of the gmd:LanguageCode element - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/metadatadate.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/metadatapointofcontact.asciidoc b/docs/partials/metadatapointofcontact.asciidoc index 7a2fead..dcf7135 100644 --- a/docs/partials/metadatapointofcontact.asciidoc +++ b/docs/partials/metadatapointofcontact.asciidoc @@ -1,4 +1,4 @@ -= Metadata point of contact +== Metadata point of contact include::includes/partials-attributes.adoc[] [#35] @@ -54,8 +54,10 @@ GEMINI 1 to 2.0: New element .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| * The encoding example for metadata point of contact is shown below. Note that the example shows the minimum required information. * The format of address and contact information is described at @@ -64,14 +66,12 @@ more fully populated example. * More than one metadata point of contact may be expressed in metadata. The role of at least one metadata point of contact shall be 'pointOfContact'. - -|Example a| -Example showing minimum required information - -.... +|Example showing minimum required information +| +[source,xml] +---- include::../snippets/metadatapointofcontact.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/metadatastandardname.asciidoc b/docs/partials/metadatastandardname.asciidoc index 475890d..cfa42cf 100644 --- a/docs/partials/metadatastandardname.asciidoc +++ b/docs/partials/metadatastandardname.asciidoc @@ -1,4 +1,4 @@ -= Metadata standard name +== Metadata standard name include::includes/partials-attributes.adoc[] [#54] @@ -61,6 +61,7 @@ guidance .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |GEMINI is supported by a https://www.bodc.ac.uk/resources/vocabularies/vocabulary_search/M25/[register @@ -68,20 +69,18 @@ of metadata standard and profile names], hosted on the NERC vocab server. + The relevant standard shall be cited with a reference to the appropriate register entry, using an Anchor. - -|Example a| -` Example One – UK GEMINI 2.3 - -.... +|Example One – UK GEMINI 2.3 +| +[source,xml] +---- include::../snippets/metadatastandardname-gemini.xml[] - -Example Two – MEDIN profile of GEMINI 2.3 -... +---- +| Example Two – MEDIN profile of GEMINI 2.3 +| +[source,xml] +---- include::../snippets/metadatastandardname-medin.xml[] -... - -.... - +---- |=== ==== diff --git a/docs/partials/metadatastandardversion.asciidoc b/docs/partials/metadatastandardversion.asciidoc index e4674ea..e940d62 100644 --- a/docs/partials/metadatastandardversion.asciidoc +++ b/docs/partials/metadatastandardversion.asciidoc @@ -1,4 +1,4 @@ -= Metadata standard version +== Metadata standard version include::includes/partials-attributes.adoc[] [#55] @@ -60,16 +60,15 @@ link:#54[Metadata standard name] .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |No specific rules for this metadata element - -|Example a| -` Example One – GEMINI 2.3 ` - -.... +| Example One – GEMINI 2.3 +| +[source,xml] +---- include::../snippets/metadatastandardversion.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/parentidentifier.asciidoc b/docs/partials/parentidentifier.asciidoc index 8f25fb3..0e753a3 100644 --- a/docs/partials/parentidentifier.asciidoc +++ b/docs/partials/parentidentifier.asciidoc @@ -1,4 +1,4 @@ -= Parent identifier +== Parent identifier include::includes/partials-attributes.adoc[] [#49] @@ -55,15 +55,15 @@ New element in GEMINI 2.3 .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |No specific rules for this metadata element - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/parentidentifier.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/qualityscope.asciidoc b/docs/partials/qualityscope.asciidoc index 39ffd95..f169e11 100644 --- a/docs/partials/qualityscope.asciidoc +++ b/docs/partials/qualityscope.asciidoc @@ -1,4 +1,4 @@ -= Quality scope +== Quality scope include::includes/partials-attributes.adoc[] [#48] @@ -81,8 +81,10 @@ New element in GEMINI 2.3 .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| ifdef::variant-dataset[] All gmd:dataQualityInfo XML element shall have a gmd:scope XML element, set to as appropriate. @@ -103,19 +105,17 @@ required * The value of gmd:other must be *service* (in the language of the metadata), as shown below. endif::[] - - -|Example a| - -.... +|Example +| +[source,xml] +---- ifdef::variant-dataset[] include::../snippets/dataset-qualityscope.xml[] endif::[] ifdef::variant-service[] include::../snippets/service-qualityscope.xml[] endif::[] -.... - +---- |=== ==== diff --git a/docs/partials/resourceidentifier.asciidoc b/docs/partials/resourceidentifier.asciidoc index 19e9409..729182d 100644 --- a/docs/partials/resourceidentifier.asciidoc +++ b/docs/partials/resourceidentifier.asciidoc @@ -1,4 +1,4 @@ -= Resource identifier +== Resource identifier include::includes/partials-attributes.adoc[] [#36] @@ -110,8 +110,10 @@ reduce confusion with W3C URI .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . The resource identifier can be a globally unique identifier such as a UUID, in which case it is encoded as shown in Example One. . The form used in Example One can also be used if the identifier is @@ -133,20 +135,18 @@ cannot be an UUID or an URI. The id must also be unique across all id attributes in the metadata document . See notes on link:component/content/article?id=1048#2.2.12[XML Identifiers]. - -|Example a| -Example One - -.... +|Example One +| +[source,xml] +---- include::../snippets/resourceidentifier-characterstring.xml[] -.... - -Example Two - resolveable identifier using gmx:Anchor - -.... +---- +| Example Two - resolveable identifier using gmx:Anchor +| +[source,xml] +---- include::../snippets/resourceidentifier-anchor.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/resourcelocator.asciidoc b/docs/partials/resourcelocator.asciidoc index 65f9603..143373b 100644 --- a/docs/partials/resourcelocator.asciidoc +++ b/docs/partials/resourcelocator.asciidoc @@ -1,4 +1,4 @@ -= Resource locator +== Resource locator include::includes/partials-attributes.adoc[] [#19] @@ -128,8 +128,10 @@ GEMINI 1 to 2.0: Modification of Online resource .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| ifdef::variant-dataset[] . The two examples illustrate different uses of Resource locator. Example one gives direct access to the dataset. Example two gives the @@ -155,25 +157,24 @@ https://inspire.ec.europa.eu/documents/inspire-metadata-implementing-rules-techn guidance] link:component/content/article?id=1047[[9]]. If the format and version values are known, then they should be given (see link:#21[Data format]). - -|Example a| -Example one, showing only required linkage content (for a dataset) - -.... +|Example one, showing only required linkage content (for a dataset) +| +[source,xml] +---- include::../snippets/dataset-resourcelocator-required.xml[] -.... - -Example two - including name, description, and indication of function +---- +| Example two - including name, description, and indication of function (for a dataset ordering page) - -.... +| +[source,xml] +---- include::../snippets/dataset-resourcelocator-information.xml[] -.... - +---- |=== endif::[] ifdef::variant-service[] -|Guidelines a| +|Guidelines +| . In the examples, the URLs provided are for OGC GetCapabilities requests. . The gmd:transferOptions XML element of gmd:MD_Distribution is used to @@ -216,35 +217,33 @@ five entity references: * > - The character > * " - The character " * ' - The character ' - -|Example a| -`Example one, showing only required linkage content (for a WMS) ` - -.... +|Example one, showing only required linkage content (for a WMS) +| +[source,xml] +---- include::../snippets/service-resourcelocator-required.xml[] -.... - -Example Two - including name, description, and indication of function +---- +| Example Two - including name, description, and indication of function (for a WMS) - -.... +| +[source,xml] +---- include::../snippets/service-resourcelocator-function-wms.xml[] -.... - -Example Three - including name, description, and indication of function +---- +|Example Three - including name, description, and indication of function (for a WCS) - -.... +| +[source,xml] +---- include::../snippets/service-resourcelocator-function-wcs.xml[] -.... - -Example Four - including name, description, and indication of function +---- +|Example Four - including name, description, and indication of function (for an invocable spatial data service) - -.... +| +[source,xml] +---- include::../snippets/service-resourcelocator-function-invocable.xml[] -.... - +---- |=== endif::[] ==== diff --git a/docs/partials/resourcetype.asciidoc b/docs/partials/resourcetype.asciidoc index fcc7156..dfd336d 100644 --- a/docs/partials/resourcetype.asciidoc +++ b/docs/partials/resourcetype.asciidoc @@ -1,4 +1,4 @@ -= Resource type +== Resource type include::includes/partials-attributes.adoc[] [#39] @@ -54,15 +54,15 @@ GEMINI 1 to 2.0: New element, required for INSPIRE .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |No specific rules for this metadata element - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/resourcetype.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/responsibleorganisation.asciidoc b/docs/partials/responsibleorganisation.asciidoc index 448dd86..f24a22e 100644 --- a/docs/partials/responsibleorganisation.asciidoc +++ b/docs/partials/responsibleorganisation.asciidoc @@ -1,4 +1,4 @@ -= Responsible organisation +== Responsible organisation include::includes/partials-attributes.adoc[] [#23] @@ -148,8 +148,10 @@ corrected. .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . The encoding example for responsible organisation is shown below. The example shows the minimum required information. . The format of address and contact information is described at @@ -158,23 +160,22 @@ more fully populated example. . Note on role code: the UK Location portal (data.gov.uk site) interprets ISO 'owner' as Data Provider, and ISO 'publisher' as Data Publisher. - -|Example a| ifdef::variant-dataset[] -Example One (datasets/series) - -.... +| Example One (datasets/series) +| +[source,xml] +---- include::../snippets/dataset-responsibleorganisation.xml[] -.... +---- endif::[] ifdef::variant-service[] -Example One (service) - -.... +| Example One (service) +| +[source,xml] +---- include::../snippets/service-responsibleorganisation.xml[] -.... +---- endif::[] - |=== ==== diff --git a/docs/partials/spatialdataservicetype.asciidoc b/docs/partials/spatialdataservicetype.asciidoc index 7d66732..ed5e13d 100644 --- a/docs/partials/spatialdataservicetype.asciidoc +++ b/docs/partials/spatialdataservicetype.asciidoc @@ -1,4 +1,4 @@ -= Spatial data service type +== Spatial data service type include::includes/partials-attributes.adoc[] [#37] @@ -64,8 +64,10 @@ GEMINI 1 to 2.0: New element .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| The encoding example for spatial data service type is shown in the example below. The value domain of the service type (i.e. the list of acceptable values to encode in view) is @@ -78,13 +80,12 @@ repeated below (the words are to be encoded in lower case): * transformation * invoke * other - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/spatialdataservicetype.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/spatialreferencesystem.asciidoc b/docs/partials/spatialreferencesystem.asciidoc index 4873b44..7a2f016 100644 --- a/docs/partials/spatialreferencesystem.asciidoc +++ b/docs/partials/spatialreferencesystem.asciidoc @@ -1,4 +1,4 @@ -= Spatial reference system +== Spatial reference system include::includes/partials-attributes.adoc[] [#17] @@ -94,39 +94,39 @@ GEMINI 1 to 2.0: Changed from enumerated list .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| * When the provided text is a term or code from an externally defined explanation or registry value, gmx:Anchor should be used instead of gco:CharacterString * The content of gmx:Anchor or gco:CharacterString must not be empty - -|Example a| -Example One - using gmx:Anchor for a default Coordinate Reference System (as defined in Annex D.4 of the INSPIRE metadata technical guidance v.2) - -.... +|Example One - using gmx:Anchor for a default Coordinate Reference System (as defined in Annex D.4 of the INSPIRE metadata technical guidance v.2) +| +[source,xml] +---- include::../snippets/spatialreferencesystem-default-anchor.xml[] -.... - -Example Two - using gmx:Anchor for a non default CRS. - -.... +---- +| Example Two - using gmx:Anchor for a non default CRS. +| +[source,xml] +---- include::../snippets/spatialreferencesystem-nondefault-anchor.xml[] -.... - -Example Three - encoding example with authority - -.... +---- +|Example Three - encoding example with authority +| +[source,xml] +---- include::../snippets/spatialreferencesystem-authority.xml[] -.... - -Example Four - encoding example for spatial reference systems using +---- +|Example Four - encoding example for spatial reference systems using geographic identifiers - -.... +| +[source,xml] +---- include::../snippets/spatialreferencesystem-identifiers.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/spatialrepresentationtype.asciidoc b/docs/partials/spatialrepresentationtype.asciidoc index 517e174..5cc27e1 100644 --- a/docs/partials/spatialrepresentationtype.asciidoc +++ b/docs/partials/spatialrepresentationtype.asciidoc @@ -1,4 +1,4 @@ -= Spatial representation type +== Spatial representation type include::includes/partials-attributes.adoc[] [#50] @@ -73,16 +73,16 @@ is a superset of values used by INSPIRE .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |Only the codeListValue is required, the codeList and the free text content are optional and informative only - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/spatialrepresentationtype.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/spatialresolution.asciidoc b/docs/partials/spatialresolution.asciidoc index 76f557e..3a04de8 100644 --- a/docs/partials/spatialresolution.asciidoc +++ b/docs/partials/spatialresolution.asciidoc @@ -1,4 +1,4 @@ -= Spatial resolution +== Spatial resolution include::includes/partials-attributes.adoc[] [#18] @@ -78,8 +78,10 @@ GEMINI 1 to 2.0: made conditional .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| ifdef::variant-dataset[] . The encoding example for spatial resolution is shown in the example below. @@ -101,16 +103,16 @@ Schema. equivalent scale as integer valued scale denominator or a resolution distance using a numerical length value and with a unit of length. endif::[] - ifdef::variant-dataset[] -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/spatialresolution.xml[] -.... - -|=== +---- endif::[] +|=== + ==== .Metadata errors observed... diff --git a/docs/partials/temporalextent.asciidoc b/docs/partials/temporalextent.asciidoc index 5d1465e..89f601a 100644 --- a/docs/partials/temporalextent.asciidoc +++ b/docs/partials/temporalextent.asciidoc @@ -1,4 +1,4 @@ -= Temporal extent +== Temporal extent include::includes/partials-attributes.adoc[] [#7] @@ -94,8 +94,10 @@ endif::[] .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . The basic encoding for temporal extent is shown in Example One (datasets/series). The temporal extent data shall be encoded using the gml:TimePeriod type from the gml namespace. The underlying schemas and @@ -159,63 +161,58 @@ before the specified date * 'after': in which case the actual date is unknown but known to be after the specified date . Example Four shows encoding examples using these values. - - -|Example a| ifdef::variant-dataset[] -Example One (datasets/series) : (gml:TimePeriod) - -.... +| Example One (datasets/series) : (gml:TimePeriod) +| +[source,xml] +---- include::../snippets/dataset-temporalextent-timeperiod.xml[] - - -.... - -Example Two (datasets/series): (gml:TimeInstant) - -.... +---- +| Example Two (datasets/series): (gml:TimeInstant) +| +[source,xml] +---- include::../snippets/dataset-temporalextent-timeinstant.xml[] - - -.... - -Example Three (datasets/series): unknown dates - -.... +---- +| Example Three (datasets/series): unknown dates +| +[source,xml] +---- include::../snippets/temporalextent-unknowndates.xml[] -.... - -Example Four: other unknown or unspecified dates - -.... +---- +| Example Four: other unknown or unspecified dates +| +[source,xml] +---- include::../snippets/temporalextent-other.xml[] -.... +---- endif::[] ifdef::variant-service[] -Example One (services) : (gml:TimePeriod) -.... +| Example One (services) : (gml:TimePeriod) +| +[source,xml] +---- include::../snippets/service-temporalextent-timeperiod.xml[] -.... - -Example Two (services) : (gml:TimeInstant) - -.... +---- +|Example Two (services) : (gml:TimeInstant) +| +[source,xml] +---- include::../snippets/service-temporalextent-timeinstant.xml[] -.... - -Example Three (services) : unknown dates - -.... +---- +| Example Three (services) : unknown dates +| +[source,xml] +---- include::../snippets/temporalextent-unknowndates.xml[] -.... - -Example Four: other unkown or unspecified dates - -.... +---- +| Example Four: other unkown or unspecified dates +| +[source,xml] +---- include::../snippets/temporalextent-other.xml[] -.... +---- endif::[] - |=== ==== diff --git a/docs/partials/title.asciidoc b/docs/partials/title.asciidoc index 1405b69..f445e9c 100644 --- a/docs/partials/title.asciidoc +++ b/docs/partials/title.asciidoc @@ -1,4 +1,4 @@ -= Title +== Title include::includes/partials-attributes.adoc[] [#1] @@ -58,33 +58,37 @@ in the abstract or Alternative Title. .Change history... [%collapsible] ==== +No error information available ==== + .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== |Guidelines |Cannot be empty - -|Example a| -[#dataset] -.... +|Example ifdef::variant-dataset[] - +[#dataset] +| +[source,xml] +---- include::../snippets/dataset-title.xml[] - -endif::[] -.... +---- +endif::[] +ifdef::variant-service[] [#service] -.... - -ifdef::variant-service[] - +| +[source,xml] +---- include::../snippets/service-title.xml[] - +---- endif::[] -.... |=== - ==== +.Metadata errors observed... +[%collapsible] +==== No error information available +==== diff --git a/docs/partials/topiccategory.asciidoc b/docs/partials/topiccategory.asciidoc index 8347847..7d58950 100644 --- a/docs/partials/topiccategory.asciidoc +++ b/docs/partials/topiccategory.asciidoc @@ -1,4 +1,4 @@ -= Topic Category +== Topic Category include::includes/partials-attributes.adoc[] [#5] @@ -140,8 +140,10 @@ Change history... .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . The encoding example for topic category is shown in Example One. Note that it is possible to include more than one topic category. . The value of the XML element gmd:MD_TopicCategoryCode must not contain @@ -151,14 +153,12 @@ in an XSD schema validation error because the element content will be parsed as shown in Example 3 (excluding the square brackets denoting the start and end) resulting in a value that does not exist in the enumerated list. - -|Example a| - -.... +|Example +| +[source,xml] +---- include::../snippets/topiccategory.xml[] - -.... - +---- |=== ==== diff --git a/docs/partials/useconstraints.asciidoc b/docs/partials/useconstraints.asciidoc index 6926346..01ef8a3 100644 --- a/docs/partials/useconstraints.asciidoc +++ b/docs/partials/useconstraints.asciidoc @@ -1,4 +1,4 @@ -= Use constraints +== Use constraints include::includes/partials-attributes.adoc[] [#26] @@ -76,8 +76,10 @@ making mandatory to conform with INSPIRE. .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . This element shall be encoded in a different resourceConstraints/MD_LegalConstraints XML element to GEMINI element 25 Limitations on public access @@ -100,32 +102,29 @@ list. . If there are no limitations the value of gmd:otherConstraints shall be 'no limitations' (see Example Three). . There may be more than one gmd:otherConstraints element - -|Example a| -Example One - -.... +|Example One +| +[source,xml] +---- ifdef::variant-dataset[] include::../snippets/dataset-useconstraints.xml[] endif::[] ifdef::variant-service[] include::../snippets/service-useconstraints.xml[] endif::[] -.... - -Example Two - with external file - -.... +---- +| Example Two - with external file +| +[source,xml] +---- include::../snippets/useconstraints-externalfile.xml[] -... -.... - -Example Three - no conditions apply - -.... +---- +| Example Three - no conditions apply +| +[source,xml] +---- include::../snippets/useconstraints-noconditions.xml[] -.... - +---- |=== ==== diff --git a/docs/partials/verticalextent.asciidoc b/docs/partials/verticalextent.asciidoc index 33df265..305842b 100644 --- a/docs/partials/verticalextent.asciidoc +++ b/docs/partials/verticalextent.asciidoc @@ -1,4 +1,4 @@ -= Vertical extent information +== Vertical extent information include::includes/partials-attributes.adoc[] [#16] @@ -103,8 +103,10 @@ description of class EX_VerticalExtent changed to match change to ISO .Encoding guidelines... [%collapsible] ==== +[cols="a,a"] |=== -|Guidelines a| +|Guidelines +| . The encoding of the vertical extent information is explained. The vertical extent information is expressed by a minimum and maximum coordinate value and a vertical CRS. The vertical CRS expresses the CRS @@ -135,41 +137,40 @@ CRS is unknown (Example Three) but this renders the vertical extent information ambiguous at best. Consequently it would be better to refrain from including vertical extent information in the metadata instance altogether. - -|Example a| -Example One (datasets/series) - Vertical CRS by reference ifdef::variant-dataset[] -.... +| Example One (datasets/series) - Vertical CRS by reference +| +[source,xml] +---- include::../snippets/dataset-extent-verticalcrs-reference.xml[] -.... - -Example Two (datasets/series) - Vertical CRS by value - -.... +---- +|Example Two (datasets/series) - Vertical CRS by value +| +[source,xml] +---- include::../snippets/dataset-extent-verticalcrs-value.xml[] -.... +---- endif::[] ifdef::variant-service[] -Example One (services) - Vertical CRS by reference - -.... +| Example One (services) - Vertical CRS by reference +| +[source,xml] +---- include::../snippets/service-extent-verticalcrs-reference.xml[] -.... - -Example Two (services) - Vertical CRS by value - -.... +---- +|Example Two (services) - Vertical CRS by value +| +[source,xml] +---- include::../snippets/service-extent-verticalcrs-value.xml[] -.... - +---- endif::[] - -Example Three - Vertical CRS unknown - -.... +|Example Three - Vertical CRS unknown +| +[source,xml] +---- include::../snippets/extent-verticalcrs-unknown.xml[] -.... - +---- |=== ==== diff --git a/docs/templates/slim/ulist.html.slim b/docs/templates/slim/ulist.html.slim new file mode 100644 index 0000000..9eb7a1d --- /dev/null +++ b/docs/templates/slim/ulist.html.slim @@ -0,0 +1,16 @@ +- if title? + figure.list.unordered id=id + figcaption=title + ul class=[style, role] + - items.each do |_item| + li + span.primary=_item.text + - if _item.blocks? + =_item.content +- else + ul id=id class=[style, role] + - items.each do |_item| + li + span.primary=_item.text + - if _item.blocks? + =_item.content \ No newline at end of file