diff --git a/docs/UserDoc_Chap1_Intro.rst b/docs/UserDoc_Chap1_Intro.rst index 96294c4..4f3f9e3 100644 --- a/docs/UserDoc_Chap1_Intro.rst +++ b/docs/UserDoc_Chap1_Intro.rst @@ -25,7 +25,7 @@ A metadata standard is a specification which establishes a common understanding The development of such schemas tends to be controlled through community consensus combined with a formal processes for submission, approval and publishing of new elements. Schemas that are developed and maintained by standards organisations (e.g. ISO) or organisations that have taken on such responsibility (e.g. Dublin Core Metadata Initiative) are called metadata standards. -The UK Geospatial Metadata Interoperability Initiative (`GEMINI `__ ) is the UK’s geographic metadata standard. It was originally produced through a collaboration between the Association for Geographic Information (AGI), the e-Government Unit (eGU) and the UK Data Archive. An application profile of ISO 19115, UK GEMINI is conformant with the INSPIRE Technical Guidance and designed to meet the requirements of INSPIRE in a UK context. +The UK Geospatial Metadata Interoperability Initiative (`GEMINI `__ ) is the UK’s geographic metadata standard. It was originally produced through a collaboration between the Association for Geographic Information (AGI), the e-Government Unit (eGU) and the UK Data Archive. An application profile of ISO 19115, UK GEMINI is conformant with the INSPIRE Technical Guidance and designed to meet the requirements of INSPIRE in a UK context. Why create metadata? @@ -51,6 +51,6 @@ When effort and resource is put into the provision of standard compliant metadat Why use UK Gemini? ------------------ -`UK GEMINI `__ is the designated standard for geographic metadata in the United Kingdom. It ensures consistency with respect to metadata across the UK through content guidance and the use of UK specific terms and code lists. UK Gemini also simplifies the INSPIRE Technical Guidance making it easier for organisations to achieve compliance. +`UK GEMINI `__ is the designated standard for geographic metadata in the United Kingdom. It ensures consistency with respect to metadata across the UK through content guidance and the use of UK specific terms and code lists. UK Gemini also simplifies the INSPIRE Technical Guidance making it easier for organisations to achieve compliance. While ensured compliance to regulations is important, the key benefit is the interoperability the standard allows across a range of platforms. Metadata in the Gemini format can be shared and consumed easily by a number of platforms and third party applications. Gemini is a requirement for the data.gov.uk portal and, with version 2.3, can now be consumed by the ESRI ArcGIS platform without the need of additional plugins. diff --git a/docs/UserDoc_Chap7_Elements.rst b/docs/UserDoc_Chap7_Elements.rst index 1aa1c43..df3fbbc 100644 --- a/docs/UserDoc_Chap7_Elements.rst +++ b/docs/UserDoc_Chap7_Elements.rst @@ -1,26 +1,26 @@ Metadata Elements ================= -This section provides guidance with respect to each of the UK Gemini elements. Section headings refer to the label present in the editing form of +This section provides guidance with respect to each of the UK Gemini elements. Section headings refer to the label present in the editing form of `spatialdata.gov.scot `__, however, UK Gemini and INSPIRE equivalents are also provided. Links to full element guidance from the AGI are given, which includes information on known common errors. Images are provided showing example entries for each of the elements. -Users may also wish to consult the full `UK Gemini 2.3 specification `__. +Users may also wish to consult the full `UK Gemini 2.3 specification `__. Defining INSPIRE compliance --------------------------- -To define within the metadata if a dataset is compliant with INSPIRE, users should ensure the **Keyword** section is completed. If the dataset is -covered by INSPIRE (e.g. parts of it are within the Scope of an INSPIRE Annex data specification), then the **first keyword** should be from the +To define within the metadata if a dataset is compliant with INSPIRE, users should ensure the **Keyword** section is completed. If the dataset is +covered by INSPIRE (e.g. parts of it are within the Scope of an INSPIRE Annex data specification), then the **first keyword** should be from the `GEMET INSPIRE themes `__ keyword list. -If another controlled vocabulary is used as the first keyword, such as the `Integrated Public Sector Vocabulary (IPSV) `__, -then the dataset is not covered by INSPIRE. That said, the dataset and service metadata will still be required to comply with the operation and +If another controlled vocabulary is used as the first keyword, such as the `Integrated Public Sector Vocabulary (IPSV) `__, +then the dataset is not covered by INSPIRE. That said, the dataset and service metadata will still be required to comply with the operation and service commitments, as set out in the `Registered user obligations `__ section. Abstract -------- -:Gemini: `Abstract `__ +:Gemini: `Abstract `__ :INSPIRE: Resource abstract :ISO19115: MD_Identification.abstract :Obligation: Mandatory @@ -30,10 +30,10 @@ Abstract A brief narrative summary of the data resource. :Guidance: - Provide a clear and concise statement of the content of the dataset and its purpose (i.e. the 'what' and 'why' aspect of the dataset). General - background information should not be included, and unexplained abbreviations and jargon should be avoided. The abstract description should be - understood by non-experts. - + Provide a clear and concise statement of the content of the dataset and its purpose (i.e. the 'what' and 'why' aspect of the dataset). General + background information should not be included, and unexplained abbreviations and jargon should be avoided. The abstract description should be + understood by non-experts. + *Note: with Gemini 2.3 there is now a requirement for the abstract to be at least 100 characters long, and to be different from the* `title <#title>`__ *element. Validation will display an error if these conditions are not met.* |userdoc_fig_7_1_1_Abstract| @@ -41,7 +41,7 @@ Abstract Additional information ---------------------- -:Gemini: `Additional information `__ +:Gemini: `Additional information `__ :INSPIRE: supplemental information :ISO19115: MD_Identification > MD_DataIdentification.supplementalInformation :Obligation: Optional @@ -58,7 +58,7 @@ Additional information Alternative title ----------------- -:Gemini: `Alternative title `__ +:Gemini: `Alternative title `__ :INSPIRE: n/a :ISO19115: MD_DataIdentification.citation > CI_Citation.alternateTitle :Obligation: Optional @@ -68,20 +68,20 @@ Alternative title Any short name, other name, acronym or alternative language title by which the data resource is known. :Guidance: - This element should be used to record alternative titles by which the data resource is known, such as historical names, commonly used + This element should be used to record alternative titles by which the data resource is known, such as historical names, commonly used abbreviations and acronyms. It can also be helpful to include title with spatial or temporal coverage if applicable. Entries should remain short and concise. - - If the element is not visible in the default view of the editing form, it can be added by `switching to advanced view `__ + + If the element is not visible in the default view of the editing form, it can be added by `switching to advanced view `__ and clicking the |button_edit_plus| button. |userdoc_fig_7_2_1_AlternativeTitle| Character encoding ------------------ -:Gemini: `Character encoding `__ +:Gemini: `Character encoding `__ :INSPIRE: Character encoding (metadata/2.0/req/isdss/character-encoding) -:ISO19115: MD_DataIdentification.characterSet +:ISO19115: MD_DataIdentification.characterSet :Obligation: Conditional (mandatory if not UTF-8) :occurence: Many @@ -96,7 +96,7 @@ Character encoding Data format ------------------- -:Gemini: `Data format `__ +:Gemini: `Data format `__ :INSPIRE: Data encoding :ISO19115: MD_Distribution.distributionFormat > MD_Format :Obligation: Mandatory @@ -106,16 +106,16 @@ Data format The format(s) in which the digital data is available. :Guidance: - The name of the format and the version can be selected from common options listed in the drop down menu. Otherwise, entries should - be recognised formats for data transfer, either standard or proprietary. If the data is not transferable (e.g. view only), then this should be - stated. Recommended best practice is to select a value from a controlled vocabulary, such as `PRONOM `__. + The name of the format and the version can be selected from common options listed in the drop down menu. Otherwise, entries should + be recognised formats for data transfer, either standard or proprietary. If the data is not transferable (e.g. view only), then this should be + stated. Recommended best practice is to select a value from a controlled vocabulary, such as `PRONOM `__. |userdoc_fig_7_7_1_DistributionFormat| Data quality --------------------------------- -:Gemini: `Data quality `__ +:Gemini: `Data quality `__ :INSPIRE: Topological consistency. Other types are specified in the data specifications :ISO19115: DQ_DataQuality.report->DQ_Element :Obligation: Conditional. Consult Gemini Guidance. @@ -131,20 +131,20 @@ Data quality **2|** `Conformity <#data-quality-conformity>`__ - the product specification being assessed against (e.g. conformance to INSPIRE). - At least one data quality element must be scoped to the entire data set or series that the metadata refers to. Other quality measures, for example relating to specific feature types may be provided in addition. To add additional Data Quality elements, `switch to advanced view `__ + At least one data quality element must be scoped to the entire data set or series that the metadata refers to. Other quality measures, for example relating to specific feature types may be provided in addition. To add additional Data Quality elements, `switch to advanced view `__ and click the |button_edit_plus| button at the base of the page. - + Data quality - Conformity --------------------------------- -:Gemini: `Conformity `__ +:Gemini: `Conformity `__ :INSPIRE: Conformity - degree :ISO19115: DQ_DataQuality > DQ_Element.result > DQ_ConformanceResult :Obligation: Mandatory :occurrence: Many :Definition: - A sub-element of `Data quality <#data-quality>`__, this is the degree of conformity with the product specification or user requirement against which the data is + A sub-element of `Data quality <#data-quality>`__, this is the degree of conformity with the product specification or user requirement against which the data is being evaluated (i.e. degree of conformity to INSPIRE). :Guidance: @@ -156,7 +156,7 @@ Data quality - Conformity Data quality - Quality scope --------------------------------- -:Gemini: `Quality Scope `__ +:Gemini: `Quality Scope `__ :INSPIRE: metadata/2.0/req/datasets-and-series/one-data-quality-element :ISO19115: DQ_DataQuality.scope :Obligation: Mandatory @@ -165,17 +165,17 @@ Data quality - Quality scope :Definition: A sub-element of `Data quality <#data-quality>`__, this is specific scope to which the data quality assessment applies. -:Guidance: +:Guidance: At least one `Data quality <#data-quality>`__ element scoped to the entire dataset or series to which the metadata record refers. For a dataset, set quality scope to '**dataset**', for a dataset series, set quality scope to '**series**'. - + If using a `Data quality <#data-quality>`__ element to describe something other than the whole dataset or series, then provide additional data quality elements with their scope set appropriately. Switch to the Advanced editing view, change to the Quality tab, and Data Quality info element using the plus button at the base of the page. Set the quality scope to the appropriate level using the dropdown list. |userdoc_fig_7_4_1_ConformanceResult| - - + + Dataset language ---------------- -:Gemini: `Dataset language `__ +:Gemini: `Dataset language `__ :INSPIRE: Resource language :ISO19115: MD_DataIdentification.language :Obligation: Conditional @@ -185,10 +185,10 @@ Dataset language The language used within the dataset (assuming the data resource contains text/written information, e.g. in attribute tables). :Guidance: - Select a language from the drop down menu listing entries from the ISO 639-2 code list. For INSPIRE compliance, this has to be an - `official language of the European Community `__, - of which English (eng) is the only one in common use across the UK (and is the default). For non-INSPIRE metadata records, it can - be any ISO 639-2 three letter code, of which the relevant entries for the UK are English (eng), Welsh (cym), Gaelic (Irish) (gle), Gaelic + Select a language from the drop down menu listing entries from the ISO 639-2 code list. For INSPIRE compliance, this has to be an + `official language of the European Community `__, + of which English (eng) is the only one in common use across the UK (and is the default). For non-INSPIRE metadata records, it can + be any ISO 639-2 three letter code, of which the relevant entries for the UK are English (eng), Welsh (cym), Gaelic (Irish) (gle), Gaelic (Scottish) (gla), Cornish (cor), Ulster Scots (sco). |userdoc_fig_7_13_1_DatasetLanguage| @@ -196,22 +196,22 @@ Dataset language Dataset reference date ---------------------- -:Gemini: `Dataset reference date `__ +:Gemini: `Dataset reference date `__ :INSPIRE: Date of publication :ISO19115: MD_Identification.citation > CI_Citation.date :Obligation: Mandatory :occurrence: Many :Definition: - Reference date for the data resource, indicating the date of publication, creation and/or last revision. Note that for services, this + Reference date for the data resource, indicating the date of publication, creation and/or last revision. Note that for services, this date relates to the creation, publication, and/or revision of the service, not the dataset(s) within it.) :Guidance: - This element is a notional date of publication of the data resource. It is different from the `temporal extent <#extent-temporal-extent>`__, + This element is a notional date of publication of the data resource. It is different from the `temporal extent <#extent-temporal-extent>`__, which is the date of currency of the resource. Multiple dataset reference dates can be defined, but there must only be one of type *creation* and only one of type *revision*. - - Dates may be to any degree of precision, from year (YYYY) to full date and time. The extended date format (YYYY-MM-DD) should be used, where YYYY is - the year, MM the month, and DD the day. If required, time (HH:MM:SS, where HH is the hour, MM the minute, and SS the second) may be added, with + + Dates may be to any degree of precision, from year (YYYY) to full date and time. The extended date format (YYYY-MM-DD) should be used, where YYYY is + the year, MM the month, and DD the day. If required, time (HH:MM:SS, where HH is the hour, MM the minute, and SS the second) may be added, with 'T' separating the two parts. |userdoc_fig_7_6_1_ReferenceDate| @@ -219,95 +219,95 @@ Dataset reference date Extent - Geographic bounding box -------------------------------- -:Gemini: `Bounding box `__ +:Gemini: `Bounding box `__ :INSPIRE: Geographic bounding box :ISO19115: MD_DataIdentification.extent > EX_Extent > EX_GeographicExtent > EX_GeographicBoundingBox :Obligation: Mandatory :occurrence: Many :Definition: - Rectangle enclosing the extent of the data resource described in latitude and longitude, to enable the resource to be located geographically. + Rectangle enclosing the extent of the data resource described in latitude and longitude, to enable the resource to be located geographically. It has four sub-elements: *west bounding longitude*, *east bounding longitude*, *south bounding latitude*, and *north bounding latitude*. :Guidance: - A pre-defined extent can be chosen from the drop down menu, or bounding coordinates can be manually entered in the corresponding boxes. The + A pre-defined extent can be chosen from the drop down menu, or bounding coordinates can be manually entered in the corresponding boxes. The west bounding longitude should be less than the east bounding longitude, and the north bounding latitude must be greater than the south. |userdoc_fig_7_8_1_GeogBoundingBox| Extent - Geographic description ------------------------------- -:Gemini: `Extent `__ +:Gemini: `Extent `__ :INSPIRE: n/a :ISO19115: MD_DataIdentification.extent > EX_Extent > EX_GeographicExtent > EX_GeographicDescription.geographicIdentifier :Obligation: Optional :occurrence: Many :Definition: - The geographical extent of the data resource relative to an administrative hierarchy. Note that it is the coverage of the data resource, not - the individual objects in the data resource. Thus if the data resource was national parks in Scotland, the extent would be 'Scotland', even - though many parts of Scotland do not have National Parks. Sub-elements of the geographic description are the *code* identifying the extent and + The geographical extent of the data resource relative to an administrative hierarchy. Note that it is the coverage of the data resource, not + the individual objects in the data resource. Thus if the data resource was national parks in Scotland, the extent would be 'Scotland', even + though many parts of Scotland do not have National Parks. Sub-elements of the geographic description are the *code* identifying the extent and the *designating authority* (optional). :Guidance: - Enter a pre-defined extent of country or Local Authority using one of the controlled lists available in the drop down above the bounding box element (e.g. Geonames). + Enter a pre-defined extent of country or Local Authority using one of the controlled lists available in the drop down above the bounding box element (e.g. Geonames). Note that this element may also be populated using a linked data register entry, for example `http://statistics.gov.scot/id/statistical-geography/S92000003 `__. |userdoc_fig_7_9_1_GeogDescription| Extent - Temporal extent ------------------------ -:Gemini: `Temporal extent `__ +:Gemini: `Temporal extent `__ :INSPIRE: Temporal extent :ISO19115: EX_Extent > EX_TemporalExtent.extent :Obligation: Mandatory (dataset), Conditional (service) :occurrence: Many :Definition: - This is the date(s) that describes the time period covered by the content of the dataset. It may refer to (a) the period of collection of the - data or (b) the date at which it is deemed to be current. Temporal extent is the date of the validity of the data, and is different from the + This is the date(s) that describes the time period covered by the content of the dataset. It may refer to (a) the period of collection of the + data or (b) the date at which it is deemed to be current. Temporal extent is the date of the validity of the data, and is different from the `dataset reference date <#date>`__ (i.e. publication). :Guidance: Enter a Begin date and/or End date as required. Click on |button_edit_calendar| to activate the calendar selector. To add additional temporal extents, use the `advanced editor view `__. - + **2|** Scroll to the extent section (identification tab) and click the |button_edit_plusdrop| button next to the **Temporal element** label. - + **3|** From the dropdown menu, select **Temporal Extent**. This will present a further |button_edit_plusdrop| button labeled **Extent**. - + **4|** From the dropdown menu, select the extent type from either time edge, instant, node or period. - + *Note: if the temporal extent is composed of a begining and an end date, select time period. If it is a single date (e.g. census day) choose time instant. The time edge and node options are not often used.* **5|** If the time period option is chosen, use the |button_edit_plusdrop| buttons to add begining and end dates. - - Enter a date, or two dates defining the duration of the period, as defined by BS ISO 8601. Dates may be to any degree of precision, from year - (YYYY) to full date and time. The extended date format (YYYY-MM-DD) should be used, where YYYY is the year, MM the month, and DD the day. If - required, time (HH:MM:SS, where HH is the hour, MM the minute, and SS the second) may be added, with 'T' separating the two parts. Periods are - recorded as {fromdate/todate} (e.g. 2006-04-01/2007-03-31). Either the from date or the to date (but not both) of the time period may be left + + Enter a date, or two dates defining the duration of the period, as defined by BS ISO 8601. Dates may be to any degree of precision, from year + (YYYY) to full date and time. The extended date format (YYYY-MM-DD) should be used, where YYYY is the year, MM the month, and DD the day. If + required, time (HH:MM:SS, where HH is the hour, MM the minute, and SS the second) may be added, with 'T' separating the two parts. Periods are + recorded as {fromdate/todate} (e.g. 2006-04-01/2007-03-31). Either the from date or the to date (but not both) of the time period may be left blank to indicate uncertainty. |userdoc_fig_7_10_1_TemporalExtent| Extent - Vertical extent ------------------------ -:Gemini: `Vertical extent information `__ +:Gemini: `Vertical extent information `__ :INSPIRE: n/a :ISO19115: MD_DataIdentification.extent > EX_Extent > EX_VerticalExtent :Obligation: Optional :occurrence: Many :Definition: - Describes the vertical domain (height range) of the data resource. The element is composed of the **minimum value**, **maximum value** and the **vertical + Describes the vertical domain (height range) of the data resource. The element is composed of the **minimum value**, **maximum value** and the **vertical coordinate reference system** (recorded as a name or code from a recognised thesaurus, i.e. `EPSG Geodetic Parameter Registry `__). :Guidance: This element should be completed only where the vertical extent is relevant (e.g. geology, mining, etc.). If it is relevant, then all sub-elements are mandatory. - + To add the vertical extent: - + **1|** In default (simple) view, scroll to the extent element and click |button_edit_verticalextent|. - + **2|** Enter a minimum value in metres. **3|** Enter a maximum value in metres. @@ -319,7 +319,7 @@ Extent - Vertical extent File identifier ------------------- -:Gemini: `File identifier `__ +:Gemini: `File identifier `__ :INSPIRE: metadata/2.0/rec/common/fileIdentifier :ISO19115: MD_Metadata.fileIdentifier :Obligation: Mandatory @@ -333,11 +333,11 @@ File identifier File identifier should not be confused with the UK GEMINI2 metadata item `Resource identifier <#resource-identifier>`__, which identifies the data resource being described. -|userdoc_fig_7_31_1_FileIdentifier| +|userdoc_fig_7_31_1_FileIdentifier| Hierarchy level name -------------------- -:Gemini: `Hierarchy level name `__ +:Gemini: `Hierarchy level name `__ :INSPIRE: Hierarchy level :ISO19115: MD_Metadata.hierarchyLevelName :Obligation: Mandatory for series and services, optional for datasets @@ -353,32 +353,32 @@ Hierarchy level name Keyword ------- -:Gemini: `Keyword `__ +:Gemini: `Keyword `__ :INSPIRE: Keyword :ISO19115: MD_Identification.descriptiveKeywords > MD_Keywords :Obligation: Mandatory :occurrence: Many :Definition: - Terms covering the subject of the data resource that are more specific than those entered under `topic category <#topic-category>`__. Ideally, + Terms covering the subject of the data resource that are more specific than those entered under `topic category <#topic-category>`__. Ideally, these will be standardised keywords originating from a controlled vocabulary, so that resources can be identified in any search. :Guidance: It is recommended that keyword values be taken from a standardised subject vocabularies, such as `General Environmental Multi-Lingual Thesaurus (GEMET) `__ or the `Integrated Public Sector Vocabulary (IPSV) `__, - and the formal citation provided (including the date, version and any amendments where appropriate). This will enable other users to perform + and the formal citation provided (including the date, version and any amendments where appropriate). This will enable other users to perform more efficient searches and eliminate resources that are of no interest more easily. - - If the dataset is covered under INSPIRE, then the **first** keyword should be from the `General Environmental Multi-Lingual Thesaurus (GEMET) - INSPIRE Spatial Data Themes `__ list. + + If the dataset is covered under INSPIRE, then the **first** keyword should be from the `General Environmental Multi-Lingual Thesaurus (GEMET) - INSPIRE Spatial Data Themes `__ list. Service records must include a keyword from the INSPIRE `Classification of spatial data services `__ code list. - + To add new keywords from a controlled vocabulary to the editing form: **1|** Click the |button_edit_selectthesaurus| button below the keywords element. - + **2|** Select the desired thesaurus (e.g. GEMET - INSPIRE themes, version 1.0). This will add a search box for the thesaurus. - + **3|** Click to select the relevant keyword. The citiation for the originating vocabulary will be pre-populated. - + *Note: alternately, free text keywords can be added by clicking the* |button_edit_addkeyword| *button.* |userdoc_fig_7_12_1_Keywords| @@ -386,25 +386,25 @@ Keyword Limitations on public access ---------------------------- -:Gemini: `Limitations on public access `__ +:Gemini: `Limitations on public access `__ :INSPIRE: Limitations on public access :ISO19115: MD_Identification.resourceConstraints > MD_LegalConstraints.accessConstraints & otherConstraints :Obligation: Mandatory :occurrence: Many :Definition: - Restrictions imposed on **access** to the data resource for security and other reasons (i.e. who can see the data). + Restrictions imposed on **access** to the data resource for security and other reasons (i.e. who can see the data). :Guidance: - Limitations on public access is different from the `use constraints <#use-constraints>`__ element, which describes limitations on using the data, - such as fees or licencing restrictions, rather than the access to it. A data resource can be openly accessible (which all INSPIRE data should + Limitations on public access is different from the `use constraints <#use-constraints>`__ element, which describes limitations on using the data, + such as fees or licencing restrictions, rather than the access to it. A data resource can be openly accessible (which all INSPIRE data should be), but have restrictions on its use such as licensing, fees, or usage limitations. - + For INSPIRE purposes, the *Limitations on public access* dropdown box must be set to '**other restrictions**'. The anchor element below must then be populated with an appropriate label from the `INSPIRE code list for Limitations on public access `__. Change the anchor label to the appropriate entry from the code list, and ensure the URL points to the corresponding code list URI. - Article 13 of the Directive contains a list of cases where limitations on public access can be set. With regards to providing the metadata for - the datasets and services through discovery services, the limitations on public access can be set on the base of reasons of international - relations, public security or national defence. Concerning providing View, Download or Transformation Services, or e-commerce services, + Article 13 of the Directive contains a list of cases where limitations on public access can be set. With regards to providing the metadata for + the datasets and services through discovery services, the limitations on public access can be set on the base of reasons of international + relations, public security or national defence. Concerning providing View, Download or Transformation Services, or e-commerce services, limitations on public access can be set on the base of the following reasons: * the confidentiality of the proceedings of public authorities, where such confidentiality is provided for by law; @@ -417,12 +417,12 @@ Limitations on public access * the protection of the environment to which such information relates, such as the location of rare species. This element shall **only** include information regarding access to the resource (not the use of the data, which is documented under the `Use constraints <#use-constraints>`__ section). When Member States limit public access to spatial data sets and spatial data services under Article 13 of Directive 2007/2/EC, this metadata element shall provide information on the limitations and the reasons for them. If there are no limitations on public access, this metadata element shall indicate that fact. - + |userdoc_fig_7_14_1_LimitationsPublicAccess| Lineage -------- -:Gemini: `Lineage `__ +:Gemini: `Lineage `__ :INSPIRE: Lineage :ISO19115: DQ_DataQuality.lineage > LI_Lineage.statement :Obligation: Mandatory @@ -432,22 +432,22 @@ Lineage A sub-element of `data quality <#data-quality>`__ that should provide information about the events or source data used in the creation of the data resource. This will be useful in determining whether the data is fit for purpose. :Guidance: - The lineage differs from the `abstract <#abstract>`__ in that it covers 'how' the dataset was created as opposed the 'what' and 'why' of the - dataset. A brief technical description should be given noting any sources and processes used. Any procedures or protocol associated with the + The lineage differs from the `abstract <#abstract>`__ in that it covers 'how' the dataset was created as opposed the 'what' and 'why' of the + dataset. A brief technical description should be given noting any sources and processes used. Any procedures or protocol associated with the update of the dataset should also be noted, along with notes on previous updates. |userdoc_fig_7_15_1_Lineage| Maintenance information -------------------------------- -:Gemini: `Maintenance information `__ +:Gemini: `Maintenance information `__ :INSPIRE: Maintenance information :ISO19115: MD_MaintenanceInformation.maintenanceAndUpdateFrequency :Obligation: Optional :occurrence: One :Definition: - Information about the scope and frequency of updating. Note that this identifies how often the updated + Information about the scope and frequency of updating. Note that this identifies how often the updated data resource is made available to the user (for instance a data resource may be updated continuously, but released to the user only monthly). :Guidance: @@ -457,7 +457,7 @@ Maintenance information Metadata date stamp ------------------- -:Gemini: `Metadata date `__ +:Gemini: `Metadata date `__ :INSPIRE: Metadata date :ISO19115: MD_Metadata.dataStamp :Obligation: Mandatory @@ -467,45 +467,45 @@ Metadata date stamp The date on which the metadata was last updated. :Guidance: - This element is not editable and is set by the editor when the file is saved. It is used by `spatialdata.gov.scot `__ and `data.gov.uk `__ to determine if metadata - with the same field identifier (UUID) has been changed. A single date is specified in the extended format YYYY-MM-DD, where YYYY is the year, + This element is not editable and is set by the editor when the file is saved. It is used by `spatialdata.gov.scot `__ and `data.gov.uk `__ to determine if metadata + with the same field identifier (UUID) has been changed. A single date is specified in the extended format YYYY-MM-DD, where YYYY is the year, MM is the month and DD is the day. |userdoc_fig_7_18_1_MetadataDate| Metadata language ----------------- -:Gemini: `Metadata language `__ +:Gemini: `Metadata language `__ :INSPIRE: Metadata language :ISO19115: MD_Metadata.language :Obligation: Mandatory :occurrence: One :Definition: - The language used to document the metadata. The purpose of this element is to identify the language used in a multi-lingual metadata service, + The language used to document the metadata. The purpose of this element is to identify the language used in a multi-lingual metadata service, for example in the INSPIRE geo-portal. :Guidance: - Selected a language from the drop down menu listing entries from the ISO 639-2 code list. For INSPIRE compliance, this has to be an - `official language of the European Community `__, - of which English (eng) is the only one in common use across the UK (and is the default in the SSDI). For non-INSPIRE metadata records, it can - be any ISO 639-2 three letter code, of which the relevant entries for the UK are English (eng), Welsh (cym), Gaelic (Irish) (gle), Gaelic + Selected a language from the drop down menu listing entries from the ISO 639-2 code list. For INSPIRE compliance, this has to be an + `official language of the European Community `__, + of which English (eng) is the only one in common use across the UK (and is the default in the SSDI). For non-INSPIRE metadata records, it can + be any ISO 639-2 three letter code, of which the relevant entries for the UK are English (eng), Welsh (cym), Gaelic (Irish) (gle), Gaelic (Scottish) (gla), Cornish (cor), Ulster Scots (sco). |userdoc_fig_7_20_1_MetadataLanguage| Metadata point of contact ------------------------- -:Gemini: `Metadata point of contact `__ +:Gemini: `Metadata point of contact `__ :INSPIRE: Metadata point of contact :ISO19115: MD_Metadata.contact > CI_ResponsibleParty :Obligation: Mandatory :occurrence: Many :Definition: - This element records the details of the organisation(s) responsible for the creation and maintenance of the metadata record. The structure of + This element records the details of the organisation(s) responsible for the creation and maintenance of the metadata record. The structure of this element is the same as the `Point of contact <#point-of-contact>`__ element. There are eight sub-elements: - + * Organisation name * Position name (i.e. job role or position of the responsible person or business area) * Voice (i.e. telephone number) @@ -516,38 +516,38 @@ Metadata point of contact * Role (of the responsible party with respect to the metadata) :Guidance: - Of the eight sub-elements, only the **organisation name**, **email address** and **role** are mandatory. All other sub-elements are optional. + Of the eight sub-elements, only the **organisation name**, **email address** and **role** are mandatory. All other sub-elements are optional. With regards to the *organisation name*, this should be provided in full without abbreviations. In terms of the *role*, for INSPIRE purposes this must be set to *point of contact*. - - For *position name*, a general job title (e.g. Data Manager) should be identified rather than individuals which are subject to change without - notice and difficult to maintain. Likewise, email addresses should be provided for branch or team (i.e. shared) mailboxes where possible rather + + For *position name*, a general job title (e.g. Data Manager) should be identified rather than individuals which are subject to change without + notice and difficult to maintain. Likewise, email addresses should be provided for branch or team (i.e. shared) mailboxes where possible rather than for individuals. - - If the user has stored contact details in a `directory entry `__ on the portal, details can be auto-populated by - searching for the contact in the search box below the element. - + + If the user has stored contact details in a `directory entry `__ on the portal, details can be auto-populated by + searching for the contact in the search box below the element. + |userdoc_fig_7_17_1_MetadataContact| Metadata standard name ---------------------- -:Gemini: `Metadata standard name `__ +:Gemini: `Metadata standard name `__ :INSPIRE: N/A :ISO19115: MD_Metadata.metadataStandardName :Obligation: Optional in GEMINI but required in `spatialdata.gov.scot `__ :occurence: One :Definition: - Name of the metadata standard or profile used, cited with a reference to the appropriate register entry. + Name of the metadata standard or profile used, cited with a reference to the appropriate register entry. :Guidance: This element is required in `spatialdata.gov.scot `__ and must be set to `UK GEMINI `__ when importing metadata records into the portal. For records created within the portal from templates, this element will be automatically filled in, and will not be editable in the default editing view. - - + + Metadata standard version ------------------------- -:Gemini: `Metadata standard version `__ +:Gemini: `Metadata standard version `__ :INSPIRE: N/A :ISO19115: MD_Metadata.metadataStandardVersion :Obligation: Optional in GEMINI but required in `spatialdata.gov.scot `__ @@ -560,18 +560,18 @@ Metadata standard version This element is required in `spatialdata.gov.scot `__ and must be set to **2.3** when importing metadata records into the portal. For records created within the portal from templates, this element will be automatically filled in, and will not be editable in the default editing view. |userdoc_fig_7_32_1_MetadataStandard| - - + + Parent identifier ----------------- -:Gemini: `Parent identifier `__ +:Gemini: `Parent identifier `__ :INSPIRE: N/A :ISO19115: MD_parentidentifier.scope :Obligation: Optional :occurrence: One :Definition: - File identifier of the metadata that is a parent to this child metadata. It supports parent-child relationships in metadata and allows navigation from a dataset record to the series record of which it forms a part. + File identifier of the metadata that is a parent to this child metadata. It supports parent-child relationships in metadata and allows navigation from a dataset record to the series record of which it forms a part. :Guidance: Only to be used if the dataset is part of a series. To add a parent identifier, click |button_edit_addparent| and add the Unique Identifier for the parent record. @@ -580,7 +580,7 @@ Parent identifier Resource identifier ------------------- -:Gemini: `Resource identifier `__ +:Gemini: `Resource identifier `__ :INSPIRE: Unique resource identifier :ISO19115: MD_DataIdentification.citation > CI_Citation.identifier :Obligation: Mandatory (datasets), Optional (services) @@ -590,8 +590,8 @@ Resource identifier A value uniquely identifying the data resource within your organisation (i.e. how your organisation references the dataset). :Guidance: - The *Code* element is mandatory, and should be a recognisable identifier within the context of your organisation (i.e. a unique code of numbers, - letters or combination of referring to a single dataset). If it is not guaranteed to be unique across the UK and the wider EU (INSPIRE), + The *Code* element is mandatory, and should be a recognisable identifier within the context of your organisation (i.e. a unique code of numbers, + letters or combination of referring to a single dataset). If it is not guaranteed to be unique across the UK and the wider EU (INSPIRE), then the *Codespace* sub-element must be specified; this should be the internet domain of the data provider/owner. |userdoc_fig_7_3_1_CitationIdentifier| @@ -599,28 +599,28 @@ Resource identifier Resource locator ---------------- -:Gemini: `Resource locator `__ +:Gemini: `Resource locator `__ :INSPIRE: Resource locator :ISO19115: MD_Distribution > MD_DigitalTransferOptions.online > CI_OnlineResource.linkage :Obligation: Conditional :occurrence: Many :Definition: - Location (address) for on-line access to the resource using a Uniform Resource Locator (URL). This element should point to where the dataset - may be accessed, and may be different from where it may be ordered online (which should be included in the web address of the distributor). + Location (address) for on-line access to the resource using a Uniform Resource Locator (URL). This element should point to where the dataset + may be accessed, and may be different from where it may be ordered online (which should be included in the web address of the distributor). :Guidance: - This element should primarily be used to enter URLs for web services (i.e. WMS, WFS, etc.), however, links to web pages offering more - information or other services (e.g. interactive mapping applications) can also be added. To add an online resource, follow the instructions + This element should primarily be used to enter URLs for web services (i.e. WMS, WFS, etc.), however, links to web pages offering more + information or other services (e.g. interactive mapping applications) can also be added. To add an online resource, follow the instructions provided in the `Associated resources `__ section. Once an online resource has been added, it can be edited as normal - in the editing form. Note that for web services to be displayed in the interactive map, the **protocol**, **layer name** and **description** + in the editing form. Note that for web services to be displayed in the interactive map, the **protocol**, **layer name** and **description** must be entered. The layer name **must** match that as defined in the GetCapabilities request of the service. - + |userdoc_fig_7_21_1_OnLineResource| Resource type --------------- -:Gemini: `Resource type `__ +:Gemini: `Resource type `__ :INSPIRE: Resource type :ISO19115: MD_Metadata.hierarchyLevel :Obligation: Mandatory @@ -630,23 +630,23 @@ Resource type Scope to which the metadata applies (i.e. dataset, series, service). :Guidance: - Identify whether resource is a dataset or a series (collection of datasets with a common specification). For metadata created on `spatialdata.gov.scot `__, this element is set by the + Identify whether resource is a dataset or a series (collection of datasets with a common specification). For metadata created on `spatialdata.gov.scot `__, this element is set by the choice of template and should not be changed. |userdoc_fig_7_5_1_HierarchyLevel| Responsible organisation ------------------------ -:Gemini: `Responsible organisation `__ +:Gemini: `Responsible organisation `__ :INSPIRE: Responsible party :ISO19115: MD_Identification.pointOfContact :Obligation: Mandatory :occurrence: Many :Definition: - This element records the details of the organisation(s) responsible for the creation, maintenance and distribution of the data resource. The + This element records the details of the organisation(s) responsible for the creation, maintenance and distribution of the data resource. The structure of this element is the same as the `Metadata contact <#metadata-contact>`__ element. There are eight sub-elements: - + * Organisation name * Position name (i.e. job role or position of the responsible person) * Voice (i.e. telephone number) @@ -657,44 +657,44 @@ Responsible organisation * Role (of the responsible party with respect to the resource) :Guidance: - Of the eight sub-elements, only the **orgnaisation name**, **email address** and **role** are mandatory. All other sub-elements are optional. + Of the eight sub-elements, only the **orgnaisation name**, **email address** and **role** are mandatory. All other sub-elements are optional. With regards to the *organisation name*, this should be provided in full without abbreviations. In terms of the *role*, if a responsible party - is both the creator, publisher and distributor of the resource then the role should be set to *Publisher*. If the resource was created by a + is both the creator, publisher and distributor of the resource then the role should be set to *Publisher*. If the resource was created by a party other than the provider this should also be recorded, using the role value *Originator*. - - For *position name*, a general job title (e.g. Data Manager) should be identified rather than individuals which are subject to change without - notice and difficult to maintain. Likewise, email addresses should be provided for branch or team (i.e. shared) mailboxes where possible rather + + For *position name*, a general job title (e.g. Data Manager) should be identified rather than individuals which are subject to change without + notice and difficult to maintain. Likewise, email addresses should be provided for branch or team (i.e. shared) mailboxes where possible rather than for individuals. - If the user has stored contact details in a `directory entry `__ on the portal, details can be auto-populated by + If the user has stored contact details in a `directory entry `__ on the portal, details can be auto-populated by searching for the contact in the search box below the element. |userdoc_fig_7_22_1_PointofContact| Spatial reference system ---------------------------- -:Gemini: `Spatial reference system `__ +:Gemini: `Spatial reference system `__ :INSPIRE: n/a :ISO19115: MD_ReferenceSystem.referenceSystemIdentifier > RS_Identifier.code :Obligation: Mandatory :occurrence: Many :Definition: - Identifier, name or description of the system of spatial referencing, whether by coordinates or geographic identifiers, used in the data + Identifier, name or description of the system of spatial referencing, whether by coordinates or geographic identifiers, used in the data resource. :Guidance: The reference system should be recorded referencing a well known common register (e.g. `EPSG Geodetic Parameter Registry `__) in a URL link format. For INSPIRE purposes the **first entry** must be one of the reference systems listed in Annex D.4 (Default Coordinate Reference Systems) of the `INSPIRE Metadata Technical Guidelines `__. For this reason it is recommended that ETRS89 is included as the first entry, and if desired British National Grid as a secondary entry. Failure to do so will result in a validation error. - + The box below the element can be used to search for and add additional reference systems. |userdoc_fig_7_23_1_ReferenceSystem| Spatial representation type ---------------------------- -:Gemini: `Spatial representation type `__ +:Gemini: `Spatial representation type `__ :INSPIRE: Spatial representation type -:ISO19115: MD_DataIdentification.spatialRepresentationType +:ISO19115: MD_DataIdentification.spatialRepresentationType :Obligation: Mandatory :occurrence: Many @@ -708,27 +708,27 @@ Spatial representation type Spatial resolution - Distance ----------------------------- -:Gemini: `Spatial resolution `__ +:Gemini: `Spatial resolution `__ :INSPIRE: Spatial resolution :ISO19115: MD_Identification.spatialResolution > MD_Resolution.distance :Obligation: Conditional :occurrence: Many :Definition: - A distance measure of the granularity (in metres), providing an indication of how detailed the data is. It is equivalent to the ground sample + A distance measure of the granularity (in metres), providing an indication of how detailed the data is. It is equivalent to the ground sample distance and should not be confused with the scale of a map (which is purely a display attribute). :Guidance: - Enter values that are real numbers, greater than 0, and specified in metres. Commonly used distances can be added from the recommended values - drop down next to the element. For data captured in the field, it is the precision at which the data is captured (this may be the accuracy for - topographic surveys, or the average sampling distance in an environmental survey). For data taken from maps, it is the positional accuracy of + Enter values that are real numbers, greater than 0, and specified in metres. Commonly used distances can be added from the recommended values + drop down next to the element. For data captured in the field, it is the precision at which the data is captured (this may be the accuracy for + topographic surveys, or the average sampling distance in an environmental survey). For data taken from maps, it is the positional accuracy of the map, while for image data it is the resolution of the image. |userdoc_fig_7_24_1_SpatialResDistance| Spatial resolution - Equivalent scale ------------------------------------- -:Gemini: `Equivalent scale `__ +:Gemini: `Equivalent scale `__ :INSPIRE: Equivalent scale :ISO19115: MD_Identification.spatialResolution > MD_Resolution.equivalentScale > MD_RepresentativeFraction.denominator :Obligation: Optional @@ -740,30 +740,30 @@ Spatial resolution - Equivalent scale :Guidance: Where the data is captured from a map, the scale of that map should be recorded as a positive integer. Note that `distance <#spatial-resolution-equivalent-scale>`__ is the preferred expression for spatial resolution. The equivalent scale should only be given when the distance cannot be determined. - + |userdoc_fig_7_25_1_SpatialResEqScale| Title ----- -:Gemini: `Title `__ +:Gemini: `Title `__ :INSPIRE: Resource title :ISO19115: MD_DataIdentification.citation > CI_Citation.title :Obligation: Mandatory :occurrence: One :Definition: - The name given to the data resource. + The name given to the data resource. :Guidance: - This should be the formal or product name if one exists. Otherwise the title should be created that is short, encapsulates the subject, + This should be the formal or product name if one exists. Otherwise the title should be created that is short, encapsulates the subject, temporal and spatial coverage of the data resource, and does not contain terms or jargon that make it incomprehensible. |userdoc_fig_7_27_1_Title| Topic category -------------- -:Gemini: `Topic category `__ +:Gemini: `Topic category `__ :INSPIRE: Resource topic category :ISO19115: MD_DataIdentification.topicCategory :Obligation: Mandatory (datasets), N/A (services) @@ -773,44 +773,44 @@ Topic category Describes the main theme(s) of the data resource, using `topic categories in accordance with ISO 19115 standard `__. :Guidance: - Select from the drop down list one or more categories that most closely represent the topic of the data resource. This element is only meant to + Select from the drop down list one or more categories that most closely represent the topic of the data resource. This element is only meant to represent the general theme of the information. `Keywords <#keywords>`__ should be used to provide greater detail on the nature of the dataset. - While more than one topic category can be applied, only a limited number of most relevant should be chosen (e.g. topographic maps should not + While more than one topic category can be applied, only a limited number of most relevant should be chosen (e.g. topographic maps should not be classified as farming). Multiple topic categories can be added. - - Note that the choice of topic category will dictate which categories the data resource is listed under on the **Browse by topics** section of + + Note that the choice of topic category will dictate which categories the data resource is listed under on the **Browse by topics** section of the homepage. |userdoc_fig_7_28_1_TopicCategory| - + Use constraints --------------- -:Gemini: `Use constraints `__ +:Gemini: `Use constraints `__ :INSPIRE: Conditions applying to access and use :ISO19115: MD_Identification.resourceConstraints > MD_LegalConstraints.useConstraints & otherConstraints :Obligation: Mandatory :occurrence: Many :Definition: - Restrictions and legal constraints on **using** the data resource. This can be entered as a free text statement, or link to a URL containing + Restrictions and legal constraints on **using** the data resource. This can be entered as a free text statement, or link to a URL containing the information. - + :Guidance: - Use constraints are different from `limitations on public access <#limitations-on-public-access>`__ which describe limitations on access to the - data. A data resource can be openly accessible (which all INSPIRE data should be), but have restrictions on its use such as licensing, fees, or - usage limitations. + Use constraints are different from `limitations on public access <#limitations-on-public-access>`__ which describe limitations on access to the + data. A data resource can be openly accessible (which all INSPIRE data should be), but have restrictions on its use such as licensing, fees, or + usage limitations. This element comprises two sub-elements: the 'use constraints' which should be set to *other restrictions*, and 'other constraints' which can be free text or a URL link. **1|** useConstraints- should contain an MD_RestrictionCode element with code list value "otherRestrictions" **2|** otherConstraints- a free text element describing the usage restrictions or link to a URL, as below. - - To link to a URL in the otherConstraints element, click the |button_edit_plusdrop| button and choose either the *anchor* option. All records - on `spatialdata.gov.scot `__ should document the licencing arrangements for the data resource using the anchor type. Where possible, this should link to a URL - such as the `Open Government Licence `__, + + To link to a URL in the otherConstraints element, click the |button_edit_plusdrop| button and choose either the *anchor* option. All records + on `spatialdata.gov.scot `__ should document the licencing arrangements for the data resource using the anchor type. Where possible, this should link to a URL + such as the `Open Government Licence `__, `Non-Commercial Government Licence `__, - or `INSPIRE End User Licence `__. + or `INSPIRE End User Licence `__. Users can further categorise their records in terms of licence type by following the guidance in the `assigning a licence category `__ section. |userdoc_fig_7_29_1_UseConstraints| diff --git a/docs/UserDoc_Chap8_Annex1.rst b/docs/UserDoc_Chap8_Annex1.rst index dfcc1eb..8d36dc2 100644 --- a/docs/UserDoc_Chap8_Annex1.rst +++ b/docs/UserDoc_Chap8_Annex1.rst @@ -1,8 +1,8 @@ Annex 1: Requirements for metadata to be correctly identified as UK Gemini ========================================================================== -Records that are imported into `SpatialData.gov.scot `__ (rather than created within the portal using the available templates) must include the following XML elements -to ensure that the record is correctly identified as `UK GEMINI `__ upon import. +Records that are imported into `SpatialData.gov.scot `__ (rather than created within the portal using the available templates) must include the following XML elements +to ensure that the record is correctly identified as `UK GEMINI `__ upon import. *Note: Using the default* **to-gemini23** *xsl transformation when* `importing `__ *will do this for you.* diff --git a/docs/UserDoc_Chap9_Annex2.rst b/docs/UserDoc_Chap9_Annex2.rst index 9fc0629..a39cf23 100644 --- a/docs/UserDoc_Chap9_Annex2.rst +++ b/docs/UserDoc_Chap9_Annex2.rst @@ -1,16 +1,16 @@ Annex 2: Upgrading to UK Gemini 2.3 =================================== -`SpatialData.gov.scot `__ has now implemented `UK GEMINI `__ 2.3. All new metadata created on the portal will conform to version 2.3, and metadata publishers are strongly encouraged to upgrade their existing 2.2 records as soon as possible. This section provides guidance on how users can upgrade their existing metadata via a number of methods. For detail on what has changed from version 2.2 to 2.3, please see information provided by the `Association of Geographic Information (AGI) `__. +`SpatialData.gov.scot `__ has now implemented `UK GEMINI `__ 2.3. All new metadata created on the portal will conform to version 2.3, and metadata publishers are strongly encouraged to upgrade their existing 2.2 records as soon as possible. This section provides guidance on how users can upgrade their existing metadata via a number of methods. For detail on what has changed from version 2.2 to 2.3, please see information provided by the `Association of Geographic Information (AGI) `__. The conversion tools will make the following changes to 2.2 records to make them compliant with Gemini 2.3: * Add or otherwise update the **MetadataStandardName** to UK GEMINI and the **MetadataStandardVersion** to 2.3. * Change the encoding of the **Access Constraints** and **Use Limitations** elements to meet the new standard, either making a best guess at moving your existing constraints into the correct encoding, or adding the default "no limitations" constraints as appropriate. -* Adds the default INSPIRE **Conformance Report** for datasets or services if one does not already exist. +* Adds the default INSPIRE **Conformance Report** for datasets or services if one does not already exist. * Replaces any references to `http://www.opengis.net/gml `__ with `http://www.opengis.net/gml/3.2 `__. * Adds a default **Character Encoding** of UTF8. - + Updating through an editing session ----------------------------------- @@ -30,15 +30,15 @@ To convert an existing record to Gemini 2.3: **2|** On the right hand side of the editing board, run the suggestions wizard. *Note: if the if the record is currently recognised as Gemini 2.2, the following suggestion should appear: Metadata Schema is Gemini 2.2. Run this task to convert to Gemini 2.3.* - + **3|** Click the suggestion to run the transformation script. - + *Note: the record will be converted to Gemini 2.3 and the editing view will change to show the embedded 2.3 guidance.* - + **4|** Ensure the record is valid by clicking |button_edit_validate| in the header bar. See `validating metadata `__ for more information. - + *Note: The conversion process will not automatically create valid metadata. Users must ensure that the record validates and correct any errors.* - + **5|** Click |button_edit_saveclose| to save and close the record. @@ -48,11 +48,11 @@ Updating records on import Metadata records can also be converted from 2.2 to 2.3 on import into `SpatialData.gov.scot `__. **1|** Follow steps 1 to 4 of `importing an existing XML metadata record `__. - + **2|** For the XSLT transformation, select GEMINI 2.2 to GEMINI 2.3 from the drop down menu. - + **3|** Follow the remaining steps to import the record. - + **4|** Users should ensure the imported metadata is valid. See `validating metadata `__ for more information. Updating harvested records diff --git a/docs/media/add_wfs_harvester_button.png b/docs/media/add_wfs_harvester_button.png new file mode 100644 index 0000000..c0b2051 Binary files /dev/null and b/docs/media/add_wfs_harvester_button.png differ diff --git a/docs/media/adminimage06a.png b/docs/media/adminimage06a.png new file mode 100644 index 0000000..1715e9a Binary files /dev/null and b/docs/media/adminimage06a.png differ diff --git a/docs/media/adminimage06b.png b/docs/media/adminimage06b.png new file mode 100644 index 0000000..1e4bd16 Binary files /dev/null and b/docs/media/adminimage06b.png differ diff --git a/docs/media/adminimage07a.png b/docs/media/adminimage07a.png new file mode 100644 index 0000000..3422e2b Binary files /dev/null and b/docs/media/adminimage07a.png differ diff --git a/docs/media/adminimage07b.png b/docs/media/adminimage07b.png new file mode 100644 index 0000000..0f1dd94 Binary files /dev/null and b/docs/media/adminimage07b.png differ diff --git a/docs/media/hide_harvester_facets_button.png b/docs/media/hide_harvester_facets_button.png new file mode 100644 index 0000000..dc04e96 Binary files /dev/null and b/docs/media/hide_harvester_facets_button.png differ diff --git a/docs/media/remove_harvester_filter_button.png b/docs/media/remove_harvester_filter_button.png new file mode 100644 index 0000000..56d416e Binary files /dev/null and b/docs/media/remove_harvester_filter_button.png differ diff --git a/docs/media/remove_harvester_records.png b/docs/media/remove_harvester_records.png new file mode 100644 index 0000000..8fcb20b Binary files /dev/null and b/docs/media/remove_harvester_records.png differ diff --git a/docs/media/show_harvester_facets_button.png b/docs/media/show_harvester_facets_button.png new file mode 100644 index 0000000..885c5c2 Binary files /dev/null and b/docs/media/show_harvester_facets_button.png differ diff --git a/docs/ssdi_adminguidance.rst b/docs/ssdi_adminguidance.rst index 5316cc5..a1599f9 100644 --- a/docs/ssdi_adminguidance.rst +++ b/docs/ssdi_adminguidance.rst @@ -65,7 +65,7 @@ The **Editor board** can be used to perform administrative functions on individu Figure 3.1.1: Administrative functions that act on individual records, accessed from the **Editor board** -In order from left to right these are: +In order from left to right these are:show_harvester_facets_button * Privileges- set privileges on which groups can access or edit this record * Edit- access the metadata editor for this record @@ -367,13 +367,13 @@ Figure 7.3.3: Harvested records filters, top half of the screen Figure 7.3.4: Harvested records filters, bottom half of the screen -The filter facets can be expanded by clicking on the |hide_harvester_facets_button| or collapsed by clicking on the |show_harvester_facets_button| at the top right corner of the summary box. +The filter facets can be expanded by clicking on the |show_harvester_facets_button| or collapsed by clicking on the |hide_harvester_facets_button| at the top right corner of the summary box. A list of the filtered records can be reviewed in the harvested records subsection and filters can be cleared by clicking on the |remove_harvester_filter_button|. Filtered records can be removed in bulk by clicking the |remove_harvester_records| button. -*Note: this will permanently delete the records from the catalog.* +**Note: this will PERMANENTLY delete the records from the catalog.** Harvester Reports ----------------- @@ -389,6 +389,8 @@ Feature Harvesters Here are listed the ongoing and finished jobs for indexing features from remote WFS services. Once indexed, features can then be filtered according to their attributes and the filter applied to the original map layer. +**Note: This feature is not currently being used in this implementation.** + |image6a| Figure 7.5.1: WFS Indexing Dashboard @@ -417,7 +419,7 @@ Figure 8.1.1: Status page showing catalog performing optimally Figure 8.1.2: Status page showing error, with detailed error message accessed by clicking on red link -*Report any errors shown here to Astun Technology.* +**Report any errors shown here to Astun Technology.** The metrics links provide advanced information on the status of the system and should not generally be needed. The Activity "Export (zip)" provides a log file from the server. This may be requested by Astun Technology support staff. This download could be large and may take some time. The Thread Status link provides advanced information on the java installation, and should not generally be needed. @@ -719,7 +721,7 @@ The information displayed here comes from the record’s `gmd:pointOfContact/gmd * `gmd:organisationName` determines the organisation name (in the example above- Scottish Government) * `gmd:electronicMailAddress` determines the logo- the domain has to match a logo name loaded in the catalog (in the example above the domain is gov.scot so the logo name has to be gov.scot.png) -**NB:** It’s important to note that the file extension for the logo **has to be PNG**, otherwise the logo **won’t** be associated with the resource and thus **won’t** be displayed. +**Note: It’s important to note that the file extension for the logo has to be PNG, otherwise the logo won’t be associated with the resource and thus won’t be displayed.** **Metadata information- Organisation logo** @@ -735,7 +737,7 @@ The information displayed here comes from the record’s `gmd:contact/gmd:CI_Res * `gmd:organisationName` determines the organization name (in the example above- Scottish Government) * `gmd:electronicMailAddress` determines the logo- the domain has to match a logo name loaded in the catalog (in the example above the domain is gov.scot so the logo name has to be gov.scot.png) -**NB:** It’s important to note that the file extension for the logo **has to be PNG**, otherwise the logo **won’t** be associated with the resource and thus **won’t** be displayed. +**Note: It’s important to note that the file extension for the logo has to be PNG, otherwise the logo won’t be associated with the resource and thus won’t be displayed.** **Provided by- Group logo** @@ -773,25 +775,6 @@ The CSW Service information setting allows the configuration of some of the GetC Figure 12.3.1: The CSW settings interface -Virtual CSW ------------ - -This subsection allows the configuration of Virtual CSW endpoints. These allow for different CSW URLs to be used within the catalogue, such as for different groups or metadata categories. - -To configure a new Virtual CSW endpoint, click the blue "New Virtual CSW" button and then configure the following settings: - -* Name- This will be used as the URL endpoint for the virtual CSW. **This must begin with csw-** -* Description -* Filters/Query- the filter that should be used to decide on the records that should be published under this endpoint. Choose from the dropdown list, or use the advanced query option. The figure below shows an example endpoint for records belonging to the Aberdeen group - -|image28| - -Figure 12.4.1: Virtual CSW endpoint set up for Aberdeen group - -Once a virtual endpoint has been saved, it's capabilities can be checked using the link shown below in figure 12.5.1 - -**Note that the default contact information, as configured in the CSW subsection, will be used for the GetCapabilities request** - CSW test -------- @@ -924,7 +907,11 @@ Note that the services don't return a result, just a blank page. Note also that .. |image3| image:: media/adminimage04.png .. |image4| image:: media/adminimage05.png .. |image5| image:: media/adminimage06.png +.. |image5a| image:: media/adminimage06a.png +.. |image5b| image:: media/adminimage06b.png .. |image6| image:: media/adminimage07.png +.. |image6a| image:: media/adminimage07a.png +.. |image6b| image:: media/adminimage07b.png .. |image7| image:: media/adminimage08.png .. |image7a| image:: media/adminimage08a.png .. |image7b| image:: media/adminimage08b.png @@ -990,4 +977,9 @@ Note that the services don't return a result, just a blank page. Note also that .. |button_batch_save| image:: media/button_batch_save.png .. |button_transfer| image:: media/button_transfer.png .. |analyze_records_button| image:: media/analyze_records_button.png -.. |test_link_button| image:: media/test_link_button.png \ No newline at end of file +.. |test_link_button| image:: media/test_link_button.png +.. |show_harvester_facets_button| image:: media/show_harvester_facets_button.png +.. |hide_harvester_facets_button| image:: media/hide_harvester_facets_button.png +.. |remove_harvester_filter_button| image:: media/remove_harvester_filter_button.png +.. |remove_harvester_records| image:: media/remove_harvester_records.png +.. |add_wfs_harvester_button| image:: media/add_wfs_harvester_button.png \ No newline at end of file