diff --git a/SUMMARY.md b/SUMMARY.md index 599bfe1e..31748a80 100644 --- a/SUMMARY.md +++ b/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) diff --git a/assets/reference/edit-objects/dictionary/attribute/AtrributeNameAnnotations.png b/assets/reference/edit-objects/dictionary/attribute/AtrributeNameAnnotations.png new file mode 100644 index 00000000..fad32344 Binary files /dev/null and b/assets/reference/edit-objects/dictionary/attribute/AtrributeNameAnnotations.png differ diff --git a/assets/reference/edit-objects/metadata/distribution/OnlineTransferOption.PNG b/assets/reference/edit-objects/metadata/distribution/OnlineTransferOption.PNG new file mode 100644 index 00000000..8b6f45e6 Binary files /dev/null and b/assets/reference/edit-objects/metadata/distribution/OnlineTransferOption.PNG differ diff --git a/assets/reference/import/ClearBrowserCacheCallout.png b/assets/reference/import/ClearBrowserCacheCallout.png new file mode 100644 index 00000000..00e5f07a Binary files /dev/null and b/assets/reference/import/ClearBrowserCacheCallout.png differ diff --git a/assets/reference/import/clear-cache2.JPG b/assets/reference/import/clear-cache2.JPG new file mode 100644 index 00000000..56941e57 Binary files /dev/null and b/assets/reference/import/clear-cache2.JPG differ diff --git a/assets/reference/settings/GeneralSettingsScreenshot.JPG b/assets/reference/settings/GeneralSettingsScreenshot.JPG new file mode 100644 index 00000000..f8f6f440 Binary files /dev/null and b/assets/reference/settings/GeneralSettingsScreenshot.JPG differ diff --git a/assets/tutorial/fast-scrolling-noHighlightSideBar.png b/assets/tutorial/fast-scrolling-noHighlightSideBar.png new file mode 100644 index 00000000..fd4ff82b Binary files /dev/null and b/assets/tutorial/fast-scrolling-noHighlightSideBar.png differ diff --git a/assets/tutorial/secondary_sidebar_NoHighlights.png b/assets/tutorial/secondary_sidebar_NoHighlights.png new file mode 100644 index 00000000..3e46683a Binary files /dev/null and b/assets/tutorial/secondary_sidebar_NoHighlights.png differ diff --git a/reference/edit-window/dictionary/attribute-panels/attribute-section.md b/reference/edit-window/dictionary/attribute-panels/attribute-section.md index db16e45f..e7673670 100644 --- a/reference/edit-window/dictionary/attribute-panels/attribute-section.md +++ b/reference/edit-window/dictionary/attribute-panels/attribute-section.md @@ -11,11 +11,11 @@ As discussed in the [Attribute Array section](../entity-panels/attribute-panel.m In the example below, an Entity has been defined for vehicle registration records within a fictitious Department of Motor Vehicles database. Several of the VEHICLE_REGISTRATION Entity's Attributes are shown in the Attribute 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 Attribute has a More... button that when clicked navigates to the Attribute's Edit Window providing access to *all* the Attribute's elements, optional and required. This Attribute Edit Window is shown in the illustration below. Each of the Edit Window'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} --- diff --git a/reference/edit-window/metadata/distribution-panels/onlineTransferOption.md b/reference/edit-window/metadata/distribution-panels/onlineTransferOption.md new file mode 100644 index 00000000..250687cc --- /dev/null +++ b/reference/edit-window/metadata/distribution-panels/onlineTransferOption.md @@ -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) diff --git a/reference/edit-window/metadata/distribution-panels/timeDuration-obj.md b/reference/edit-window/metadata/distribution-panels/timeDuration-obj.md new file mode 100644 index 00000000..6396e309 --- /dev/null +++ b/reference/edit-window/metadata/distribution-panels/timeDuration-obj.md @@ -0,0 +1,17 @@ +### Transfer Frequency + + * Year 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of years in the duration. + + * Month 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of months in the duration. + + * Day 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of days in the duration. + + * Hour 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of hours in the duration. + + * Minute 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of minutes in the duration. + + * Second 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 %} diff --git a/reference/edit-window/metadata/distribution-panels/transferOption.md b/reference/edit-window/metadata/distribution-panels/transferOption.md index a5711149..d9b462ab 100644 --- a/reference/edit-window/metadata/distribution-panels/transferOption.md +++ b/reference/edit-window/metadata/distribution-panels/transferOption.md @@ -8,20 +8,12 @@ * Distribution Units 1{**type**: string; **max length**: none; **default**: empty}1 The tiles, layers, geographic areas, etc., in which data are available. -* Online Option 1{**type**: array (obj: Online Resource)}1 Each Online Option contains information about an online source for the distribution. 2{[See object details](#online-resource)}2 +* [Online Option](onlineTransferOption.md) 1{**type**: array (obj: Online Option)}1 Each Online Option object contains information about an online source for the distribution. -* [Offline Option](offlineOption.md) 1{**type**: array (obj: Offline Option)}1 Each Offline Option object contains information about an option for offline medium on which the distribution and be obtained. +* [Offline Option](offlineOption.md) 1{**type**: array (obj: Offline Option)}1 Each Offline Option object contains information about an option for offline medium on which the distribution and be obtained. * [Distribution Formats ](format.md) 1{**type**: array (obj: Distribution Format)}1 Provides information about the format(s) used by the distributor. -* Transfer Frequency 1{**type**: object (Time Duration); **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" %} - +* [Transfer Frequency](timeDuration-obj.md) 1{**type**: array (obj: Transfer Frequency )}1 Transfer Frequency {type: object (Time Duration); default empty} +Usage: The rate of occurrence of distribution. --- - -{% include "../../../include-objects/timeDuration-obj.md" %} diff --git a/reference/edit-window/metadata/extent-panels/features-import.md b/reference/edit-window/metadata/extent-panels/features-import.md index 28d0cb3b..1aae7fe4 100644 --- a/reference/edit-window/metadata/extent-panels/features-import.md +++ b/reference/edit-window/metadata/extent-panels/features-import.md @@ -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 the espg.io database website . +{% endhint %} + + + + * __CSV__ (Comma or Tab delimited) text file The import process searches column heading names for clues to locating geographic and other information. diff --git a/reference/import-window/clear-cache.md b/reference/import-window/clear-cache.md index 9ddf4fe5..e513daae 100644 --- a/reference/import-window/clear-cache.md +++ b/reference/import-window/clear-cache.md @@ -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 (Metadata Record, Contact, and Dictionary) 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 (Metadata Record, Contact, and Dictionary) 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) + +#### Clear Storage Cache 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 Settings window and in the General Settings panel click the Clear Storage Cache 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 %} - * #### Clear Storage Cache Clear Browser Cache - - To clear browser cache open the Settings window and in the General Settings panel click the Clear Storage Cache button, then confirm. - \ No newline at end of file +{% 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 %} diff --git a/reference/import-window/clear-cache2.png.JPG b/reference/import-window/clear-cache2.png.JPG new file mode 100644 index 00000000..56941e57 Binary files /dev/null and b/reference/import-window/clear-cache2.png.JPG differ diff --git a/reference/include-objects/onlineTransferOption.md b/reference/include-objects/onlineTransferOption.md new file mode 100644 index 00000000..250687cc --- /dev/null +++ b/reference/include-objects/onlineTransferOption.md @@ -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) diff --git a/reference/include-objects/timeDuration-obj.md b/reference/include-objects/timeDuration-obj.md index 70904f4f..6396e309 100644 --- a/reference/include-objects/timeDuration-obj.md +++ b/reference/include-objects/timeDuration-obj.md @@ -1,4 +1,4 @@ -### Time Duration Object +### Transfer Frequency * Year 1{**type**: integer; **min**: 0; **max** none; **default**: empty}1 A value for the number of years in the duration. diff --git a/reference/settings-window/settings-general.md b/reference/settings-window/settings-general.md index 67aa570f..275764bd 100644 --- a/reference/settings-window/settings-general.md +++ b/reference/settings-window/settings-general.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 Metadata Records, Contacts, and Dictionaries. + +- **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 Clear Storage Cache 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 Clear Storage Cache 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 Metadata Records, Contacts, and Dictionaries. - -* ### Clear Storage Cache Clear Browser Cache +{% hint style='danger' %} +Be sure loaded Metadata Records, Contacts, and Dictionaries 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 Metadata Records, Contacts, and Dictionaries from mdEditor's browser cache. These are the records you can see in mdEditor's Primary Sidebar. The action will not remove any items from your computer's local storage. - - To clear browser cache click the Clear Storage Cache button, then confirm. - - {% hint style='danger' %} - Be sure loaded Metadata Records, Contacts, and Dictionaries have been exported to local storage before clearing cache if you wish to have access to them later. - {% endhint %} - \ No newline at end of file diff --git a/tutorial/editor-window-parts/secondary-sidebar/fast-scrolling.md b/tutorial/editor-window-parts/secondary-sidebar/fast-scrolling.md index 21a10323..648fda6a 100644 --- a/tutorial/editor-window-parts/secondary-sidebar/fast-scrolling.md +++ b/tutorial/editor-window-parts/secondary-sidebar/fast-scrolling.md @@ -1,23 +1,21 @@ # Tutorial -- Fast Scrolling ---- + +--- Some Edit Window sections are too long to fit on a standard monitor and require some scrolling to see all the elements of the page. The Edit Window can get even longer as you continue to add your metadata. This can make it inconvenient to locate just the information you're looking for by visually searching the record. -To assist with quickly displaying the portion of the page you need, the Fast Scrolling feature was added to the Secondary Sidebar. This facility provides links to quickly scroll the panel you need to the top of the Edit Window. In addition, the window's current scroll position is highlighted in the Secondary Sidebar. +To assist with quickly displaying the portion of the page you need, the Fast Scrolling feature on the Secondary Sidebar provides links to quickly scroll the panel you need to the top of the Edit Window. + + +![Secondary Sidebar: Fast Scrolling Buttons](/assets/tutorial/fast-scrolling-noHighlightSideBar.png){caption} -![Secondary Sidebar Fast Scrolling Facility](/assets/tutorial/fast-scrolling.png){caption} -The Fast Scrolling buttons are named for the panels in the Edit Window section. Clicking on a Fast Scrolling button will scroll the selected panel to the top of the window, saving you the search. Scrolling the window manually also highlights the Fast Scrolling button for the Edit Window's top-most panel, providing visual confirmation of the window's scroll position. +The Fast Scrolling buttons are named for the panels in the Edit Window section. Clicking on a Fast Scrolling button will scroll the selected panel to the top of the window, saving you the search. {% hint style='info' %} - Browser scrolling behavior presents a full page whenever possible. Therefore, when a Fast Scrolling button near the bottom of the list is clicked (e.g. 'Graphic Overview' in the above image), that panel will scroll as close to the top of the page as possible while still presenting a full page on your monitor. The Fast Scrolling button for the top-most panel will be highlighted, which may not be the one you clicked. This behavior may vary by browser. +Browser scrolling behavior presents a full page whenever possible. Therefore, when a Fast Scrolling button near the bottom of the list is clicked (e.g. 'Graphic Overview' in the above image), that panel will scroll as close to the top of the page as possible while still presenting a full page on your monitor. The feature is made to work with the user’s native screen size. Note, that on some smaller screens the sidebar may place itself in a fixed position to accommodate the display area. {% endhint %} -{% hint style='working' %} - * Scroll the window and watch the highlighting of the Fast Scrolling buttons change. Observe the pairing of the highlighted Fast Scrolling button and the Edit Window's top panel. - * Click on a few of the Fast Scrolling buttons and observe page scrolling. -{% endhint %} - {% hint style='info' %} - Each Edit Window section will have a unique Fast Scrolling section that matches up with the panels for that Edit Window section. However, some Edit Window sections have only a few or even no panels, so not all Edit Window sections will have a Fast Scrolling feature in the Secondary Sidebar. +Each Edit Window section will have a unique Fast Scrolling section that matches up with the panels for that Edit Window section. However, some Edit Window sections have only a few or even no panels, so not all Edit Window sections will have a Fast Scrolling feature in the Secondary Sidebar. {% endhint %}