Dataset: This walkthrough is meant to help you understand how to submit your data. It was generated entirely using the same code that is used to generate the doi pages. The explanations for each section are formatted in the same way the section itself will be.

Dataset doi link: https://doi.org/dataset-doi-here. This should only include the dataset doi, as any extra text will be added to the hyperlink, and will cause it to direct to the wrong page. You can include or exclude the leading "https://doi.org[/]" part, but if you include it, everything before the last / will be ignored.

Paper dois:
1: https://doi.org/affiliated-publication1
2: https://doi.org/not-yet-implemented2
3: https://doi.org/every-publication-MUST-be-its-own-line
4: https://doi.org/if-you-do-not-have-any-associated-papers-don't-include-this-file

Authors: Names would go here1,2,3 Listed in the same order as they should appear1,4 The code assumes no repeating names2,5 The affiliations should be numbered as seen in the Authors file below1,6 Affiliation superscripts are added automatically and are shown here to demonstrate the way they are linked1,4,6 You can include orcIDs if you want in this document but it's not fully implemented yet (it will be in the future)6 You can also hyperlink names. This one that directs to the PARADIM home page7
Author affiliations:
1: This is the first author affiliation
2: The numbers are superscripted automatically
3: Please include any additional formatting desired in the individual affiliation
5: The fifth(?) one is to show hyperlinks also work
4: This one was added to show why they need to be in the correct order
6: This 6th one shows superscrips (and subscripts) work here too.

This section covers how the description/abstract is handled, shows examples of files that should be submitted, and outlines how to organize other files submitted. The organization requirements are also available here for the current version, or here for the first version.

The description/abstract will be formatted like this. If you want any special characters (like this one for example: ε) you can include them with the appropriate HTML code. This means you can format superscripts and subscripts, which is especially useful for chemicals and ions (TiO2 or Ti4+). It is suggested that you have this be different from the abstract for any associated publication(s), because this doi and webpage is meant to be specifically for the dataset itself and not any associated publication(s).

The "names.txt" file has a very specific format that should not be broken from. Examples of the "names.txt" files used in the generation of this page are outlined in the hyperlink list below, and the format is outlined in the example pages, but it is important enough to outline again:

  1. Each item needs to be on his own line. This means that a newline character (or the "enter" key) should be between each item and description pair. An example from the first "names.txt" file is:
    1. A blank text file meant to demonstrate how to construct "names.txt", A text file.txt
    2. An empty folder meant to demonstrate how to construct "names.txt" files, An empty folder
    Here, [A blank text file meant to demonstrate how to construct "names.txt"] and [An empty folder meant to demonstrate how to construct "names.txt" files] (without the brackets) are the descriptions for the items "A text file.txt" and "An empty folder", respectively.
  2. Subfolders should be included in the "names.txt" file. They will be zipped for easy downloading, so you don't need to upload it as a zipped folder. If you do upload it as a zipped folder, then you'll need to include the ".zip" extension in the "names.txt" file.
  3. The item descriptions can include superscripts, subscripts, and other various kinds of HTML formatting. Superscripts are accomplished with the formatting <sup>text to superscript</sup> making it appear as text to superscript, while subscripts are accomplished with <sub>text to subscript</sub> making it appear as text to subscript
  4. DO NOT include a period or comma in the item description or file name. If you include a comma, the code will see that line as having more than two comma-separated choices, and won't know which to pick. If you include a period, then there will be difficulty finding the file extension type, and there could be some issue with parsing the file name.

A note if you are looking at the description file linked below: you should not include this line or the lines below it in your description file. If you are reading this on the webpage, don't worry about it, you'll see what I mean when you open the description file and realize there is some special formatting needed for the hyperlinks to work.
Affiliations file
Authors file
Dataset doi file
Description file
Keywords file
License file
Paper doi file
Title file
Names file for Folder 1
Names file for Folder A

Keywords: First keyword, second important keyword, third keyword that matters, this fourth one doesn't really matter, I dare you to click this fifth one
Folder 1
ItemTypeFile
A blank text file meant to demonstrate how to construct "names.txt"txtA text file.txt
An empty folder meant to demonstrate how to construct "names.txt" fileszipped folderAn empty folder.zip
Folder A
ItemTypeFile
The code can differentiate between different file formats if you enter the correct extensiontxtItem a.txt
Folders should be entered without an extension so they can be zippedzipped folderItem a.zip
It does require capitalization to be correct howevertxtitem a.txt