forked from D-Net/openaire-graph-docs
Add properties of data sources & learning center in menu
This commit is contained in:
Serafeim Chatzopoulos
parent
5c6383d081
commit
5584b13272
|
|
@ -1,6 +1,6 @@
|
|||
# Data model
|
||||
|
||||
The OpenAIRE Research Graph comprises several types of [entities](./category/entities) and [relationships](./relationships) among them.
|
||||
The OpenAIRE Research Graph comprises several types of entities and [relationships](./relationships) among them.
|
||||
|
||||
The latest version of the JSON schema can be found on [Bulk downloads](../download).
|
||||
|
||||
|
|
@ -9,11 +9,11 @@ The latest version of the JSON schema can be found on [Bulk downloads](../downlo
|
|||
The figure above, presents the graph's data model.
|
||||
Its main entities are described in brief below:
|
||||
|
||||
* Research Products represent the outcomes of research activities.
|
||||
* Organizations correspond to companies or research institutions involved in projects,
|
||||
* [Research Products](entities/result) represent the outcomes of research activities.
|
||||
* [Organizations](entities/organization) correspond to companies or research institutions involved in projects,
|
||||
responsible for operating data sources or consisting the affiliations of Product creators.
|
||||
* Funders (e.g. EC, Wellcome Trust) are agencies responsible for a list of Funding Streams.
|
||||
* Funding Streams represent investments (funding actions) from Funders (e.g. FP7 or H2020).
|
||||
* Projects are research projects funded by a Funding Stream of a Funder.
|
||||
* Data Sources are the resources used to collect metadata for the graph objects
|
||||
* [Projects](entities/project) are research projects funded by a Funding Stream of a Funder.
|
||||
* [Data Sources](entities/data-source) are the resources used to collect metadata for the graph objects
|
||||
|
||||
|
|
|
|||
|
|
@ -3,3 +3,138 @@ sidebar_position: 2
|
|||
---
|
||||
|
||||
# Data source
|
||||
|
||||
OpenAIRE entity instances are created out of data collected from various data sources of different kinds, such as publication repositories, dataset archives, CRIS systems, funder databases, etc. Data sources export information packages (e.g., XML records, HTTP responses, RDF data, JSON) that may contain information on one or more of such entities and possibly relationships between them. For example, a metadata record about a project carries information for the creation of a Project entity and its participants (as Organization entities). It is important, once each piece of information is extracted from such packages and inserted into the OpenAIRE information space as an entity, for such pieces to keep provenance information relative to the originating data source. This is to give visibility to the data source, but also to enable the reconstruction of the very same piece of information if problems arise.
|
||||
|
||||
Definitions for the re3data specific elements from: https://gfzpublic.gfz-potsdam.de/rest/items/item_758898_6/component/file_775891/content
|
||||
---
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Main entity identifier, created according to [OpenAIRE_entity_identifier_and_PID_mapping_policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy).
|
||||
|
||||
### originalId
|
||||
_Type: String • Cardinality: MANY_
|
||||
|
||||
The list of original ids associated to the datasource.
|
||||
|
||||
### pid
|
||||
_Type: [ControlledField](other#controlledfield) • Cardinality: MANY_
|
||||
|
||||
The persistent identifiers for the datasource.
|
||||
|
||||
### datasourcetype
|
||||
_Type: [ControlledField](other#controlledfield) • Cardinality: ONE_
|
||||
|
||||
The datasource type (e.g. pubsrepository::institutional, Institutional Repository) as in the vocabulary [dnet:datasource_typologies](https://api.openaire.eu/vocabularies/dnet:datasourceCompatibilityLevel).
|
||||
|
||||
### openairecompatibility
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The OpenAIRE compatibility of the ingested results, indicates which guidelines they are compliant to the vocabulary [dnet:datasourceCompatibilityLevel](https://api.openaire.eu/vocabularies/dnet:datasourceCompatibilityLevel).
|
||||
|
||||
### officialname
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The official name of the datasource.
|
||||
|
||||
### englishname
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The English name of the datasource.
|
||||
|
||||
### websiteurl
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The URL of the website of the datasource.
|
||||
|
||||
### logourl
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The URL of the logo for the datasource.
|
||||
|
||||
### dateofvalidation
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The date of validation against the guidelines for the datasource records.
|
||||
|
||||
### description
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The description for the datasource.
|
||||
|
||||
### subjects
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The subjects of the contents provided by the datasource.
|
||||
|
||||
### languages
|
||||
_Type: String • Cardinality: MANY_
|
||||
|
||||
The languages of the contents provided by the datasource (OpenDOAR only).
|
||||
|
||||
### contenttypes
|
||||
_Type: String • Cardinality: MANY_
|
||||
|
||||
The typologies of the contents provided by the datasource (OpenDOAR only).
|
||||
|
||||
### releasestartdate
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### releaseenddate
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### accessrights
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Open, restricted or closed.
|
||||
|
||||
### uploadrights
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Open, restricted or closed.
|
||||
|
||||
### databaseaccessrestriction
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
All existing access restrictions to the research data repository. Allowed values are: feeRequired, registration, other (re3data only).
|
||||
|
||||
### datauploadrestriction
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
All existing restrictions to the data upload. (re3data only).
|
||||
|
||||
### versioning
|
||||
_Type: Boolean • Cardinality: ONE_
|
||||
|
||||
The research data repository supports versioning of research data. (re3data only).
|
||||
|
||||
### citationguidelineurl
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The URL of the research data repository providing information on how to cite its research data. The DataCite citation format is recommended (http://www.datacite.org/whycitedata). (re3data only)
|
||||
|
||||
### pidsystems
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
### certificates
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### policies
|
||||
_Type: String • Cardinality: MANY_
|
||||
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### journal
|
||||
_Type: [Container](other#container) • Cardinality: ONE_
|
||||
|
||||
<span className="todo">TODO</span>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,582 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Other helper objects
|
||||
|
||||
|
||||
## AccessRight
|
||||
_Type: One of `{ gold, green, hybrid, bronze }` • Cardinality: ONE_
|
||||
|
||||
Subclass of [BestAccessRight](#bestaccessright), indicates information about rights held in and over the resource and the open Access Route.
|
||||
|
||||
### openAccessRoute
|
||||
|
||||
Indicates the OpenAccess status. Values are set according to the [Unpaywall methodology](https://support.unpaywall.org/support/solutions/articles/44001777288-what-do-the-types-of-oa-status-green-gold-hybrid-and-bronze-mean-).
|
||||
|
||||
## AlternateIdentifier
|
||||
Type used to represent the information associated to persistent identifiers associated to the result that have not been forged by an authority for that pid type. For example we collect metadata from an institutional repository that provides as identifier for the result also the doi.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"scheme" : "doi",
|
||||
"value" : "10.17182/hepdata.9959"
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
### scheme
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Vocabulary reference.
|
||||
|
||||
### value
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Value from the given scheme/vocabulary.
|
||||
|
||||
## APC
|
||||
Indicates the money spent to make a book or article available in Open Access. Sources for this information includes the OpenAPC initiative.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"currency" : "EU",
|
||||
"amount": "1000"
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
### currency
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The system of money in which the amount is expressed (Euro, USD, etc).
|
||||
|
||||
### amount
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The quantity of money.
|
||||
|
||||
## Author
|
||||
|
||||
Represents the result author.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"fullname":"Turunen, Heidi",
|
||||
"name":"Heidi",
|
||||
"surname":"Turunen",
|
||||
"rank":1,
|
||||
"pid":{
|
||||
"id":{
|
||||
"scheme":"orcid",
|
||||
"value":"0000-0001-7169-1177"
|
||||
},
|
||||
"provenance":{
|
||||
"provenance":"Harvested",
|
||||
"trust":"0.9"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
### fullname
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's full name.
|
||||
|
||||
### name
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's given name.
|
||||
|
||||
### surname
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's family name.
|
||||
|
||||
### rank
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's order in the list of authors for the given result.
|
||||
|
||||
### pid
|
||||
_Type: [AuthorPid](#authorpid) • Cardinality: ONE_
|
||||
|
||||
Persistent identifier associated with this author.
|
||||
|
||||
## AuthorPid
|
||||
|
||||
The author's persistent identifier.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"id":{
|
||||
"scheme":"orcid",
|
||||
"value":"0000-0001-7169-1177"
|
||||
},
|
||||
"provenance":{
|
||||
"provenance":"Inferred by OpenAIRE",
|
||||
"trust":"0.85"
|
||||
}
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
### id
|
||||
_Type: [AuthorPidSchemaValue](#authorpidschemavalue) • Cardinality: ONE_
|
||||
|
||||
### provenance
|
||||
_Type: [Provenance](#provenance-2) • Cardinality: ONE_
|
||||
|
||||
## AuthorPidSchemaValue
|
||||
Type used to represent the scheme and value for the author's pid.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"scheme" : "orcid",
|
||||
"value" : "0000-1111-2222-3333"
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
### schema
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The author's pid scheme. OpenAIRE currently supports ORCID.
|
||||
|
||||
### value
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The author's pid value.
|
||||
|
||||
## BestAccessRight
|
||||
Indicates the most open access rights \*available among the result Instances.
|
||||
|
||||
\* where the openness is defined by the ordering of the access right terms in the following.
|
||||
```
|
||||
OPEN SOURCE > OPEN > EMBARGO (6MONTHS) > EMBARGO (12MONTHS) > RESTRICTED > CLOSED > UNKNOWN
|
||||
```
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"code":"c_16ec",
|
||||
"label":"RESTRICTED",
|
||||
"scheme":"http://vocabularies.coar-repositories.org/documentation/access_rights/"
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
### code
|
||||
_Type: String • Cardinality: ONE_
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### label
|
||||
_Type: String • Cardinality: ONE_
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### scheme
|
||||
_Type: String • Cardinality: ONE_
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
## Container
|
||||
This field has information about the conference or journal where the result has been presented or published.
|
||||
|
||||
### name
|
||||
_Type: String • Cardinality: ONE_
|
||||
Name of the journal or conference.
|
||||
|
||||
### issnPrinted
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The journal printed issn.
|
||||
|
||||
### issnOnline
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The journal online issn.
|
||||
|
||||
### issnLinking
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The journal linking issn.
|
||||
|
||||
### iss
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The journal issue.
|
||||
|
||||
### sp
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The start page.
|
||||
|
||||
### ep
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The end page.
|
||||
|
||||
### vol
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The journal volume.
|
||||
|
||||
### edition
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The edition of the journal or conference.
|
||||
|
||||
### conferenceplace
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The place of the conference.
|
||||
|
||||
### conferencedate
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The date of the conference.
|
||||
|
||||
## GeoLocation
|
||||
Represents the geolocation information.
|
||||
|
||||
### point
|
||||
_Type: String • Cardinality: ONE_
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### box
|
||||
_Type: String • Cardinality: ONE_
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
### place
|
||||
_Type: String • Cardinality: ONE_
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
## ControlledField
|
||||
<span className="todo">TODO: similar to AlternateIdentifier and ResultPid?</span>
|
||||
|
||||
Generic type used to represent the information described by a scheme and a value in that scheme (i.e. pid).
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"scheme" : "DOI",
|
||||
"value" : "10.5281/zenodo.4707307"
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### scheme
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Vocabulary reference.
|
||||
|
||||
### value
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Value from the given scheme/vocabulary.
|
||||
|
||||
## Country
|
||||
To represent the generic country code and label.
|
||||
|
||||
|
||||
### code
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The country code (i.e. IT).
|
||||
<span className="todo">TODO: based on which list?</span>
|
||||
|
||||
### label
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The country label (i.e. Italy).
|
||||
|
||||
## ResultCountry
|
||||
It is for the country associated to the result.
|
||||
It is a subclass of [Country](#country) and extends it with provenance information.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"code" : "IT",
|
||||
"label": "Italy",
|
||||
"provenance" : {
|
||||
"provenance": "inferred by OpenAIRE",
|
||||
"trust": "0.85"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### provenance
|
||||
_Type: [Provenance](#provenance-2) • Cardinality: ONE_
|
||||
|
||||
Indicates the reason why this country is associated to this result
|
||||
|
||||
## Instance
|
||||
An instance is one specific materialization or version of the result. For example, you can have one result with three instances as result of deduplication:
|
||||
|
||||
* one is the pre-print
|
||||
* one is the post-print
|
||||
* one is the published version
|
||||
|
||||
Each instance is characterized by the properties described in the following table.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"accessright":{
|
||||
"code":"c_abf2",
|
||||
"label":"OPEN",
|
||||
"openAccessRoute":"gold",
|
||||
"scheme":"http://vocabularies.coar-repositories.org/documentation/access_rights/"
|
||||
},
|
||||
"alternateIdentifier":[],
|
||||
"license":"http://creativecommons.org/licenses/by-nc/4.0",
|
||||
"pid":[],
|
||||
"publicationdate":"2009-02-12",
|
||||
"refereed":"UNKNOWN",
|
||||
"type":"Article",
|
||||
"url":["https://periodicos2.uesb.br/index.php/folio/article/view/4296"]
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### accessright
|
||||
_Type: [AccessRight](#accessright) • Cardinality: ONE_
|
||||
|
||||
Maps [dc:rights](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/rights/), describes the access rights of the web resources relative to this instance.
|
||||
|
||||
### alternateIdentifier
|
||||
_Type: [AlternateIdentifier](#alternateidentifier) • Cardinality: MANY_
|
||||
|
||||
All the identifiers associated to the result other than the authoritative ones.
|
||||
|
||||
### articleprocessingcharge
|
||||
_Type: [APC](#apc) • Cardinality: ONE_
|
||||
|
||||
The money spent to make this book or article available in Open Access. Source for this information is the OpenAPC initiative.
|
||||
|
||||
### license
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The license URL.
|
||||
|
||||
### pid
|
||||
_Type: [ResultPid](#resultpid) • Cardinality: MANY_
|
||||
|
||||
The set of persistent identifiers associated to this instance that have been collected from an authority for the pid type (i.e. Crossref/Datacite for doi). See [OpenAIRE_entity_identifier_and_PID_mapping_policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy) for more information.
|
||||
|
||||
### publicationdate
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The publication date of the research product.
|
||||
|
||||
### refereed
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Describes if this instance has been peer-reviewed or not. Allowed values are peerReviewed, nonPeerReviewed, UNKNOWN (as defined in https://api.openaire.eu/vocabularies/dnet:review_levels). For example:
|
||||
|
||||
* peerReviewed: https://api.openaire.eu/vocabularies/dnet:review_levels/0001
|
||||
* nonPeerReviewed: https://api.openaire.eu/vocabularies/dnet:review_levels/0002
|
||||
|
||||
based on guidelines covers the vocabularies
|
||||
|
||||
* [DRIVE guidelines 2.0 - info:eu-repo/semantic](https://wiki.surfnet.nl/download/attachments/10851536/DRIVER_Guidelines_v2_Final_2008-11-13.pdf) (OpenAIRE v1.0 till v3.0 - Literature)
|
||||
* [COAR Vocabulary v2.0 and v3.0](https://vocabularies.coar-repositories.org/resource_types/) (OpenAIRE v4 - Inst.+Them.)
|
||||
|
||||
### type
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The specific sub-type of this instance (see https://api.openaire.eu/vocabularies/dnet:result_typologies following the links)
|
||||
### url
|
||||
_Type: String • Cardinality: MANY_
|
||||
|
||||
URLs to the instance. They may link to the actual full-text or to the landing page at the hosting source.
|
||||
|
||||
## Language
|
||||
Represents information for the language of the result
|
||||
|
||||
### code
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Alpha-3/ISO 639-2 code of the language.
|
||||
|
||||
### label
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Language label in English
|
||||
|
||||
|
||||
## Provenance
|
||||
Indicates the process that produced (or provided) the information, and the trust associated to the information.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"provenance":"Harvested",
|
||||
"trust":"0.9"
|
||||
},
|
||||
{
|
||||
"provenance":"Inferred by OpenAIRE",
|
||||
"trust":"0.875"
|
||||
},
|
||||
{
|
||||
"provenance":"Linked by user",
|
||||
"trust":"0.8"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### provenance
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
provenance term from the vocabulary [dnet:provenanceActions](https://api.openaire.eu/vocabularies/dnet:provenanceActions).
|
||||
|
||||
### trust
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Trust, expressed as a number in the range [0-1].
|
||||
|
||||
## ResultPid
|
||||
Type used to represent the information associated to persistent identifiers for the result that have been forged by an authority for that pid type.
|
||||
|
||||
<span className="todo">Seems to be similar to the AlternateIdentifier. What is the difference?</span>
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"scheme" : "doi",
|
||||
"value" : "10.21511/bbs.13(3).2018.13"
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
### scheme
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Vocabulary reference.
|
||||
|
||||
### value
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Value from the given scheme/vocabulary.
|
||||
|
||||
## Subject
|
||||
Represents keywords associated to the result.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"subject":{
|
||||
"scheme": "acm",
|
||||
"value": "GeneralLiterature_MISCELLANEOUS"
|
||||
},
|
||||
"provenance": {
|
||||
"provenance": "Inferred by OpenAIRE",
|
||||
"trust": "0.891"
|
||||
}
|
||||
},
|
||||
{
|
||||
"provenance":{
|
||||
"provenance":"Harvested",
|
||||
"trust":"0.9"
|
||||
},
|
||||
"subject":{
|
||||
"scheme":"keyword",
|
||||
"value":"SVOC"
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
</details>
|
||||
|
||||
### subject
|
||||
_Type: [SubjectSchemeValue](#subjectschemevalue) • Cardinality: ONE_
|
||||
|
||||
Contains the subject term: subject type (keyword, MeSH, etc) and the subject term (medicine, chemistry, etc.).
|
||||
|
||||
### provenance
|
||||
_Type: [Provenance](#provenance-2) • Cardinality: ONE_
|
||||
|
||||
Contains provenance information for the subject term.
|
||||
|
||||
## SubjectSchemeValue
|
||||
Subject classification against a vocabulary
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"scheme" : "keyword",
|
||||
"value" : "pyrolysis-oil"
|
||||
},
|
||||
{
|
||||
"value":"food and beverages",
|
||||
"scheme":"mesheuropmc"
|
||||
}
|
||||
]
|
||||
```
|
||||
</details>
|
||||
|
||||
### scheme
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
OpenAIRE subject classification scheme (https://api.openaire.eu/vocabularies/dnet:subject_classification_typologies).
|
||||
|
||||
### value
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The value for the subject in the selected scheme. When the scheme is 'keyword', it means that the subject is free-text (i.e. not a term from a controlled vocabulary).
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Result
|
||||
# Result (Research Product)
|
||||
|
||||
Results are intended as digital objects, described by metadata, resulting from a scientific process.
|
||||
In this page, we descibe the properties of the `Result` object.
|
||||
|
|
@ -18,17 +18,13 @@ Moreover, there are the following sub-types of a `Result`, that inherit all its
|
|||
## Properties
|
||||
|
||||
### id
|
||||
_Type: String_
|
||||
|
||||
_Cardinality: ONE_
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Main entity identifier, created according to
|
||||
<span className="todo">[OpenAIRE entity identifier and PID mapping policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy)</span>.
|
||||
|
||||
### type
|
||||
_Type: String_
|
||||
|
||||
_Cardinality: ONE_
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Type of the result. Possible types:
|
||||
|
||||
|
|
@ -55,12 +51,12 @@ _Type: String • Cardinality: ONE_
|
|||
Explanatory or alternative name by which a scientific result is known.
|
||||
|
||||
### author
|
||||
_Type: [Author](#author-1) • Cardinality: MANY_
|
||||
_Type: [Author](other#author) • Cardinality: MANY_
|
||||
|
||||
The main researchers involved in producing the data, or the authors of the publication.
|
||||
|
||||
### bestaccessright
|
||||
_Type: [BestAccessRight](#bestaccessright-1) • Cardinality: ONE_
|
||||
_Type: [BestAccessRight](other#bestaccessright) • Cardinality: ONE_
|
||||
|
||||
The most open access right associated to the manifestations of this research results.
|
||||
|
||||
|
|
@ -70,7 +66,7 @@ _Type: String • Cardinality: MANY_
|
|||
The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
|
||||
|
||||
### country
|
||||
_Type: [ResultCountry](#resultcountry) • Cardinality: MANY_
|
||||
_Type: [ResultCountry](other#resultcountry) • Cardinality: MANY_
|
||||
|
||||
Country associated with the result because it is the country of the organisation that manages the institutional repository or national aggregator or CRIS system from which this record was collected
|
||||
Country of affiliations of authors can be found instead in the affiliation rel.
|
||||
|
|
@ -96,12 +92,12 @@ _Type: String • Cardinality: ONE_
|
|||
Date when the embargo ends and this result turns Open Access. <span className="todo">TODO: we should indicate the used date format</span>
|
||||
|
||||
### instance
|
||||
_Type: [Instance](#instance-1) • Cardinality: MANY_
|
||||
_Type: [Instance](other#instance) • Cardinality: MANY_
|
||||
|
||||
Specific materialization or version of the result. For example, you can have one result with three instances: one is the pre-print, one is the post-print, one is the published version
|
||||
|
||||
### language
|
||||
_Type: [Language](#language-1) • Cardinality: ONE_
|
||||
_Type: [Language](other#language) • Cardinality: ONE_
|
||||
|
||||
The `alpha-3/ISO 639-2` code of the language. Values controlled by the [dnet:languages vocabulary](https://api.openaire.eu/vocabularies/dnet:languages)
|
||||
|
||||
|
|
@ -111,7 +107,7 @@ _Type: Long • Cardinality: ONE_
|
|||
Timestamp of last update of the record in OpenAIRE.
|
||||
|
||||
### pid
|
||||
_Type: [ResultPid](#resultpid) • Cardinality: MANY_
|
||||
_Type: [ResultPid](other#resultpid) • Cardinality: MANY_
|
||||
|
||||
Persistent identifiers of the result. See also <span className="todo">[OpenAIRE entity identifier and PID mapping policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy)</span> to learn more.
|
||||
|
||||
|
|
@ -131,7 +127,7 @@ _Type: String • Cardinality: MANY_
|
|||
A related resource from which the described resource is derived. See definition of Dublin Core field [dc:source](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/source).
|
||||
|
||||
### subjects
|
||||
_Type: [Subject](#subject) • Cardinality: MANY_
|
||||
_Type: [Subject](other#subject) • Cardinality: MANY_
|
||||
|
||||
Subject, keyword, classification code, or key phrase describing the resource.
|
||||
|
||||
|
|
@ -144,7 +140,7 @@ There are the following sub-types of `Result`. Each inherits all its fields and
|
|||
### Publication
|
||||
|
||||
#### container
|
||||
_Type: [Container](#container-1) • Cardinality: ONE_
|
||||
_Type: [Container](other#container) • Cardinality: ONE_
|
||||
|
||||
Container has information about the conference or journal where the result has been presented or published.
|
||||
|
||||
|
|
@ -161,7 +157,7 @@ _Type: String • Cardinality: ONE_
|
|||
The version of the dataset.
|
||||
|
||||
#### geolocation
|
||||
_Type: [GeoLocation](#geolocation-1) • Cardinality: MANY_
|
||||
_Type: [GeoLocation](other#geolocation) • Cardinality: MANY_
|
||||
|
||||
The list of geolocations associated with the dataset.
|
||||
|
||||
|
|
@ -199,158 +195,3 @@ _Type: String • Cardinality: MANY_
|
|||
|
||||
Information about tool useful for the interpretation and/or re-use of the research product.
|
||||
|
||||
---
|
||||
|
||||
## Other component objects
|
||||
|
||||
|
||||
### Author
|
||||
|
||||
Represents the result author.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"fullname":"Turunen, Heidi",
|
||||
"name":"Heidi",
|
||||
"surname":"Turunen",
|
||||
"rank":1,
|
||||
"pid":{
|
||||
"id":{
|
||||
"scheme":"orcid",
|
||||
"value":"0000-0001-7169-1177"
|
||||
},
|
||||
"provenance":{
|
||||
"provenance":"Harvested",
|
||||
"trust":"0.9"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
#### fullname
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's full name.
|
||||
|
||||
#### name
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's given name.
|
||||
|
||||
#### surname
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's family name.
|
||||
|
||||
#### rank
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Author's order in the list of authors for the given result.
|
||||
|
||||
#### pid
|
||||
_Type: [AuthorPid](#authorpid) • Cardinality: ONE_
|
||||
|
||||
Persistent identifier associated with this author.
|
||||
|
||||
### AuthorPid
|
||||
|
||||
The author's persistent identifier.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"id":{
|
||||
"scheme":"orcid",
|
||||
"value":"0000-0001-7169-1177"
|
||||
},
|
||||
"provenance":{
|
||||
"provenance":"Inferred by OpenAIRE",
|
||||
"trust":"0.85"
|
||||
}
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
#### id
|
||||
_Type: [AuthorPidSchemaValue](#authorpidschemavalue) • Cardinality: ONE_
|
||||
|
||||
#### provenance
|
||||
_Type: [Provenance](#provenance-1) • Cardinality: ONE_
|
||||
|
||||
### AuthorPidSchemaValue
|
||||
Type used to represent the scheme and value for the author's pid.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"scheme" : "orcid",
|
||||
"value" : "0000-1111-2222-3333"
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
#### schema
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The author's pid scheme. OpenAIRE currently supports ORCID.
|
||||
|
||||
#### value
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
The author's pid value.
|
||||
|
||||
### BestAccessRight
|
||||
### Container
|
||||
### GeoLocation
|
||||
### ResultCountry
|
||||
### Instance
|
||||
### Language
|
||||
### Provenance
|
||||
Indicates the process that produced (or provided) the information, and the trust associated to the information.
|
||||
|
||||
<details>
|
||||
<summary>Example</summary>
|
||||
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"provenance":"Harvested",
|
||||
"trust":"0.9"
|
||||
},
|
||||
{
|
||||
"provenance":"Inferred by OpenAIRE",
|
||||
"trust":"0.875"
|
||||
},
|
||||
{
|
||||
"provenance":"Linked by user",
|
||||
"trust":"0.8"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### provenance
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
provenance term from the vocabulary [dnet:provenanceActions](https://api.openaire.eu/vocabularies/dnet:provenanceActions).
|
||||
|
||||
#### trust
|
||||
_Type: String • Cardinality: ONE_
|
||||
|
||||
Trust, expressed as a number in the range [0-1].
|
||||
|
||||
### ResultPid
|
||||
### Subject
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
sidebar_position: 9
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"label": "Tutorial - Basics",
|
||||
"position": 15,
|
||||
"label": "Learning center",
|
||||
"position": 9,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn the most important Docusaurus concepts."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# OpenPlato Webinars
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Tutorials
|
||||
<span className="todo">TODO</span>
|
||||
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
sidebar_position: 10
|
||||
sidebar_position: 11
|
||||
---
|
||||
|
||||
# License
|
||||
|
|
|
|||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Congratulations!
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
|
||||
|
||||
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
|
||||
|
||||
## What's next?
|
||||
|
||||
- Read the [official documentation](https://docusaurus.io/).
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create a Blog Post
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
Create a file at `blog/2021-02-28-greetings.md`:
|
||||
|
||||
```md title="blog/2021-02-28-greetings.md"
|
||||
---
|
||||
slug: greetings
|
||||
title: Greetings!
|
||||
authors:
|
||||
- name: Joel Marcey
|
||||
title: Co-creator of Docusaurus 1
|
||||
url: https://github.com/JoelMarcey
|
||||
image_url: https://github.com/JoelMarcey.png
|
||||
- name: Sébastien Lorber
|
||||
title: Docusaurus maintainer
|
||||
url: https://sebastienlorber.com
|
||||
image_url: https://github.com/slorber.png
|
||||
tags: [greetings]
|
||||
---
|
||||
|
||||
Congratulations, you have made your first post!
|
||||
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create a Document
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
- **versioning**
|
||||
|
||||
## Create your first Doc
|
||||
|
||||
Create a Markdown file at `docs/hello.md`:
|
||||
|
||||
```md title="docs/hello.md"
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
|
||||
|
||||
## Configure the Sidebar
|
||||
|
||||
Docusaurus automatically **creates a sidebar** from the `docs` folder.
|
||||
|
||||
Add metadata to customize the sidebar label and position:
|
||||
|
||||
```md title="docs/hello.md" {1-4}
|
||||
---
|
||||
sidebar_label: 'Hi!'
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
It is also possible to create your sidebar explicitly in `sidebars.js`:
|
||||
|
||||
```js title="sidebars.js"
|
||||
module.exports = {
|
||||
tutorialSidebar: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
// highlight-next-line
|
||||
items: ['hello'],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create a Page
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
|
||||
- `src/pages/index.js` → `localhost:3000/`
|
||||
- `src/pages/foo.md` → `localhost:3000/foo`
|
||||
- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
|
||||
|
||||
## Create your first React Page
|
||||
|
||||
Create a file at `src/pages/my-react-page.js`:
|
||||
|
||||
```jsx title="src/pages/my-react-page.js"
|
||||
import React from 'react';
|
||||
import Layout from '@theme/Layout';
|
||||
|
||||
export default function MyReactPage() {
|
||||
return (
|
||||
<Layout>
|
||||
<h1>My React page</h1>
|
||||
<p>This is a React page</p>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
|
||||
|
||||
## Create your first Markdown Page
|
||||
|
||||
Create a file at `src/pages/my-markdown-page.md`:
|
||||
|
||||
```mdx title="src/pages/my-markdown-page.md"
|
||||
# My Markdown page
|
||||
|
||||
This is a Markdown page
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Deploy your site
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
|
||||
## Build your site
|
||||
|
||||
Build your site **for production**:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
The static files are generated in the `build` folder.
|
||||
|
||||
## Deploy your site
|
||||
|
||||
Test your production build locally:
|
||||
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
|
||||
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
|
||||
|
||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||
|
|
@ -1,146 +0,0 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Markdown Features
|
||||
|
||||
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
|
||||
|
||||
## Front Matter
|
||||
|
||||
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
|
||||
|
||||
```text title="my-doc.md"
|
||||
// highlight-start
|
||||
---
|
||||
id: my-doc-id
|
||||
title: My document title
|
||||
description: My document description
|
||||
slug: /my-custom-url
|
||||
---
|
||||
// highlight-end
|
||||
|
||||
## Markdown heading
|
||||
|
||||
Markdown text with [links](./hello.md)
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
Regular Markdown links are supported, using url paths or relative file paths.
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](/create-a-page).
|
||||
```
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](./create-a-page.md).
|
||||
```
|
||||
|
||||
**Result:** Let's see how to [Create a page](./create-a-page.md).
|
||||
|
||||
## Images
|
||||
|
||||
Regular Markdown images are supported.
|
||||
|
||||
You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
You can reference images relative to the current file as well, as shown in [the extra guides](../tutorial-extras/manage-docs-versions.md).
|
||||
|
||||
## Code Blocks
|
||||
|
||||
Markdown code blocks are supported with Syntax highlighting.
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return (
|
||||
<h1>Hello, Docusaurus!</h1>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
}
|
||||
```
|
||||
|
||||
## Admonitions
|
||||
|
||||
Docusaurus has a special syntax to create admonitions and callouts:
|
||||
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
|
||||
## MDX and React Components
|
||||
|
||||
[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
|
||||
|
||||
```jsx
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`)
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
```
|
||||
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"label": "Tutorial - Extras",
|
||||
"position": 16,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Manage Docs Versions
|
||||
|
||||
Docusaurus can manage multiple versions of your docs.
|
||||
|
||||
## Create a docs version
|
||||
|
||||
Release a version 1.0 of your project:
|
||||
|
||||
```bash
|
||||
npm run docusaurus docs:version 1.0
|
||||
```
|
||||
|
||||
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
|
||||
|
||||
Your docs now have 2 versions:
|
||||
|
||||
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
|
||||
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
|
||||
|
||||
## Add a Version Dropdown
|
||||
|
||||
To navigate seamlessly across versions, add a version dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'docsVersionDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The docs version dropdown appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Update an existing version
|
||||
|
||||
It is possible to edit versioned docs in their respective folder:
|
||||
|
||||
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
|
||||
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
|
||||
|
|
@ -1,88 +0,0 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Translate your site
|
||||
|
||||
Let's translate `docs/intro.md` to French.
|
||||
|
||||
## Configure i18n
|
||||
|
||||
Modify `docusaurus.config.js` to add support for the `fr` locale:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en', 'fr'],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Translate a doc
|
||||
|
||||
Copy the `docs/intro.md` file to the `i18n/fr` folder:
|
||||
|
||||
```bash
|
||||
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
|
||||
|
||||
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
|
||||
```
|
||||
|
||||
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
|
||||
|
||||
## Start your localized site
|
||||
|
||||
Start your site on the French locale:
|
||||
|
||||
```bash
|
||||
npm run start -- --locale fr
|
||||
```
|
||||
|
||||
Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
|
||||
|
||||
:::caution
|
||||
|
||||
In development, you can only use one locale at a same time.
|
||||
|
||||
:::
|
||||
|
||||
## Add a Locale Dropdown
|
||||
|
||||
To navigate seamlessly across languages, add a locale dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'localeDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The locale dropdown now appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Build your localized site
|
||||
|
||||
Build your site for a specific locale:
|
||||
|
||||
```bash
|
||||
npm run build -- --locale fr
|
||||
```
|
||||
|
||||
Or build your site to include all the locales at once:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
Loading…
Reference in New Issue