This page is for the most current version of the submission protocols. For the legacy version, click here. For a supplemental walkthrough, click here.

The title for the dataset would go here. Most people have this be the title of the article the data belongs to, but it can be anything. We can do subscript and superscript formats and can include many special characters. Please include a "title.txt" document with the title pre-formatted in html format for automated creation of the webpage. We will add "Dataset: " to the start of the title.

Click me! I'm where the hyperlink for the dataset doi would be. Please include a file "dataset-doi.txt" with the doi for the dataset without the leading "https://doi.org/" (e.g. 10.34863/6d5f-aj24 instead of https://doi.org/10.34863/6d5f-aj24). This is optional, but a good idea to include.

Click me too! I'm where the hyperlink(s) for the dois of any associated publications would be. Please include a file "paper-doi.txt" with the doi(s) for the associated publication(s) without the leading "https://doi.org/" (e.g. 10.34863/6d5f-aj24 instead of https://doi.org/10.34863/6d5f-aj24). This is optional, but a good idea to include.

The list of authors would go here. This list will be pulled from an "authors.txt" file. Please include the author list in the following format with each author on their own line in the file:
first author name, [first author affiliation 1, first author affiliation 2, ...], first author ORCID iD
second author name, [second author affiliation 1, second author affiliation 2, ...], second author ORCID iD
The author affiliations will go here. It's pulled from "affiliations.txt", which should be formatted in the following way with each entry in its own line in the file:
1: Affiliation 1 information
2: Affiliation 2 information

The dataset description would go here. Please do not reuse the abstract from the paper because this description should be for the specific dataset itself. It will be pulled from "description.txt" and can be formatted using HTML formatting, which is broadly used, so any questions are likely answered by a quick internet search.

We allow you to pick what the headers and item names in the table will be by following a set format:
1. The 3 column span names will be the names of each folder you submit. In this example the folders are named "Folder 1" and "Folder 2" but you can use this to separate files by figure, data type, etc.
2. Any subfolders present will be zipped and labeled as a zipped folder. You can pre-zip the subfolders if you want.
3. Include a file in EACH folder named "names.txt" which needs to follow a set format outlined later. Examples are also included below.

Format of the names file "names.txt":
1. Each item should be on its own line with the following format as a comma separated list: item description, item-name.extension
2. Please include subfolders in the "names.txt" file, as they will be zipped and treated as files (you shouldn't include the .zip part in the file unless you upload them zipped).
3. The item names should be in html format which supports superscript, subscript, and special characters. If you aren't sure how to do this, <--sup--> (without the dashes) goes before the superscript text with <--/sup--> (also without the dashes) going after the superscript text, subscripts are the same, but replace "sup" with "sub". Special characters can be looked up online by typing "html [character name]". You only need to do this formatting if you want a name to be formatted a specific way in the table.
4. Do not include a comma or a period in the first column.

Failure to follow this format for your data may result in a delay in the data being available, incorrect labeling and assignment of data, or may require it to be manually entered in.

An example table is shown below. "names.txt" is included in the table so you can download it and see how it should be formatted. You will note that "names.txt" is different in each folder since they link to different files in different folders.
Here is the folder structure of how the data is stored so you can understand what you need to submit:
Folder for your doi (made by us, so don't worry)
--Folder 1
----A subfolder
------Thing in subfolder.txt
----A file.txt
----names.txt
--Folder 2
----A pre-zipped subfolder.zip
----Another file.txt
----names.txt
--affiliations.txt
--authors.txt
--description.txt
--title.txt
--dataset-doi.txt (optional)
--paper-doi.txt (optional)
--keywords.txt (optional)


Note: Folders 1 and 2, as well as the various .txt documents, should all be what you give to us. Within EACH folder should be a names.txt file
This is where any keywords in the keywords file will be listed. Please format it as a comma separated list. An example is given in the walkthrough.
Folder 1
ItemTypeFile
Important folder with many fileszipped folderA subfolder.zip
Name I want for the file with subscript superscript or special characterstxtA file.txt
For completeness I include this file but you should not list it heretxtnames.txt
Folder 2
ItemTypeFile
Another folder with many files that was uploaded pre-zippedtxtA pre-zipped subfolder.zip
Some clever nametxtAnother file.txt
For completeness I include this file but you should not list it heretxtnames.txt