Git Product home page Git Product logo

mdeditor-doc's Introduction

mdEditor User Manual

Edition 2019-07-26

Metadata Editor (mdEditor)

mdEditor (metadata Editor) is an application that assists users in authoring and editing metadata for research projects, datasets, maps, images, and other documents. The main goal of mdEditor is to hide much of the technical complexity involved in creating archival quality metadata records that follow the standards published by ISO (International Standards Organization) and FGDC (Federal Geographic Data Committee).

With mdEditor you can publish metadata in any or all of the supported standards without specific knowledge of the standard. mdEditor edits and saves all your metadata on your personal computer so there are no user IDs, passwords, logins, or fees. And your information is always private and secure. All you need to begin authoring and publishing metadata is an internet connection to load the most current version of mdEditor into your favorite internet browser.

mdEditor works hard to conceal the complexity of computer software and metadata standards to allow metadata authors to focus on their metadata content. Even with the assistance of mdEditor, writing archival quality metadata is a challenging task that requires metadata authors to know their projects and datasets thoroughly and take the time necessary to describe them adequately. We hope you find that mdEditor eases that task considerably. And once your content is entered, mdEditor can generate metadata in the standard of your choice with a single button click. Have fun!


Who should read this manual

The "mdEditor User Manual" is intended to be a companion to scientists, researchers, and their assistants as they develop metadata with the assistance of mdEditor. This manual will discuss HOW to use mdEditor. Topics generally cover things such as workflow and how to perform certain tasks within mdEditor.

mdEditor is just one tool in the larger ADIwg Metadata Toolkit. Information on local implementations, customization, and extensions will not be covered in this manual. For information on other tools in the ADIwg Metadata Toolkit please refer to mdBook.

mdeditor-doc's People

Contributors

dependabot[bot] avatar dvonanderson avatar gitbook-bot avatar hmaier-fws avatar ironrico avatar jbadash avatar jlblcc avatar pshealy avatar rhessmiller avatar sagegrey avatar stansmith907 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mdeditor-doc's Issues

Update - "Keep settings when clearing browser cache"

Josh noted that this needs to be updated into the guide as it is not mentioned as of now.

How to update this?
We will need to update the screenshot and include wording for the “Keep Settings” option as well.

Below is an updated screenshot showing the current iteration.

image

Below is a rough take of the wording for the "Keep Settings" option.

"Note than when you clear the browser cache through the built-in settings options in mdEditor, you also have the option to keep your local settings as well. Note in the screenshot, the option to “Keep Settings” is checked by default. This ensures that you will not lose your local settings unless you actively uncheck that box prior to using the cache clear button."

I think that the paragraph above is direct, yet might be lacking in some details. What settings, in particular, would be worthy to note in this section. Are any exempt at all, and does this affect loaded profiles as well?

New documentation for dynamic thesaurus feature

Add new guidance describing the mdEditor dynamic thesauri feature (adiwg/mdEditor#546):

[ ] Information on how to specify custom thesaurus configuration file
[ ] Description of thesaurus configuration file syntax
[ ] Description of individual vocabulary file syntax
[ ] Expand description of the process for harvesting and parsing vocabularies presented in the mdKeywords repository

Attributes array panel requirements update

I was advised that the following section will need to be updated to reflect the panel requirements. Notably, the "Name" attribute does not show up as a required entry.
You can see how it appears in the current mdEditor guide here.

Below is an updated screenshot showing the required fields with the exclamation marks next to them.

image


For the wording under the screenshot on the page, it may be a good idea to include notes that the attributes are required. See the example below:

Code Name {type: string; max length: none; default: empty; Required Field: Yes}
Usage: The code name of the Attribute used in the dictionary schema.

Data Type {type: codelist (ADIwg codes); extensible: YES; multi-value: NO; default: empty; Required Field: Yes}Usage: The data type for this attribute (e.g. character, integer, real).

Definition {type: string; max length: none; default: empty; Required Field: Yes}
Usage: A short narrative definition of the attribute.


Are there other suggestions on this?

Distribution page layout

This issue has a few components to address.

Taking a look at the following section of the guide first.

When looking at the left-hand navigation options for the guide, you will see the following structure.

Ashampoo_Snap_Wednesday, June 17, 2020_10h46m49s_002_

Currently, there is an Online Transfer option that is not listed in that set above. It should go above the Offline Transfer option.

  • Distribution Section
    • Distribution Edit Window
    • Distributor Edit Window
      • Transfer Option
        • Online Transfer
        • Offline Transfer
        • Distribution Format
  • Order Process

As for the Online Transfer section, Here is the screenshot as it appears in the guide currently:

image

Here is how it appears in the current mdEditor version:

image


I noticed that there are two parts that are different, those at the end.
Application Profile
Protocol Request

These would need to be added to the Online Transfer page with relevant information.

Application Profile seems to just be the name of the API itself being used.
Protocol Request seems in turn to just be the request time being made to the API, (POST, GET, PUT, or possibly even DELETE).


Please provide any input you may have on this topic.

Support for external thesaurus

Allow users to access API's for external vocabularies through a user configuration stored in the settings.

  • Access to ScienceBase thesaurus API
  • Allow profile to specify thesaurus mapping
  • Support hierarchical taxonomies as collapsible list (e.g. GCMD)

International Date and Time

Provide instructions to help users understand the local time zone offset with UTC time. For instance, year, month, day entry for Alaska will result in a 08:00 time added to the date to resolve time to UTC, assuming a midnight local time (-08:00). This offset will not appear in mdEditor if the user is looking at the data in the same time zone it was entered. However, it is written with the time offset in mdJSON.

When a date time is viewed by a user in a different time zone than the data was set to, mdEditor will resolve the date time appearance to the local user's time, while mdJSON content will remain unchanged in the original time zone UTC offset. However, if that user edits the date time, it will be adjusted to that user's current UTC offset. Not sure how this can be mitigated, if undesirable. Some further investigation is needed, for instance if a time is provided, will this be the assumed UTC? If so, then it is incumbent on the user to adjust local time to UTC time.

New documentation describing adding custom vocabularies to profile definition files

Add new guidance describing the ability to add custom vocabularies to profile definition files. See: adiwg/mdEditor#566 and dynamic profiles (mdEditor PR adiwg/mdEditor#564)

[ ] Description of profiles list configuration file syntax (profile manifest file?)
[ ] Description of profile definition file vocabularies: section (including how the ID's are resolved)
[ ] Information about new custom profiles

Related issues:

Remove word "content" in domain item reference

In the current mdEditor guide, the word "Content" appears in the following location.

You can see it here:

image

In the current version of the editor, it is not showing. See image below:

image


Will updating the screenshot in this area be sufficient in clearing this matter or is there any other area where it may need to be corrected?

Update Fast Scrolling Page

As advised, the "Fast-Scrolling" section of the guide includes wording for the highlights in the sidebar. As this feature is no longer in the current program, it needs to be updated.

New documentation describing loading multiple profiles from configuration file

Add new guidance describing the use of a profile configuration file to load multiple profiles. See: adiwg/mdEditor#550 and dynamic profiles (mdEditor PR adiwg/mdEditor#564)

[ ] Description of profiles list configuration file syntax (profile manifest file?)
[ ] Description of profile configuration file syntax - (new vocabularies section)
[ ] Information about new custom profiles
[ ] Information about thesauri being filtered based on the profile selected
[ ] Screenshot of mdEditor settings screen showing custom manifest file field

Related issues:

Remove "Back to Overview" button from Dictionary

The previous discussion on this topic suggested getting a new screenshot.

I noted that in the guide, I do see where the “Back to Overview” button is still showing.
It can be found here.

Here is an updated screenshot sans the "Back" button.

image

Also, looking at this location in the guide, there is wording that needs to be removed/changed.

The paragraph in questions reads as such:

"There is a “Back to Overview” button in the Secondary Sidebar that will open a view with all of the Dictionary's information displayed. This may be helpful in determining if you have selected the intended dictionary for editing, or if you just wish to review the information entered."

Is removing this section and updating the screenshot enough for this part, or does it need more? Perhaps any form of wordage for upcoming changes or something along those lines?

Update General Settings Info

The "General Settings" details need to be updated. This section can be found here in the mdEditor user guide.

It currently appears like this in the guide:

image

This is how it appears in the current interaction of mdEditor:

image


Proper wording needs to be added to include the new options of Copy/Delete in edit mode.

Here is a rough concept of how that might look.

Ashampoo_Snap_Wednesday, June 17, 2020_10h37m20s_001_


Please provide any suggestions that might improve this.

Rename Entity Attribute "Name" to "Code Name"

From previous discussion, this section seems to need a screenshot update.

Noted from the initial comment from another issue:

"The initial comment on this issue stated “Rename the "Name" element on the "Attributes" array panel on the "Entity" edit window to "Code Name". "

The page in the mdEditor this refers to is located here.

Noted that the "Back to Overview" button is also showing on this page's screenshot.

I took the following screenshots to replace what was currently on the page.

Entity Code Name Image 1
Entity Code Name Image 2
Entity Code Name Image 3
Entity Code Name Image 4


Will these be acceptable in replacing the current images? (Annotations will be of course be added to the first screenshot to be in line with the guide).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.