updates to documentation

docs/UserDoc_Chap3_Viewing.rst

@@ -6,19 +6,19 @@ This section will guide users and visitors to the site on viewing metadata and p
 Viewing metadata records
 ------------------------
 
-Clicking on the title of a record (from either the search results or those presented on the main page) will allow the user to view the metadata 
-record. Below the record title, the **abstract** provides a brief description of what the dataset (or service) is and what it is used for. The 
-spatial **extent** of the resource can be seen in the map below, in the **Discover data** section. Access to the data itself can be gained from the options listed in the 
+Clicking on the title of a record (from either the search results or those presented on the main page) will allow the user to view the metadata
+record. Below the record title, the **abstract** provides a brief description of what the dataset (or service) is and what it is used for. The
+spatial **extent** of the resource can be seen in the map below, in the **Discover data** section. Access to the data itself can be gained from the options listed in the
 **Links** section.
 
 |userdoc_fig_3_1_1_DefaultViewA|
 
 **Figure 3.1.1:** Default record view
 
-Scrolling down the page, the **Use contraints** section provides information on licencing and the **Technical information** headings provide details on topic categories and keywords, maintenance frequency, coordinate systems and data formats are provided. Information on the history of a resource and how 
+Scrolling down the page, the **Use contraints** section provides information on licencing and the **Technical information** headings provide details on topic categories and keywords, maintenance frequency, coordinate systems and data formats are provided. Information on the history of a resource and how
 it was created can be found in the **Lineage** section. The **Metadata information** section, as the name suggests, provides information on the metadata itself, as well as the option for the metadata record to be downloaded.
 
-Note that the default view for a metadata record displays a summary of the information in the record. To change the display view of the metadata 
+Note that the default view for a metadata record displays a summary of the information in the record. To change the display view of the metadata
 record:
 
 	**1|** Click on |button_view_display| at the top right of the record.
@@ -39,7 +39,7 @@ Metadata records can be exported from spatialdata.gov.scot via the download icon
 |userdoc_fig_3_2_1_ExportMetadata|
 
 **Figure 3.2.1:** Export metadata menu
-	
+
 Previewing data in the map
 --------------------------
 
@@ -63,34 +63,34 @@ To add a layer from the main map page:
 	**2|** On the right-hand side of the map, click |button_map_addlayer| at the top of the menu to open the **Add a Layer from** dialog.
 
 	**3|** On the **Search** tab of the **Add a Layer** dialog, enter text in the search box to find a layer. Alternatively, copy and paste a URL for a service into the **WMS**, **WMTS**, **WFS** or **ESRIREST** boxes on the **Services** tab. KML and KMZ can be added to the map via the **Files** tab.
- 
-	**4|** Click |button_map_addicon| below the layer title to add it to the map. If adding from a URL, click on the layer name or the |button_map_addlayer| next to the name to add it to the map.	 
-	
-	*Note: when adding straight from the map page, using the search tab, you may see layers with no name. This is caused by the 
-	web service layer names not being referenced properly in the associated resources part of the dataset metadata record. Contributors to spatialdata.gov.scot should 
-	update their metadata records so their resources in the dataset metadata are named with the layer name as it appears in the service (i.e. as listed in the GetCapabilities request). 
+
+	**4|** Click |button_map_addicon| below the layer title to add it to the map. If adding from a URL, click on the layer name or the |button_map_addlayer| next to the name to add it to the map.
+
+	*Note: when adding straight from the map page, using the search tab, you may see layers with no name. This is caused by the
+	web service layer names not being referenced properly in the associated resources part of the dataset metadata record. Contributors to spatialdata.gov.scot should
+	update their metadata records so their resources in the dataset metadata are named with the layer name as it appears in the service (i.e. as listed in the GetCapabilities request).
 	See the* `Associated Resources <UserDoc_Chap6_Edit.html#associated-resources>`__ *section for guidance on how to set up associated resources.*
 
 	|userdoc_fig_3_3_3_AddtoMapMapPage|
 
 	**Figure 3.3.3:** Adding a layer to the map via the map interface
-	
+
 To add a layer to the map from the metadata record view:
 
 	**1|** Scroll to the **API** section of the record. Services that can be added to the map will have |button_view_addtomap| beside them.
 
 	**2|** For view services (i.e. WMS), Click on |button_view_addtomap|. The user will be automatically taken to the map page.
 
 	**3|** For download services (i.e. WFS), select the layer from the drop down menu then click on |button_view_addtomap|.
-	
+
 	|userdoc_fig_3_3_2_AddtoMapRecordView|
 
-	**Figure 3.3.2:** Adding a layer to the map from the metadata record view	
+	**Figure 3.3.2:** Adding a layer to the map from the metadata record view
 
-	*Note: with respect to WFS, users may experience occasions where the layer appears to have been added to the map, yet does not display. This 
-	occurs when the Access-Control-Allow-Orgin header (CORS access policy) is missing from the remote server, and thus the request is blocked by 
+	*Note: with respect to WFS, users may experience occasions where the layer appears to have been added to the map, yet does not display. This
+	occurs when the Access-Control-Allow-Orgin header (CORS access policy) is missing from the remote server, and thus the request is blocked by
 	the browser. This is out of the control of the portal as it is dependent on the organisations' server configuration, however, an error message shall be displayed.*
-	
+
 Managing layers in the map
 --------------------------
 
@@ -99,48 +99,48 @@ Available tools for the map are arranged down the right-hand side of the page.
 To manage layers displayed in the map:
 
 	**1|** Click |button_map_managelayers| on the right-hand side of the map. This will display a list of layers currently added to the map.
-	
+
 	*Note: those with scale-dependent visibility that are not currently visible will be greyed out. Layers that cannot be added for some other reason, such as an error with the service, will display the layer name in red next to an error icon* (|button_map_exclamationicon|).
 
 	**2|** To toggle a layer on or off, click on the layer name or check/uncheck the box.
-	
-	**3|** Click the cog icon (|button_map_cogicon|) to access a menu to zoom to the extent of the layer, select syle (if available), adjust the opacity, or remove the layer from the map.
-	
-	**4|** To toggle the layer legend on or off, click |button_map_legendicon|.
+
+	**3|** Click the arrow icon (|layer_settings_button|) to the left of the layer name to access a menu to view the legend, zoom to the extent of the layer, navigate to the metadata, select syle (if available) or adjust the opacity.
+
+To view (or hide) the layer legend, click |button_map_legendicon|.
 
 |userdoc_fig_3_4_1_ManageLayers|
 
 **Figure 3.4.1:** Manage layers menu
 
 Print the map
--------------	
+-------------
 
 To print the current map:
 
 	**1|** Click |button_map_print| from the menu on the right-hand side of the map.
 
 	**2|** In the appropriate boxes, enter text for the title of the map and a description or credit for the map if desired.
-	
+
 	**3|** Choose the desired layout (landscape, overview or portrait).
-	
+
 	**4|** Choose the auto option for scale, or uncheck and select the desired scale from the dropdown list.
-	
+
 	**5|** Check the print legend box to include the legend on the map.
-	
+
 	**6|** Select the desired format (either PDF or PNG) and click |button_map_printcurrent|.
 
 	*Note: the print area will be highlighted on the map.*
 
 |userdoc_fig_3_5_1_PrintMap|
 
-**Figure 3.5.1:** Printing the current map	
-	
+**Figure 3.5.1:** Printing the current map
+
 Other map functions
 -------------------
 
 Other functionality available from the tabs on the main map page is as follows:
 
-:|button_map_default| Default Map: via the manage layers tab, allows the user to reload the default map settings (removes all layers, etc.). 
+:|button_map_default| Default Map: via the manage layers tab, allows the user to reload the default map settings (removes all layers, etc.).
 :|button_map_measure| Measure: allows the user to draw a line on the map to measure it's length. Single-click to create a node and double-click to finish.
 :|button_map_graticules| Projection Switcher: change the projection of the map to one of the supported projections in the dropdown list.
 :|button_map_zoomin| |button_map_zoomout| Zoom in and out: zoom in or out on the map.
@@ -163,7 +163,7 @@ Other functionality available from the tabs on the main map page is as follows:
 .. |button_view_addtomap| image:: media/button_view_addtomap.png
 .. |button_map_managelayers| image:: media/button_map_managelayers.png
 .. |button_map_exclamationicon| image:: media/button_map_exclamationicon.png
-.. |button_map_cogicon| image:: media/button_map_cogicon.png
+.. |layer_settings_button| image:: media/layer_settings_button.png
 .. |button_map_legendicon| image:: media/button_map_legendicon.png
 .. |button_map_anno| image:: media/button_map_anno.png
 .. |button_map_annoadd| image:: media/button_map_annoadd.png

docs/UserDoc_Chap5_Create.rst

@@ -1,9 +1,9 @@
 Creating Discovery Metadata
 ===========================
 
-This section will guide the user through the process of creating discovery metadata records on `spatialdata.gov.scot <https://spatialdata.gov.scot>`__. Discovery metadata can be added to the 
-portal by `importing an existing metadata <#import-existing-metadata>`__ XML file, `creating a new record from a template <#creating-metadata-from-a-template>`__, 
-`duplicating an existing record <#duplicating-existing-metadata>`__, or `harvesting records <#harvesting-metadata>`__ from other metadata portals. 
+This section will guide the user through the process of creating discovery metadata records on `spatialdata.gov.scot <https://spatialdata.gov.scot>`__. Discovery metadata can be added to the
+portal by `importing an existing metadata <#import-existing-metadata>`__ XML file, `creating a new record from a template <#creating-metadata-from-a-template>`__,
+`duplicating an existing record <#duplicating-existing-metadata>`__, or `harvesting records <#harvesting-metadata>`__ from other metadata portals.
 
 Importing existing metadata
 ---------------------------
@@ -15,37 +15,37 @@ To import an existing XML metadata record:
 	**1|** Click the |button_contribute| button in the header menu and choose |button_contribute_import|. This will take the user to the **Import new records** menu board.
 
 	**2|** Select where to import the record from. Options are from your computer (default), a URL, by copy/paste, or from a server.
-	
+
 	**3|** Select **Metadata** from the type of record dropdown.
-	
+
 	**4|** Indicate how the unique identifier for the record (UUID) should be treated. If you are uploading in order to refine or change an existing record, then choose the **Overwrite metadata with the same UUID** option. If you are uploading to create a new metadata record then choose the **Generate UUID for inserted metadata** option. If the XML contains a UUID that does not already exist on the portal but you would like to keep this UUID then the **None** option should be selected.
 
 	*Note: The UUID is a generated automatically by whatever internal system (i.e. ESRI ArcGIS) was used to write and manage your metadata. In xml, it can be found at the top of the page under the file identifier section. Within the portal, the UUID or File Identifier can be found at the bottom of the metadata record display. This UUID, together with the metadata date stamp, are used to ensure records are unique within* `spatialdata.gov.scot <https://spatialdata.gov.scot>`__, `data.gov.uk <http://data.gov.uk/>`__ *and other metadata catalogues.*
 
 	**5|** Under the **Apply XSLT conversion** menu, select the appropriate translation to convert the metadata to the UK Gemini format.
-	
+
 	*Note: For an xml file that is already in Gemini 2.3 format and recognised as such (see* `Annex 1 <UserDoc_Chap8_Annex1.html#annex-1-requirements-for-metadata-to-be-correctly-identified-as-uk-gemini>`__), *the* **Apply XSLT conversion** *option can be set to 'None'. Select 'GEMINI 2.2 to GEMINI 2.3' to convert an existing Gemini 2.2 record to 2.3, select 'ESRI to GEMINI 2.3 to convert records created using the ESRI ArcGIS platform. Users providing data in MEDIN format should select the MEDIN to GEMINI conversion.*
-	
+
 	**6|** Optionally, select whether to validate the record on import.
-	
+
 	*Note: it is recommended that the validate option be left un-ticked, and users perform a validation of the record after import. If the validation option is ticked and an error is found, the record will fail to import.*
 
 	**7|** Optionally, select whether to publish the record on import.
-	
+
 	**8|** Assign the record to a user group.
-	
+
 	**9|** Assign the record to the appropriate licence type (i.e. OGL, NCGL, INSPIRE or other). This will allow for filtered searching based on the licence conditions.
-	
+
 	*Note: Licence types can also be amended at a later date. See* `assigning a licence category <UserDoc_Chap6_Edit.html#assigning-a-licence-category>`__.
-	
+
 	**10|** Click the |button_contribute_importconfirm| button.
-	
+
 |userdoc_fig_5_1_1_ImportMetadata|
 
 **Figure 5.1.1:** Importing an existing XML metadata record
 
-When the import operation has finished, an **Import Report** will be displayed on the right-hand side of the screen, indicating whether or not the 
-import has been successful. Following a successful import, users should verify that their records are valid. Consult the 
+When the import operation has finished, an **Import Report** will be displayed on the right-hand side of the screen, indicating whether or not the
+import has been successful. Following a successful import, users should verify that their records are valid. Consult the
 `Validating metadata <UserDoc_Chap6_Edit.html#validating-metadata>`__ section for details. Amendments to the record may be required to make it fully Gemini compliant.
 
 Creating metadata from a template
@@ -55,20 +55,20 @@ Basic templates are available for users to create metadata directly on `spatiald
 
 To create a metadata record using an available template:
 
-	**1|** Click the |button_contribute| button in the header menu. 
-	
+	**1|** Click the |button_contribute| button in the header menu.
+
 	**2|** Click the |button_editor_board| button. This will enable the **Editor** board, where all records the user has access to will be listed.
-	
+
 	**3|** Click the |button_contribute_addrecord| button.
-	
+
 	**4|** Choose the type of record to be created based on the type of resource that is being documented, i.e. a dataset, series or service record. When selected available templates for that type are displayed.
-	
+
 	*Note: templates for dataset and service metadata are slightly different. Metadata for a service has extra elements for the spatial data service type (i.e. view, download, etc.) and for coupled resources. You must choose the correct template for the type of record being documented as it is not possible to change once the record has been created.*
-	
+
 	**5|** Click on the template to be used.
 
 	**6|** Click the |button_contribute_create| button to create the new record. This will automatically take the user to the editing view where elements of the new record can be modified. See `Editing a metadata record <UserDoc_Chap6_Edit.html#editing-metadata>`__ for guidance on documenting the resource.
-	
+
 	*Note: if the user is an editor for multiple groups or an administrator to the site, they may be presented with multiple templates of the same name. Additionally, they will be required to select which group to assign the metadata record to.*
 
 |userdoc_fig_5_2_1_CreateTemplate|
@@ -83,12 +83,12 @@ of the metadata elements are the same for all records (e.g. points of contact, e
 
 To create a metadata record by duplicating an existing record:
 
-	**1|** Click the |button_contribute| button in the header menu. 
-	
+	**1|** Click the |button_contribute| button in the header menu.
+
 	**2|** Click the |button_editor_board| button. This will enable the **Editor** board, where all records the user has access to will be listed.
 
 	**3|** Click the duplicate icon (|button_contribute_duplicate|) next to the record name.
-	
+
 	**4|** Click the |button_contribute_create| button to create the new record. This will automatically take the user to the **Editor** board where elements of the new record can be modified. See `Editing a metadata record <UserDoc_Chap6_Edit.html#editing-metadata>`__ for guidance on documenting the resource.
 
 	*Note: if the user is an editor for multiple groups or an administrator to the site, they will be required to select which group to assign the duplicate metadata record to.*
@@ -107,22 +107,34 @@ Creating directory metadata
 
 Directory records are a means of automatically populating fields such as those for the `point of contact <UserDoc_Chap7_Elements.html#point-of-contact>`__ section of a metadata record with pre-written values. This is useful if you have to create multiple records that share the same point of contact.
 
-To create a directory entry:
+To create a contact directory entry:
 
 	**1|** Click the |button_contribute| button in the header menu.
 
 	**2|** Click the |button_contribute_managedirectory| from the contribute drop down. This will bring the user to the manage directories page.
 
-	**3|** On the entries tab are previously created directory entries. Under the **Actions** drop menu of each record, users can choose to edit or duplicate an existing record. Alternately, users can create a blank directory entry using a template by first clicking on the **Templates** tab, and then choosing duplicate from the **Actions** menu of the 'TEMPLATE TO DUPLICATE' entry.
-	
+	**3|** On the entries tab of the relevant section (e.g. **Organisations & contacts**) there are previously created directory entries. Under the **Actions** drop menu of each record, users can choose to edit or duplicate an existing record.
+
 	**4|** Amend the entry as appropriate and click |button_contribute_savedirectory| to save changes.
-
+
+	**5|** Click |button_contribute_saveclosedirectory| to save and exit.
+
+	Alternatively, users can create a blank directory entry using an existing template:
+
+	**1|** Click on the **Templates** tab for the relevant section (e.g. **Organisations & contacts**)
+
+	**2|** Choose **Duplicate** from the **Actions** menu of the 'TEMPLATE TO DUPLICATE' entry. This will generate a second 'TEMPLATE TO DUPLICATE' template entry.
+
+	**3|** Choose **Edit** from the **Actions** menu of either of the 'TEMPLATE TO DUPLICATE' entries.
+
+	**4|** Amend the entry as appropriate and click **on the arrow** next to |button_contribute_savedirectory| and choose **Save as directory entry**. This will turn the modified template into a directory entry that can be used to populate metadata records.
+
 	**5|** Click |button_contribute_saveclosedirectory| to save and exit.
 
 	*Note: The individual name field is not mandatory for the UK Gemini standard, however, for directories it can be used to identify teams/business areas if you have a number of different contact details within an organisation (e.g. GIS, Planning, etc.)*
 
 |userdoc_fig_5_5_1_DirectoryEntry|
- 
+
 **Figure 5.5.1:** Creating a directory entry
 
 .. |userdoc_fig_5_1_1_ImportMetadata| image:: media/userdoc_fig_5_1_1_ImportMetadata.png