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.

Sign up for GitHub

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

make images visible in github page #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+9 −10
Open

make images visible in github page #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f04614e
make images visible in github pages
abubelinha Jan 30, 2021
092dd98
Delete index.md
abubelinha Jan 30, 2021
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
1 change: 0 additions & 1 deletion docs/assets/index.md
View file
Open in desktop

This file was deleted.

18 changes: 9 additions & 9 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,32 +44,32 @@ After the add-on has be installed and enabled for the current user the submenu "

At the top menu "Darwin Core Assistant" click on "Start DwC-Archive" to start the add-on for the current spreadsheet. After the add-on is initiated the options listed above will be shown.

![Start DwC-Archive Assistant](/assets/img/start-dwca-assistant.png)
![Start DwC-Archive Assistant](./assets/img/start-dwca-assistant.png)

## Add/Remove Mapping Row

To add or remove a mapping row from a sheet select the option *Add/Remove mappings* from the add-one menu. If no header row already exists in the current sheet, a new header row will be added to mappings columns/fields to Darwin Core terms. Otherwise, if a header row already exists in the current sheet, it will be removed.

**Note:** header rows can only be added to sheet that already has some data, so the size (number of columns) in the sheet can be calculated and the header row will have the same size of data.

![Add/Remove mapping row](/assets/img/mapping-row.png)
![Add/Remove mapping row](./assets/img/mapping-row.png)

### The special `CORE_ID` term

The Darwin Core Archive is used to represent complex structures within data (one-to-many relations) by the definition of a **star schema**. For that reason, a special term `CORE_ID` is available on the mapping row list of terms. Using the `CORE_ID` term is possible to "link" or represeting the relations between data in different sheets. Records (i.e. rows) from different sheets can be linked into a one-to-many relation by mapping a column to the `CORE_ID` term in all related sheets. Two or more columns in different sheets which have the `CORE_ID` term by definition of Darwin Core Archive Standard have to be filled same value (see figure bellow as an example).

![The CORE_ID term](/assets/img/core-id-term.png)
![The CORE_ID term](./assets/img/core-id-term.png)
*The row in the left sheet with `CORE_ID` `2787` is linked to the two rows of the right sheet, creating a one-to-many relation between sheets. The left sheet after will be selected as the **core sheet** and the right sheet as **extension sheet** in DwC-Archive nomenclature*

## Ecological Metadata Language Editor

The Ecologial Metadata Language (EML) allows the description of the whole dataset, and so, is recommended to always provided as much details as possible to describe it. Although only the DwC-Archive Standard requires an EML file to be included into the archive, as opposed to Simple Darwin Core, describing the dataset in both scenarios is recommended.

![EML Editor](/assets/img/eml-editor-1.png)
![EML Editor](./assets/img/eml-editor-1.png)

The EML Editor required only a few number of fields to be filled (only those required by [Global Biodiveristy Information Facility (GBIF) EML Schema]()). However, it's possible to manually add an EML content in XML format created using an external tool by selecting the checkbox *Manually enter EML content*.

![Manual EML Editor](/assets/img/eml-editor-manual.png)
![Manual EML Editor](./assets/img/eml-editor-manual.png)

After add the EML metadata click on *Save* button to save.

Expand All @@ -87,7 +87,7 @@ In that case, the action triggered by clicking the *Generate DwC-Archive* button

**Note**: all sheets with *mapping row* have to include a column mapped to the `CORE_ID` term, so the DwC-Archive can be generated properly.

![Darwin Core Archive](/assets/img/dwca.png)
![Darwin Core Archive](./assets/img/dwca.png)

# Publishing to Zenodo

Expand All @@ -99,11 +99,11 @@ The Zenodo publishing action is triggered when the *Generate DwC-Archive* is cli

To get an access token login into your Zenodo account, and under the *Applications* section in your profile create a **New personal access token** and be certified to check appropriated scopes. In order to allow the add-on to publish to your Zenodo account select at least both scopes **deposit:actions** and **deposit:write**. Then click into **Create** button.

![Creating Zenodo personal access token](/assets/img/zenodo.png)
![Creating Zenodo personal access token](./assets/img/zenodo.png)

Copy the new created token into the *Settings* sidemenu (activated in the add-on submenu) and selected the option **Enable Zenodo Upload**, then click **Save**.

![Setting Zenodo access token](/assets/img/settings.png)
![Setting Zenodo access token](./assets/img/settings.png)

After that, every time the *Generate DwC-Archive* action is triggered the DwC-Archive will be upload to Zenodo.

Expand All @@ -125,4 +125,4 @@ We hope that we can get access to [GBIF Sandbox API](http://api.gbif-uat.org/v1/

# License

The add-on is released with a [GNU GENERAL PUBLIC LICENSE Version 3](https://github.com/zedomel/dwca-gsheet-assistant/blob/master/LICENSE) which means that it is free and copyleft, **as all Science should be**!
The add-on is released with a [GNU GENERAL PUBLIC LICENSE Version 3](https://github.com/zedomel/dwca-gsheet-assistant/blob/master/LICENSE) which means that it is free and copyleft, **as all Science should be**!