diff --git a/docs/communities/submit.md b/docs/communities/submit.md index e6f3036..5c009fe 100644 --- a/docs/communities/submit.md +++ b/docs/communities/submit.md @@ -18,7 +18,7 @@ If you are unsure which community to submit to, the table below covers the most See the [CDS Migration page](https://new-cds-project.docs.cern.ch/) for updates on the migration status and timeline. !!! tip "Submitting software to CDS" - + If your software is in a repository on either CERN's internal GitLab instance ([gitlab.cern.ch](https://gitlab.cern.ch)) or on [GitHub.com](https://github.com), you can set up automatic archiving in a few easy steps. See our [guide to GitLab & GitHub repositories](../deposit/repositories.md). diff --git a/docs/deposit/images/bulk-import-authors.png b/docs/deposit/images/bulk-import-authors.png new file mode 100644 index 0000000..f4c5c45 Binary files /dev/null and b/docs/deposit/images/bulk-import-authors.png differ diff --git a/docs/deposit/upload.md b/docs/deposit/upload.md index 74e39cf..9e46c02 100644 --- a/docs/deposit/upload.md +++ b/docs/deposit/upload.md @@ -74,6 +74,69 @@ The following fields are mandatory for each upload: ![Add authors using the autocomplete field](images/deposit-author.jpg){ width="600" } +For large author lists, you can use the **Import from File** option where you can prepare a list in a JSON file and upload them all at once: + +!!! tip + + **Bulk import** lets you quickly add many authors/contributors by uploading a file, but only the details in your file are imported, with no extra information (such as ORCID or affiliations) fetched automatically. + + For best results, use autocomplete for individuals where possible to get richer data, and use bulk import for large groups or when your file already has all the needed information. + +*1. Prepare your file* + +Create a file (for example, `authors.json`) containing all the authors or contributors you want to add. The file should contain a list of people or organizations with their details. + +!!! note "Supported file formats" + + Bulk import currently supports JSON files. Support for additional formats (such as BibTeX) will be added soon. + +- Each entry should include: + - For people: + - `type`: Always `"personal"` + - `family_name`: Last name (required) + - `given_name`: First name (optional) + - `identifiers`: e.g., ORCID (optional) + - For organizations: + - `type`: Always `"organizational"` + - `name`: Name of the organization (required) + - Affiliations can also be included. + +!!! warning "Differences between contributors and authors" + + To add contributors, use a separate JSON file and upload it with the "Upload contributors from file" button. + + **Each contributor entry must also include a `role` field, for example: `"role": "editor"`.** + +Example JSON file: + + [ + { + "person_or_org": { + "type": "personal", + "family_name": "Smith", + "given_name": "Jane", + "identifiers": [ + { "scheme": "orcid", "identifier": "0000-0002-1825-0097" } + ] + }, + "affiliations": [{ "name": "European Organization for Nuclear Research" }] + }, + { + "person_or_org": { + "type": "organizational", + "name": "European Organization for Nuclear Research" + } + } + ] + +*2. Upload the file and review your additions* + +In the Authors/Contributors section of the deposit form, look for the option to import from file. Upload your prepared JSON file. + +![Upload the file](./images/bulk-import-authors.png) + +After import, CDS displays all the entries. You can check, edit, or reorder them before saving. If there are any invalid entries, they are skipped: you’ll see a message so you can fix and re-import if needed. + ## DOIs If you need a DOI, select `No, I need one` and CDS will register a DOI automatically when the record is published. You can also reserve a DOI immediately using the **Get a DOI now!** button.