DataCite DOI - Revision history

Rwf1v07@soton.ac.uk: /* Document DOIs */

2021-11-08T14:38:44Z

‎Document DOIs

Rwf1v07@soton.ac.uk: /* Document DOIs */

2021-11-08T14:38:26Z

‎Document DOIs

Rwf1v07@soton.ac.uk: /* Document Landing Pages */

2021-11-08T14:32:43Z

‎Document Landing Pages

Rwf1v07@soton.ac.uk: /* Document Landing Pages */

2021-11-08T14:32:09Z

‎Document Landing Pages

Rwf1v07@soton.ac.uk at 14:31, 8 November 2021

2021-11-08T14:31:24Z

Show changes

Rwf1v07@soton.ac.uk at 11:21, 29 October 2021

2021-10-29T11:21:01Z

Rwf1v07@soton.ac.uk at 10:35, 29 October 2021

2021-10-29T10:35:22Z

Rwf1v07@soton.ac.uk at 10:28, 29 October 2021

2021-10-29T10:28:48Z

Rwf1v07@soton.ac.uk at 10:28, 29 October 2021

2021-10-29T10:28:10Z

Rwf1v07@soton.ac.uk: Created page with "'''This documentation relates to release candidate version of the DataCite DOI plugin, available at [https://github.com/eprintsug/DataCiteDoi/tree/datacite-documents]''' ==Da..."

2021-10-29T10:25:05Z

Created page with "'''This documentation relates to release candidate version of the DataCite DOI plugin, available at [https://github.com/eprintsug/DataCiteDoi/tree/datacite-documents]''' ==Da..."

New page

'''This documentation relates to release candidate version of the DataCite DOI plugin, available at [https://github.com/eprintsug/DataCiteDoi/tree/datacite-documents]'''

==DataCite DOI Manager Screen==
The process for registering and minting DOIs is now managed via the '''DataCite DOI Manager''' screen, available via an eprint item’s '''Actions''' tab.

[[File:Actions tab highlighted.png|thumb|Actions tab with the DataCite DOI Manager option.]]

@@ Line 74: / Line 74: @@
 # Have the document_dois configuration flag enabled.
-The document_dois flag and field name can be configured in '''z_datacitedoi.pl'''.
+The '''document_dois''' flag and field name can be configured in '''z_datacitedoi.pl'''.
 <pre>
 # flag to indicate if this repository is able to coin dois for documents (off by default)
@@ Line 84: / Line 84: @@
 </pre>
-Similarly an id_number field can be defined in document_fields.pl or elsewhere in the repository configuration:
+Similarly an '''id_number''' field can be defined in '''document_fields.pl''' or elsewhere in the repository configuration:
 <pre>
 $c->{fields}->{document} = [

@@ Line 68: / Line 68: @@
 ==Document DOIs==
 All of the above features are also available for documents uploaded to a repository. DOIs must resolve to a landing page about the record they identify, and as such these features are only available for repositories with document landing pages enabled.
 [[File:Document actions.jpg|600px|thumb|center| The document "test.pdf" attached to this eprint can also have a DOI reserved or coined.]]

@@ Line 74: / Line 74: @@
 The DataCite DOI plugin supports minting DOIs for documents uploaded to eprint records, however all DOIs must resolve to a landing page however and so in order to enable this your repository needs to support document landing pages. The following code snippets illustrate how to implement document landing pages in EPrints.
-First we need a URL rewrite trigger to catch the URLs which should resolve to the landing page. The following needs to be added to the eprints or archives' configuration files, e.g. lib/cfg.d/doc_landing_pages.pl. We can also define a flag here for plugins to check to see if document landing pages are enabled on this repository.
+First we need a URL rewrite trigger to catch the URLs which should resolve to the landing page. The following needs to be added to the eprints or archives' configuration files, e.g. '''lib/cfg.d/doc_landing_pages.pl'''. We can also define a flag here for plugins to check to see if document landing pages are enabled on this repository.
 <pre>
@@ Line 99: / Line 99: @@
 </pre>
-This trigger uses a Document handler we need to implement, e.g. perl_lib/EPrints/Apache/Document.pm
+This trigger uses a Document handler we need to implement, e.g. '''perl_lib/EPrints/Apache/Document.pm'''
 <pre>
@@ Line 151: / Line 151: @@
 </pre>
-The handler calls on an EPrints screen to generate the content for the landing page, e.g. perl_lib/EPrints/Plugin/Screen/Document.pm
+The handler calls on an EPrints screen to generate the content for the landing page, e.g. '''perl_lib/EPrints/Plugin/Screen/Document.pm'''
 <pre>
@@ Line 225: / Line 225: @@
 </pre>
-And finally, the screen uses a citation file to display the document landing page content in an easily customisable fashion, e.g. lib/defaultcfg/citations/document/landing_page.xml
+And finally, the screen uses a citation file to display the document landing page content in an easily customisable fashion, e.g. '''lib/defaultcfg/citations/document/landing_page.xml'''
 <pre>

@@ Line 153: / Line 153: @@
 The handler calls on an EPrints screen to generate the content for the landing page, e.g. perl_lib/EPrints/Plugin/Screen/Document.pm
 =head1 NAME
 EPrints::Plugin::Screen::Document
-=cut
+=cut#
 package EPrints::Plugin::Screen::Document;

← Older revision		Revision as of 11:21, 29 October 2021
Line 33:		Line 33:

	The '''Mint DOI''' button will register the DOI with the global handle system, and the DOI will be registered as “Findable” in DataCite. This process may take a few minutes and is handled by the repository’s indexer. Upon successful completion the new DOI will be added to the eprint’s DOI metadata field.		The '''Mint DOI''' button will register the DOI with the global handle system, and the DOI will be registered as “Findable” in DataCite. This process may take a few minutes and is handled by the repository’s indexer. Upon successful completion the new DOI will be added to the eprint’s DOI metadata field.
		+
		+	[[File:Mint doi.jpg\|600px\|thumb\|center\|An item in the live archive with a DOI available to mint. The option to update the previously reserved DOI is still available too.]]
		+
		+	Once a DOI has successfully been minted for an eprint, the option to '''Update Metadata''' becomes available, which will resend the eprint metadata for this DOI.
		+
		+	'''This should only be used for minor updates, e.g. correcting errors or adding additional files.'''
		+
		+	==Tombstone Pages==
		+	If an item which has previously had a DOI minted for it is either retired or removed from the repository, the DataCite record is updated to point to a tombstone page for the record. This consists of the basic citation metadata that was last registered with DataCite, i.e. the data available when either of the '''Mint DOI''' or '''Update Metadata''' buttons was last used.
		+
		+	[[File:Eprint tombstone.jpg\|600px\|thumb\|center\|A tombstone page for a retired eprint, which the DOI will now redirect to, providing basic citation information.]]
		+
		+	==Versioning==
		+	When creating a new version of an eprint via the '''New version''' button in the '''Actions''' tab, any existing DOI value will be copied across to the new version of the eprint.
		+
		+	The '''DataCite DOI Manager''' will highlight when a Current DOI redirects to an earlier version of an eprint, and will present two options when the later version is in the live archive (i.e. has a page a DOI can successfully redirect to).
		+
		+	# '''Update Metadata & URL''' – this will update the current DataCite record to redirect to the new version of this eprint
		+	# '''Reserve DOI''' and '''Mint DOI''' – the regular options available when the Available DOI for a record has not yet been reserved or registered on DataCite.
		+
		+	[[File:Update metadata and url.jpg\|600px\|thumb\|center\|This eprint is a later version of an existing eprint and has inherited a DOI. The metadata and URL associated with this DOI can be updated to redirect to the newer record.]]
		+
		+	DOIs registered for eprints which are earlier or later versions of other eprints, will use DataCite’s “HasVersion” and “IsVersionOf” properties to link forwards and backwards as appropriate.
		+
		+	==External DOIs==
		+	If an eprint already has a DOI associated with it, e.g. one that has previously been provided by a journal publication, then this will be listed as the '''Current DOI'''. The DataCite DOI Manager screen will indicate where this DOI redirects to, and will still present options for an '''Available DOI''' if the DOI for this record can still be minted on DataCite.
		+
		+	[[File:External doi.jpg\|600px\|thumb\|center\|An eprint with an external DOI set. This can be replaced with an available DOI via DataCite.]]
		+
		+	The '''DataCite DOI Manager''' will also run a search of the eprint’s title against DataCites findable records, to see if a DOI has been coined previously. If one of the records matches the eprint, the '''Claim DOI''' button will set the eprint’s DOI metadata field to the DOI already on DataCite.
		+
		+	[[File:Claim doi.jpg\|600px\|thumb\|center\|Items with similar titles are already present on DataCite. If one matches the eprint, click "Claim DOI" to use the existing DOI rather than coining a new one.]]
		+
		+	==Document DOIs==
		+	All of the above features are also available for documents uploaded to a repository. DOIs must resolve to a landing page about the record they identify, and as such these features are only available for repositories with document landing pages enabled.
		+
		+	[[File:Document actions.jpg\|600px\|thumb\|center\| The document "test.pdf" attached to this eprint can also have a DOI reserved or coined.]]

@@ Line 4: / Line 4: @@
 The process for registering and minting DOIs is now managed via the '''DataCite DOI Manager''' screen, available via an eprint item’s '''Actions''' tab.
-[[File:Actions tab highlighted.png|600px|thumb|left|Actions tab with the DataCite DOI Manager option.]]
+[[File:Actions tab highlighted.png|600px|thumb|center|Actions tab with the DataCite DOI Manager option.]]
 The '''DataCite DOI Manager''' is only available for items in the review queue or the live archive, and only to those users with editor or administrator permissions.
@@ Line 10: / Line 10: @@
 Each eprint record has its own DOI that can be registered with DataCite, derived from the repository’s DataCite prefix (e.g. 10.xxx), the repository’s name, and the eprint’s ID.
-[[File:Available doi.jpg|600px|thumb|left|An eprint in the live archive with an available DOI. Options are available to either reserve or mint the DOI.]]
+[[File:Available doi.jpg|600px|thumb|center|An eprint in the live archive with an available DOI. Options are available to either reserve or mint the DOI.]]

← Older revision		Revision as of 10:28, 29 October 2021
Line 4:		Line 4:
	The process for registering and minting DOIs is now managed via the '''DataCite DOI Manager''' screen, available via an eprint item’s '''Actions''' tab.		The process for registering and minting DOIs is now managed via the '''DataCite DOI Manager''' screen, available via an eprint item’s '''Actions''' tab.

−	[[File:Actions tab highlighted.png\|thumb\|Actions tab with the DataCite DOI Manager option.]]	+	[[File:Actions tab highlighted.png\|800px\|thumb\|Actions tab with the DataCite DOI Manager option.]]
		+
		+	The '''DataCite DOI Manager''' is only available for items in the review queue or the live archive, and only to those users with editor or administrator permissions.
		+
		+	Each eprint record has its own DOI that can be registered with DataCite, derived from the repository’s DataCite prefix (e.g. 10.xxx), the repository’s name, and the eprint’s ID.
		+
		+	[[File:Available doi.jpg\|800px\|thumb\|center\|An eprint in the live archive with an available DOI. Options are available to either reserve or mint the DOI.]]