Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rolling Doc Changes July 2020 #26

Merged
merged 46 commits into from
Dec 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
12f7ba7
Added WGS 84 requirements to Extent Import Feature
IronRico Jun 12, 2020
158075e
Removed reference to 'Highlights"
IronRico Jun 15, 2020
9692eb0
New sidebar shot with no highlights
IronRico Jun 15, 2020
9b4b4d5
Update fast-scrolling.md
IronRico Jun 15, 2020
1392d17
Update fast-scrolling.md
IronRico Jun 15, 2020
ab3440e
New Fast Scrolling ScreenShot
IronRico Jun 15, 2020
61ed0a8
Deleted image as it was in the wrong area
IronRico Jun 15, 2020
ed21282
New Screenshot for FastScrolling
IronRico Jun 16, 2020
6d0924c
Updated Fast Scrolling
IronRico Jun 16, 2020
cca2dfd
Update fast-scrolling.md
IronRico Jun 16, 2020
61f43c4
Added Online Transfer Screenshot
IronRico Jun 20, 2020
928965a
Delete Online Transfer Option.PNG
IronRico Jun 20, 2020
519103c
New Online Transfer Option Screenshot
IronRico Jun 20, 2020
447a6a4
Online Transfer Option markdown file
IronRico Jun 20, 2020
6edfb35
Added "Online Transfer" option page
IronRico Jun 20, 2020
e915c9a
Update reference/edit-window/metadata/extent-panels/features-import.md
IronRico Jul 12, 2020
ffc6426
Update tutorial/editor-window-parts/secondary-sidebar/fast-scrolling.md
IronRico Jul 12, 2020
b18e19f
Update onlineOption.md
IronRico Jul 12, 2020
6322f85
Update onlineOption.md
IronRico Jul 13, 2020
6593de2
Update onlineOption.md
IronRico Jul 13, 2020
b1c5848
Create onlineTransferOption.md
IronRico Jul 13, 2020
58f0b88
Update transferOption.md
IronRico Jul 13, 2020
a21051e
Update timeDuration-obj.md
IronRico Jul 13, 2020
83ad2b2
Update SUMMARY.md
IronRico Jul 13, 2020
10eef11
Update onlineTransferOption.md
IronRico Jul 13, 2020
94abe3e
Update transferOption.md
IronRico Jul 14, 2020
348ee48
Create onlineTransferOption.md
IronRico Jul 14, 2020
9761a84
Create timeDuration-obj.md
IronRico Jul 14, 2020
86650af
Added General Settings Image
IronRico Jul 19, 2020
3ed6068
Update settings-general.md
IronRico Jul 19, 2020
8cf1ac8
Update settings-general.md
IronRico Jul 19, 2020
d783715
Update settings-general.md
IronRico Jul 19, 2020
f2f3c42
Update settings-general.md
IronRico Jul 19, 2020
0901f91
Update settings-general.md
IronRico Jul 19, 2020
1db7a92
Updated Attribute Array Image
IronRico Jul 28, 2020
dfd12b2
Update attribute-section.md
IronRico Jul 28, 2020
ac81eac
Update attribute-section.md
IronRico Jul 28, 2020
e643b6d
Delete onlineOption.md
IronRico Aug 4, 2020
d799e07
Update SUMMARY.md
IronRico Aug 4, 2020
4575174
https://github.com/IronRico/mdEditor-doc
IronRico Aug 9, 2020
1c8c58f
New Clear Cache Image
IronRico Aug 9, 2020
e8b970f
Update clear-cache.md
IronRico Aug 9, 2020
2f2dd4d
New ClearBrowserCache Screenshot
IronRico Aug 18, 2020
aa9ff78
Update clear-cache.md
IronRico Aug 18, 2020
fe99bdf
Update tutorial/editor-window-parts/secondary-sidebar/fast-scrolling.md
IronRico Sep 9, 2020
04d5419
Update reference/import-window/clear-cache.md
IronRico Sep 9, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/reference/import/clear-cache2.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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}

---

Expand Down
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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 %}
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
25 changes: 15 additions & 10 deletions reference/import-window/clear-cache.md
Original file line number Diff line number Diff line change
@@ -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 %}
Binary file added reference/import-window/clear-cache2.png.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions reference/include-objects/onlineTransferOption.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion reference/include-objects/timeDuration-obj.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
40 changes: 26 additions & 14 deletions reference/settings-window/settings-general.md
Original file line number Diff line number Diff line change
@@ -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 %}

Loading