Merge pull request #26 from IronRico/master

Rolling Doc Changes July 2020

Author: hmaier-fws

SUMMARY.md

@@ -69,8 +69,10 @@
         * [Distribution Edit Window](reference/edit-window/metadata/distribution-panels/distribution-editWindow.md)
         * [Distributor Edit Window](reference/edit-window/metadata/distribution-panels/distributor-editWindow.md)
           * [Transfer Option](reference/edit-window/metadata/distribution-panels/transferOption.md)
+            * [Online Transfer Option](reference/edit-window/metadata/distribution-panels/ onlineTransferOption.md)
             * [Offline Transfer Option](reference/edit-window/metadata/distribution-panels/offlineOption.md)
             * [Distribution Format](reference/edit-window/metadata/distribution-panels/format.md)
+            * [Transfer Frequency](reference/edit-window/metadata/distribution-panels/timeDuration-obj.md)
           * [Order Process](reference/edit-window/metadata/distribution-panels/orderProcess.md)
       * [Constraints Section](reference/edit-window/metadata/constraint-panels/constraint-section.md)
         * [Use Limitations](reference/edit-window/metadata/constraint-panels/useLimitation-panel.md)

assets/reference/edit-objects/dictionary/attribute/AtrributeNameAnnotations.png

@@ -11,11 +11,11 @@ As discussed in the [Attribute Array section](../entity-panels/attribute-panel.m
 
 In the example below, an <span class="md-panel">Entity</span> has been defined for vehicle registration records within a fictitious Department of Motor Vehicles database.  Several of the VEHICLE_REGISTRATION <span class="md-panel">Entity</span>'s <span class="md-panel">Attributes</span> are shown in the <span class="md-panel">Attribute</span> array panel along with their required elements.  
 
-![Entity Attribute Array](/assets/reference/edit-objects/dictionary/attribute/attribute-array.png){caption}
+![Entity Attribute Array](/assets/reference/edit-objects/dictionary/attribute/AtrributeNameAnnotations.png){Pictured Above: Attribute Array Detail}
 
 Each <span class="md-panel">Attribute</span> has a <strong class="btn btn-success btn-xs"> <i class="fa fa-pencil"> </i> More...</strong> button that when clicked navigates to the <span class="md-panel">Attribute</span>'s <span class="md-window">Edit Window</span> providing access to *all* the <span class="md-panel">Attribute</span>'s elements, optional and required. This <span class="md-panel">Attribute</span> <span class="md-window">Edit Window</span> is shown in the illustration below.  Each of the <span class="md-window">Edit Window</span>'s panels are discussed separately on the following pages.
 
-![Attribute Edit Window](/assets/reference/edit-objects/dictionary/attribute/attribute-panel.png){caption}
+![Attribute Edit Window](/assets/reference/edit-objects/dictionary/attribute/attribute-panel.png){Pictured Above: Attribute Overview}
 
 ---
 

assets/reference/edit-objects/metadata/distribution/OnlineTransferOption.PNG

@@ -0,0 +1,23 @@
+### Online Transfer Option 
+
+![Online Transfer Option Edit Window](/assets/reference/edit-objects/metadata/distribution/OnlineTransferOption.PNG)
+
+---
+
+- **Name:** *{**type**: string; **max length**: none; **default**: empty}
+  Usage:* The name of the online resource.
+
+- **URI:** *{**type**: [URI](https://guide.mdeditor.org/GLOSSARY.html#uri); **default**: empty}
+  Usage: * The internet location (address) for online access to the resource using the [URI](https://guide.mdeditor.org/GLOSSARY.html#uri) format - a.k.a URL.
+
+- **Protocol:**  *{**type**: string; **max length**: none; **default**: empty}
+  Usage:* The online connection protocol used to access the resource. e.g. ftp, http, https, etc.
+
+- **Description:** *{**type**: string; **max length**: 500 characters; **default**: empty}
+  Usage:* A text description with additional details of what the resource is or describes.
+
+- **Function:** *{**type**: codelist (ISO CI_OnLineFunctionCode, [ADIwg](https://guide.mdeditor.org/GLOSSARY.html#adiwg) codes); **extensible**: YES; **multi-value**: NO; **default**: empty} Usage:* - A code declaring the intended function of the resource.
+
+- **Application Profile:** The name of an application profile that can be used with the online resource
+
+- **Protocol Request:** The request used to access the resource depending on the protocol (to be used mainly for POST requests)

assets/reference/import/ClearBrowserCacheCallout.png

@@ -0,0 +1,17 @@
+### Transfer Frequency
+
+  * <span class="md-element">Year</span> 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of years in the duration.
+  
+  * <span class="md-element">Month</span> 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of months in the duration.
+  
+  * <span class="md-element">Day</span> 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of days in the duration.
+  
+  * <span class="md-element">Hour</span> 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of hours in the duration.
+  
+  * <span class="md-element">Minute</span> 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of minutes in the duration.
+  
+  * <span class="md-element">Second</span> 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of seconds in the duration.
+  
+  {% hint style='info' %}
+  At least one duration element is required.  More than one may also be entered.  e.g. 18 Months or 1 year, 6 months are equivalent durations.
+  {% endhint %}

assets/reference/import/clear-cache2.JPG

@@ -8,20 +8,12 @@
 
 * <span class="md-element">Distribution Units</span> 1{**type**: string; **max length**: none; **default**: empty}1  The tiles, layers, geographic areas, etc., in which data are available. 
 
-* <span class="md-panel">Online Option</span>  1{**type**: array (obj: <span class="md-panel">Online Resource</span>)}1  Each <span class="md-panel">Online Option</span> contains information about an online source for the distribution.  2{[See object details](#online-resource)}2
+* [<span class="md-panel" style="font-size: larger">Online Option</span>](onlineTransferOption.md) 1{**type**: array (obj: <span class="md-panel">Online Option</span>)}1  Each <span class="md-panel">Online Option</span> object contains information about an online source for the distribution.
 
-* [<span class="md-panel" style="font-size: larger">Offline Option</span>](offlineOption.md)  1{**type**: array (obj: <span class="md-panel">Offline Option</span>)}1  Each <span class="md-panel">Offline Option</span> object contains information about an option for offline medium on which the distribution and be obtained.
+* [<span class="md-panel" style="font-size: larger">Offline Option</span>](offlineOption.md) 1{**type**: array (obj: <span class="md-panel">Offline Option</span>)}1  Each <span class="md-panel">Offline Option</span> object contains information about an option for offline medium on which the distribution and be obtained.
 
 * [<span class="md-panel" style="font-size: larger">Distribution Formats <span>](format.md)  1{**type**: array (obj: <span class="md-panel">Distribution Format</span>)}1  Provides information about the format(s) used by the distributor.
 
-* <span class="md-panel">Transfer Frequency</span> 1{**type**: object (<span class="md-panel">Time Duration</span>); **default** empty}1  The rate of occurrence of distribution.  2{[See object details](#time-duration-object)}2
-
----
-
-### Online Resource 
-
-{% include "../../../include-objects/onlineResource-obj.md" %}
-
+* [<span class="md-panel" style="font-size: larger">Transfer Frequency</span>](timeDuration-obj.md)  1{**type**: array (obj: <span class="md-panel"> Transfer Frequency </span>)}1  <span class="md-panel"> Transfer Frequency </span> {type: object (Time Duration); default empty}
+Usage: The rate of occurrence of distribution.
 ---
-
-{% include "../../../include-objects/timeDuration-obj.md" %}

assets/reference/settings/GeneralSettingsScreenshot.JPG

@@ -14,6 +14,13 @@ __Drag & Drop__  The map supports dragging a file from your file explorer and dr
 
 ---
 
+{% hint style='info' %}
+**Please Note:**  Imported data needs to utilize the World Geodetic System 1984 (WGS 84) [WGS84] coordinate reference system.  Longitude and latitude should be in units of decimal degrees. For more details on WGS84, please visit <a href="https://epsg.io/4326" target="_blank">the espg.io database website <sup class="fa fa-external-link"></sup></a>.
+{% endhint %}
+
+
+
+
 * __CSV__ (Comma or Tab delimited) text file
 
   The import process searches column heading names for clues to locating geographic and other information.  

assets/tutorial/fast-scrolling-noHighlightSideBar.png

@@ -1,16 +1,21 @@
 # Reference -- Import Records 
+
 ### Clearing Browser Cache
---- 
 
-When importing metadata records to mdEditor there are times when completely clearing the browser cache can be helpful.  If your import is replacing items of each type (<span class="md-panel">Metadata Record</span>, <span class="md-panel">Contact</span>, and <span class="md-panel">Dictionary</span>) mdEditor will effectively be clearing browser cache for you.  In other instances you may need to do this yourself.  
+---
+
+When importing metadata records to mdEditor there are times when completely clearing the editor storage cache can be helpful. If your import is replacing items of each type (<span class="md-panel">Metadata Record</span>, <span class="md-panel">Contact</span>, and <span class="md-panel">Dictionary</span>) mdEditor will effectively be clearing browser cache for you. In other instances, you may need to do this yourself. 
+
+To do this, go to the Settings page pictured below.
+
+---
+
+![Settings Window](/assets/reference/import/ClearBrowserCacheCallout.png)
+
+####<span class="btn btn-danger btn-xs"> <i class="fa fa-times"> </i> Clear Storage Cache</span> Clear Browser Cache
 
-{% hint style='danger' %}
-  **Warning:** Clearing all records will delete all of the records currently loaded in mdEditor. Before doing so, use the Export function to make a backup of your records. Otherwise, the records will be permanently lost (unless you previously made a backup copy).
-{% endhint %}
+  **Clear Storage Cache:** To clear browser cache open the <span class="md-window">Settings</span> window and in the <span class="md-panel">General Settings</span> panel click the <span class="btn btn-danger btn-xs"> <i class="fa fa-times"> </i> Clear Storage Cache</span> button, then confirm.
 
-![Settings Window](/assets/reference/import/clear-cache.png)
+{% hint style='warning' %} Note than when you clear the browser cache mdEditor (Settings General Settings), the option to keep your local settings is available. The option to “Keep Settings” is checked by default. This ensures that you will not lose your local settings unless you uncheck the box prior to using the Clear Storage Cache button. {% endhint %}
 
- * ####<span class="btn btn-danger btn-xs"> <i class="fa fa-times"> </i> Clear Storage Cache</span> Clear Browser Cache
- 
- To clear browser cache open the <span class="md-window">Settings</span> window and in the <span class="md-panel">General Settings</span> panel click the <span class="btn btn-danger btn-xs"> <i class="fa fa-times"> </i> Clear Storage Cache</span> button, then confirm. 
- 
+{% hint style='danger' %} Warning: Clearing all records will delete all of the records currently loaded in mdEditor. Before doing so, use the Export function to make a backup of your records. Otherwise, the records will be permanently lost (unless you previously made a backup copy). {% endhint %}

assets/tutorial/secondary_sidebar_NoHighlights.png

@@ -0,0 +1,23 @@
+### Online Transfer Option 
+
+![Online Transfer Option Edit Window](/assets/reference/edit-objects/metadata/distribution/OnlineTransferOption.PNG)
+
+---
+
+- **Name:** *{**type**: string; **max length**: none; **default**: empty}
+  Usage:* The name of the online resource.
+
+- **URI:** *{**type**: [URI](https://guide.mdeditor.org/GLOSSARY.html#uri); **default**: empty}
+  Usage: * The internet location (address) for online access to the resource using the [URI](https://guide.mdeditor.org/GLOSSARY.html#uri) format - a.k.a URL.
+
+- **Protocol:**  *{**type**: string; **max length**: none; **default**: empty}
+  Usage:* The online connection protocol used to access the resource. e.g. ftp, http, https, etc.
+
+- **Description:** *{**type**: string; **max length**: 500 characters; **default**: empty}
+  Usage:* A text description with additional details of what the resource is or describes.
+
+- **Function:** *{**type**: codelist (ISO CI_OnLineFunctionCode, [ADIwg](https://guide.mdeditor.org/GLOSSARY.html#adiwg) codes); **extensible**: YES; **multi-value**: NO; **default**: empty} Usage:* - A code declaring the intended function of the resource.
+
+- **Application Profile:** The name of an application profile that can be used with the online resource
+
+- **Protocol Request:** The request used to access the resource depending on the protocol (to be used mainly for POST requests)

reference/edit-window/dictionary/attribute-panels/attribute-section.md

@@ -1,4 +1,4 @@
-### Time Duration Object
+### Transfer Frequency
 
   * <span class="md-element">Year</span> 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of years in the duration.
 

reference/edit-window/metadata/distribution-panels/onlineTransferOption.md

@@ -1,21 +1,33 @@
 # Settings
-### General Settings
+
 ---
 
-![General Settings Panel](/assets/reference/settings/settings-general.png){caption}
+![General Settings Image](/assets/reference/settings/GeneralSettingsScreenshot.JPG){caption}
+
+
+
+
+ - **Auto Save** ![Auto Save Switch](/assets/bullets/switch-right.png):  
+ With Auto Save: ON, all edits in mdEditor are automatically saved.  With Auto Save: OFF you will need to do manual saves of your <span class="md-panel">Metadata Records</span>, <span class="md-panel">Contacts</span>, and <span class="md-panel">Dictionaries</span>. 
+ 
+- **Copy in Edit Mode**:  
+When turned on, this allows the "Copy" option to appear in the right-hand side of an edit window. 
+This is disabled by default to avoid potential accidental usage.  
+
+- **Delete in Edit Mode**:  
+When turned on, this allows the "Delete" option to appear in the right-hand side of an edit window. 
+This is disabled by default to avoid potential accidental usage.
+
+- **Clear All Records**:  
+Clicking on the <span class="btn btn-danger btn-sm">Clear Storage Cache</span> Clear Browser Cache option, (also known as the "browser cache"), will delete all metadata records, contacts, and dictionaries from mdEditor's local cache.  This action does not remove items from your personal computers local storage.  
 
+     You may export any data you wish to save from mdEditor before clearing the cache.  
+     
+     If you want to save the local settings, ensure the "Keep Settings" option is checked.
 
-* ### ![Auto Save Switch](/assets/bullets/switch-right.png) Auto Save
+     To clear the browser cache click the <span class="btn btn-danger btn-xs"> <i class="fa fa-times"> </i> Clear Storage Cache</span> button, then confirm. 
 
-  With Auto Save: ON, all edits in mdEditor are automatically saved.  With Auto Save: OFF you will need to do manual saves of your <span class="md-panel">Metadata Records</span>, <span class="md-panel">Contacts</span>, and <span class="md-panel">Dictionaries</span>. 
-  
-* ### <span class="btn btn-danger btn-sm">Clear Storage Cache</span> Clear Browser Cache
+{% hint style='danger' %}
+Be sure loaded <span class="md-panel">Metadata Records</span>, <span class="md-panel">Contacts</span>, and <span class="md-panel">Dictionaries</span> have been exported to local storage before clearing cache if you wish to have access to them later.
+{% endhint %}
 
-  Clearing browser cache (aka "Storage Cache") will delete all <span class="md-panel">Metadata Records</span>, <span class="md-panel">Contacts</span>, and <span class="md-panel">Dictionaries</span> from mdEditor's browser cache.  These are the records you can see in mdEditor's <span class="md-window">Primary Sidebar</span>. The action will not remove any items from your computer's local storage.
-  
-  To clear browser cache click the <span class="btn btn-danger btn-xs"> <i class="fa fa-times"> </i> Clear Storage Cache</span> button, then confirm. 
-  
-  {% hint style='danger' %}
-  Be sure loaded <span class="md-panel">Metadata Records</span>, <span class="md-panel">Contacts</span>, and <span class="md-panel">Dictionaries</span> have been exported to local storage before clearing cache if you wish to have access to them later.
-  {% endhint %}
-