Difference between revisions of "Submission System"

From Dryad wiki
Jump to: navigation, search
(Points to remember)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''Status: initial work completed by Nescent. Enhancements are being evaluated by @mire.'''
 
  
See also the list of [[Use Cases]] and the [[Partner Submission Integration]].
+
== Overview ==
  
 +
Dryad's submission system allows users to quickly and easily submit data packages. Key features include:
  
== Workflow for a New Article ==
+
#[[Submission_Integration:_Overview|Integration with journals]] -- allowing authors to automatically fill the Dryad forms with information from the journal's description of an article, and automatically notifying journal editors when a Dryad submission is completed.
 +
#Minimal description requirements -- Dryad minimizes the amount of typing/clicking required by submitters. Descriptions are automatically propagated from the article description to descriptions for individual data files. Reasonable defaults are set for the various choices available.
 +
#Integration with partner repositories -- allowing submitters to use Dryad information as a starting point for submitting content to another repository.
  
# Journal accepts the author's publication.
+
See also the journal-oriented [[Submission Integration]] page.
# Journal mails Dryad with metadata.
 
# Journal mails author acceptance letter, which contains a link to the Dryad submission for that publication. If the primary corresponding author of the article is not the primary manager of the data set, the article author may forward the email to the data set author.
 
## Author follows the link, which has the form: http://datadryad.org/submit?journalID=zzzz&manu=xxxx
 
## The link redirects to the DSpace aspect that handles submission: http://datadryad.org/dryadsubmit/jsubmit?journalID=zzzz&manu=xxxx
 
## Author logs in to Dryad (or creates an account). ([[Media:SubmissionMockupLogin.png]])
 
## Author is presented with a publication page that allows "Edit Publication Details" and "Add Dataset". ([[Media:SubmissionMockupPubSummary.png]])
 
## Author may expand metadata for the publication. ([[Media:SubmissionMockupJournalPub.png]])
 
## Author uploads data, providing additional metadata for each data set. ([[Media:SubmissionMockupDataset.png]]). The author may also include a "README" file with additional documentation (see [http://hdl.handle.net/10255/dryad.1088 a Dryad record with a README file]).
 
## Author may provide IDs of data sets in other repositories.
 
## Author may provide IDs of pre-existing data sets in Dryad.
 
## Author may choose to place data sets under embargo. (Default embargo period lasts until 1 year from the '''publication''' date.
 
## Author chooses to "Publish Datasets". ([[Media:SubmissionMockupPubSummary.png]])
 
# Dryad mails handle of '''publication''' record to journal editor. (At least one dataset must be present.)
 
# Journal editors may include the Dryad handle in the article.
 
# Journal sends the table of contents (including DOI list) for each issue to Dryad, so complete metadata can be extracted and the embargo period can officially start.
 
#* This may be the same information that is sent to Crossref and/or PubMedCentral.
 
  
== Workflow for an Article in a non-partner Journal ==
+
== Instructions ==
  
# Author logs in to Dryad (or creates an account).
+
An overview of the Dryad submission process can be seen in the [http://www.youtube.com/watch?v=RP33cl8tL28 Dryad submission video].
# Author chooses "Deposit Data for a New Publication".
 
# Author is presented with an "Add Publication" page. This page looks similar to the "Edit Publication Details" page from the partner journal process, but all fields may be edited (and are initially blank). ([[Media:SubmissionMockupCreateNewPublication.png]])
 
# Author is presented with a publication page that allows "Edit Publication Details" and "Add Dataset".
 
# Author may edit/expand metadata for the publication.
 
# Author uploads data, providing additional metadata for each data set.
 
# Author may provide IDs of data sets in other repositories.
 
# Author may provide IDs of pre-existing data sets in Dryad.
 
# Author may choose to place data sets under embargo. (Default embargo period lasts until 1 year from the '''publication''' date.
 
# Author chooses to "Publish Datasets".
 
  
== Email Parsing System ==
+
For a journal-oriented view of the process, see [[Submission Integration]].
  
# Email sent to a short perl script (journalEmailGateway.pl), which forwards the contents of the message to a web service.
+
== Technical Documentation ==
# The web service (journal-submit) parses the contents of the email.
 
#* Parsing can be different for each journal, though most journals use the Manuscript Central template created by Tim Vines.
 
#* The parsed content is stored as an XML file in submission/journalMetadata.
 
# When an author follows a link (or enters an equivalent journalID and manuscript number into the submission web form), the submission system will import the relevant XML file to pre-populate metadata for the new submission.
 
  
== Fleshing out metadata with publication information ==
+
Technical documents are available on several topics:
 +
* [[Submission System Technology]]
 +
* [[Submission System Workflow]]
 +
* [[Journal Metadata Processing]]
 +
* [[BagIt_Handshaking|Integration with TreeBASE]]
  
CrossRef has published a [http://oxford.crossref.org/labs/best_practice/rss/rss_best_practice_recommendations.html draft recommendation] for journals to make their tables of contents machine-readable using RSS. If this is accepted by the community, it will greatly ease the process of obtaining complete metadata about articles that have been published.
+
== Design history ==
  
 +
Mockups of submission features:
 +
* [[Submission System Mockups]]
 +
* [[Login-Register Mockup]]
 +
* [[TreeBASE Submission Mockups]]
 +
* [[Repository Handshaking Mockup]]
  
 +
Back-end submission features:
 +
* [[Submission System Updates Phase 3]]
  
[[Category:Work Packages]]
 
 
[[Category:Journals]]
 
[[Category:Journals]]
 +
[[Category:Help]]
 +
[[Category:Features]]

Latest revision as of 11:21, 22 June 2015

Overview

Dryad's submission system allows users to quickly and easily submit data packages. Key features include:

  1. Integration with journals -- allowing authors to automatically fill the Dryad forms with information from the journal's description of an article, and automatically notifying journal editors when a Dryad submission is completed.
  2. Minimal description requirements -- Dryad minimizes the amount of typing/clicking required by submitters. Descriptions are automatically propagated from the article description to descriptions for individual data files. Reasonable defaults are set for the various choices available.
  3. Integration with partner repositories -- allowing submitters to use Dryad information as a starting point for submitting content to another repository.

See also the journal-oriented Submission Integration page.

Instructions

An overview of the Dryad submission process can be seen in the Dryad submission video.

For a journal-oriented view of the process, see Submission Integration.

Technical Documentation

Technical documents are available on several topics:

Design history

Mockups of submission features:

Back-end submission features: