-
Notifications
You must be signed in to change notification settings - Fork 0
Add documentation for DataCite plugin #233
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| title: DataCite plugin | ||
|
|
||
| # DataCite plugin | ||
|
|
||
| [GitHub Repo](https://github.com/openlibhums/datacite) | ||
|
|
||
| The DataCite plugin is an alternative to Janeway's built-in Crossref support. It registers Digital Object Identifiers (DOIs) with [DataCite](https://datacite.org/) rather than Crossref, and it manages the deposit for you. DOIs are stored on the same identifier record as with Crossref DOIs, so the rest of Janeway treats a DataCite DOI the same way it treats any other DOI. | ||
|
|
||
| Use this plugin when your membership is with DataCite instead of, or in addition to, Crossref. | ||
|
|
||
| > [!NOTE] | ||
| > The DataCite and Crossref tools are independent. If you register a DOI with DataCite, do not also register the same article with Crossref. | ||
|
|
||
| ## Before you start | ||
|
|
||
| A server administrator sets your DataCite credentials (username, password, and DOI prefix) when the plugin is installed. These values are not editable from the journal interface, so contact your administrator if they need to change. | ||
|
|
||
| ## Opening the plugin | ||
|
|
||
| To open the plugin, go to the manager and select **DataCite** from the list of plugins. The plugin's home page gives you three options: | ||
|
|
||
| - **Settings** controls automatic deposit for the whole journal. | ||
| - **Article list** lists articles and lets you mint DOIs by hand. | ||
| - **Section controls** limits automatic deposit to chosen sections. | ||
|
|
||
| ## Understanding DOI states | ||
|
|
||
| DataCite DOIs move through states, and this plugin uses two of them: | ||
|
|
||
| - **Draft (registered)** | ||
| The DOI and its metadata are stored at DataCite but the DOI does not resolve publicly. This is used before an article is published. | ||
|
|
||
| - **Findable (published)** | ||
| The DOI resolves to the article and its metadata is indexed. This is used once the article is published. | ||
|
|
||
| The plugin sends a draft deposit when an article is accepted and upgrades it to findable when the article is published. | ||
|
|
||
| ## Registering DOIs automatically | ||
|
|
||
| Automatic deposit is the recommended approach for new content. When it is enabled, Janeway deposits DOIs for you at two points in the workflow: | ||
|
|
||
| 1. When an article is accepted, Janeway mints a draft DOI and saves it to the article. | ||
| 2. When the article is published, Janeway upgrades that DOI to findable so it resolves to the published page. | ||
|
|
||
| Minted DOIs follow the pattern `prefix/journalcode.articleid`, for example `10.0001/tester.42`. | ||
|
|
||
| To turn automatic deposit on: | ||
|
|
||
| 1. On the plugin home page, select **Settings**. | ||
| 2. Select **Enable Datacite auto deposit**. | ||
| 3. Select **Save**. | ||
|
|
||
| ### Limiting automatic deposit to certain sections | ||
|
|
||
| By default, automatic deposit applies to every section of the journal. You can restrict it to specific sections. For example, you can mint DOIs for research articles but not editorials. | ||
|
|
||
| > [!NOTE] | ||
| > If you do not select any sections, Janeway mints DOIs for all sections. | ||
|
|
||
| Section controls only take effect while automatic deposit is enabled for the journal. | ||
|
|
||
| To choose which sections mint DOIs: | ||
|
|
||
| 1. On the plugin home page, select **Section controls**. | ||
| 2. Select each section that should mint DOIs. | ||
| 3. Select **Save**. | ||
|
|
||
| ## Registering DOIs manually | ||
|
|
||
| Automatic deposit does not cover every case. You may need to register DOIs by hand when you import back content, when deposit was turned on after some articles were already accepted, or when an earlier deposit did not complete. | ||
|
|
||
| The **Article list** shows every accepted article for the journal, alongside whether it already has a DOI. | ||
|
|
||
| To register a DOI for an article that does not have one: | ||
|
|
||
| 1. On the plugin home page, select **Article list**. | ||
| 2. Find the article and select the option to mint its DOI. | ||
| 3. Check the identifier. Janeway suggests one that follows your prefix and journal code, but you can edit it. | ||
| 4. To register the DOI as findable straight away, leave **Findable** selected. To register a draft DOI that does not yet resolve, clear the checkbox. | ||
| 5. Select **Save**. | ||
|
|
||
| Janeway deposits the metadata with DataCite and, if the deposit succeeds, saves the DOI to the article. If the deposit fails, Janeway shows the error returned by DataCite so you can correct the metadata and try again. | ||
|
|
||
| For an article that already has a DOI, minting again from the **Article list** re-sends the current metadata to DataCite as a findable deposit. Use this after correcting metadata to bring DataCite's record up to date. | ||
|
|
||
| > [!TIP] | ||
| > To see the exact metadata Janeway will send, use the article's export option. It returns the DataCite JSON for that article without depositing anything. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.