MaDgiK-CITE
/
argos
13
0
Fork 0
Code Issues Pull Requests Projects Releases 3 Wiki Activity

Adding docs for field types and semantics, site name fix

This commit is contained in:
Thomas Georgios Giannos 2024-04-29 14:30:56 +03:00
parent aa5235e950
commit ebbc92b908
6 changed files with 193 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/documentation/administration/blueprints/index.md
View File

@ -75,7 +75,7 @@ You can add one or more **fields** by clicking the `Add Field` button. For every
For a field you can specify:
- **Field Type**: There are three field types available. `System`, `External Reference` and `Custom`. There is more information available in the [Field Types](/docs/documentation/administration/blueprints/field-types) section.
- **Field Type**: There are three field types available. `System`, `External Reference` and `Custom`. There is more information available in the [Field Types](/docs/documentation/administration/blueprints/field-types?t=blueprint) section.
- **System Field**: The specific system field we want to add. <br/>*Only applicable if we add a field of type `System`.*
- **Reference Type**: The type of external reference we want to add. For more information, you can refer to the [Reference Types](/docs/documentation/administration/reference-types) section of our docs.<br/>*Only applicable if we add a field of type `External Reference`.*
- **Label**: A label for the field.

45
docs/docs/documentation/administration/commons/_markdown-field-types.md
View File

@ -1 +1,44 @@
TODO: Add info about field types
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
In general, there are tree categories of fields that can be used.
- **System**: These are predefined fields that refer to system or specification information when filled by the end users. The available system fields are the following:
- **Title**: Refers to a title of an entity.
- **Description**: Refers to a description of an entity.
- **Language**: Refers to the language to be used. The languages being displayed to the end user are discussed [here](/docs/documentation/administration/languages).
- **Contact**: Refers to contact information about who should be responsible for the entity.
- **Access**: Indicates if an entity is publicly available. The end user will have to select between `Public` or `Restricted`.
- **User**: Refers to users registered to the platform.
- **External Reference**: These are fields that connect to a locally defined or an external source (an external API in most cases). There is more information available in the [Reference Types](/docs/documentation/administration/reference-types) section.
- **Custom**: These are generic fields that can be added to provide any type of information. The available data types are the following:
- **Text**
- **Rich Text**
- **Date**
- **Number**
:::info
Let's explore some specifics based on where these fields are getting setup.
<Tabs queryString="t">
<TabItem value="blueprint" label="Blueprints">
In the case of [plan blueprints](/docs/documentation/administration/blueprints/) you define the field you want by making two choices, what is the field category and then what is the system field type or the reference type or the data type respectively.
</TabItem>
<TabItem value="template" label="Description Templates">
In the case of [description templates](/docs/documentation/administration/templates/) the field type options are 'combined' in one dropdown control. The only difference here is that the options are separated inside that single dropdown based on the field category.
In the case of custom fields, you can specify the UI control that will be used in the forms. The elements that are supported are the following:
- **Text Area**: A regular text area (multiple lines)
- **Rich Text Area**: A rich text editor
- **Free Text**: A regular text box (one line)
- **File Upload**
- **Switch**
- **Radio Box**
- **Select**
- **Checkbox**
- **Date Picker**
</TabItem>
</Tabs>
:::

138
docs/docs/documentation/administration/commons/_markdown-semantics.md
View File

@ -1 +1,137 @@
TODO: Add info about semantics
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::info
By **Semantics** we mean a relation a field can have with a part of a data archive specification. When the users try to add semantics, a list of suggestions drops down, containing semantics for `RDA` and `Zenodo`.
:::
These are the semantics suggestions.
<Tabs>
<TabItem value="rda" label="RDA" className="outer-tab">
<Tabs>
<TabItem value="plans" label="Plans">
- `rda.dmp.contact`
- `rda.dmp.contact.contact_id.identifier`
- `rda.dmp.contact.contact_id.type`
- `rda.dmp.contact.mbox`
- `rda.dmp.contact.name`
- `rda.dmp.contributor`
- `rda.dmp.contributor.contributor_id.identifier`
- `rda.dmp.contributor.contributor_id.type`
- `rda.dmp.contributor.mbox`
- `rda.dmp.contributor.name`
- `rda.dmp.contributor.role`
- `rda.dmp.cost`
- `rda.dmp.cost.currency_code`
- `rda.dmp.cost.description`
- `rda.dmp.cost.title`
- `rda.dmp.cost.value`
- `rda.dmp.created`
- `rda.dmp.description`
- `rda.dmp.dmp_id`
- `rda.dmp.dmp_id.identifier`
- `rda.dmp.dmp_id.type`
- `rda.dmp.ethical_issues_description`
- `rda.dmp.ethical_issues_exist`
- `rda.dmp.ethical_issues_report`
- `rda.dmp.language`
- `rda.dmp.modified`
- `rda.dmp.project`
- `rda.dmp.project.description`
- `rda.dmp.project.end`
- `rda.dmp.project.funding`
- `rda.dmp.project.funding.funder_id.identifier`
- `rda.dmp.project.funding.funder_id.type`
- `rda.dmp.project.funding.funding_status`
- `rda.dmp.project.funding.grant_id.identifier`
- `rda.dmp.project.funding.grant_id.type`
- `rda.dmp.project.start`
- `rda.dmp.dmp.project.title`
- `rda.dmp.title`
</TabItem>
<TabItem value="descriptions" label="Descriptions">
- `rda.dataset.data_quality_assurance`
- `rda.dataset.distribution.access_url`
- `rda.dataset.distribution.available_until`
- `rda.dataset.distribution.byte_size`
- `rda.dataset.distribution.data_access`
- `rda.dataset.distribution.description`
- `rda.dataset.distribution.download_url`
- `rda.dataset.distribution.format`
- `rda.dataset.distribution.host.availability`
- `rda.dataset.distribution.host.backup_frequency`
- `rda.dataset.distribution.host.backup_type`
- `rda.dataset.distribution.host.certified_with`
- `rda.dataset.distribution.host.description`
- `rda.dataset.distribution.host.geo_location`
- `rda.dataset.distribution.host.pid_system`
- `rda.dataset.distribution.host.storage_type`
- `rda.dataset.distribution.host.supports_versioning`
- `rda.dataset.distribution.host.title`
- `rda.dataset.distribution.host.url`
- `rda.dataset.distribution.license.license_ref`
- `rda.dataset.distribution.license.start_date`
- `rda.dataset.distribution.title`
- `rda.dataset.keyword`
- `rda.dataset.language`
- `rda.dataset.metadata.description`
- `rda.dataset.metadata.language`
- `rda.dataset.metadata.metadata_standard_id`
- `rda.dataset.metadata.metadata_standard_id.identifier`
- `rda.dataset.metadata.metadata_standard_id.type`
- `rda.dataset.personal_data`
- `rda.dataset.preservation_statement`
- `rda.dataset.security_and_privacy`
- `rda.dataset.security_and_privacy.description`
- `rda.dataset.security_and_privacy.title`
- `rda.dataset.sensitive_data`
- `rda.dataset.technical_resource.description`
- `rda.dataset.technical_resource.name`
- `rda.dataset.title`
- `rda.dataset.type`
- `rda.dataset.issued`
- `rda.dataset.dataset_id`
- `rda.dataset.dataset_id.identifier`
- `rda.dataset.dataset_id.type`
- `rda.dataset.description`
</TabItem>
</Tabs>
</TabItem>
<TabItem value="zenodo" label="Zenodo">
- `zenodo.related_identifiers.isCitedBy`
- `zenodo.related_identifiers.cites`
- `zenodo.related_identifiers.isSupplementTo`
- `zenodo.related_identifiers.isSupplementedBy`
- `zenodo.related_identifiers.isContinuedBy`
- `zenodo.related_identifiers.continues`
- `zenodo.related_identifiers.isDescribedBy`
- `zenodo.related_identifiers.describes`
- `zenodo.related_identifiers.hasMetadata`
- `zenodo.related_identifiers.isMetadataFor`
- `zenodo.related_identifiers.isNewVersionOf`
- `zenodo.related_identifiers.isPreviousVersionOf`
- `zenodo.related_identifiers.isPartOf`
- `zenodo.related_identifiers.hasPart`
- `zenodo.related_identifiers.isReferencedBy`
- `zenodo.related_identifiers.references`
- `zenodo.related_identifiers.isDocumentedBy`
- `zenodo.related_identifiers.documents`
- `zenodo.related_identifiers.isCompiledBy`
- `zenodo.related_identifiers.compiles`
- `zenodo.related_identifiers.isVariantFormOf`
- `zenodo.related_identifiers.isOriginalFormof`
- `zenodo.related_identifiers.isIdenticalTo`
- `zenodo.related_identifiers.isAlternateIdentifier`
- `zenodo.related_identifiers.isReviewedBy`
- `zenodo.related_identifiers.reviews`
- `zenodo.related_identifiers.isDerivedFrom`
- `zenodo.related_identifiers.isSourceOf`
- `zenodo.related_identifiers.requires`
- `zenodo.related_identifiers.isRequiredBy`
- `zenodo.related_identifiers.isObsoletedBy`
- `zenodo.related_identifiers.obsoletes`
</TabItem>
</Tabs>

2
docs/docs/documentation/administration/tenant-configuration.md
View File

@ -3,4 +3,4 @@ sidebar_position: 11
description: Configure the tenant you are logged in with
---
# Tenant configuration
# Tenant Configuration

12
docs/docusaurus.config.ts
View File

@ -3,8 +3,8 @@ import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
const config: Config = {
title: 'OpenDMP',
tagline: 'OpenDMP',
title: 'OpenCDMP',
tagline: 'OpenCDMP Docs',
favicon: 'img/favicon.ico',
// Set the production url of your site here
@ -58,9 +58,9 @@ const config: Config = {
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'OpenDMP',
title: 'OpenCDMP',
logo: {
alt: 'OpenDMP Logo',
alt: 'OpenCDMP Logo',
src: 'img/logo.svg',
},
items: [
@ -78,7 +78,7 @@ const config: Config = {
},
{
href: 'https://test4.opendmp.eu/splash/',
label: 'Visit OpenDMP',
label: 'Visit OpenCDMP',
position: 'right',
},
],
@ -138,7 +138,7 @@ const config: Config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} OpenDMP. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} OpenCDMP. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,

4
docs/src/css/custom.css
View File

@ -28,3 +28,7 @@
--ifm-color-primary-lightest: #4fddbf;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}
.outer-tab {
margin-left: 1rem;
}