Skip to content

Commit c032c56

Browse files
docs: update faq
1 parent a944ffb commit c032c56

6 files changed

Lines changed: 153 additions & 32 deletions

File tree

docs/faq.md

Lines changed: 127 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,150 @@
22

33
## Report Numbers and DOIs
44

5-
### What happened to report numbers?
5+
??? question "What happened to report numbers?"
66

7-
A **report number** (also called RN or reference number) is an identifier that was automatically created by the previous version of CDS. Examples include `CERN-TH-2024-001` or `CERN-EP-2024-309`.
7+
A **report number** (also called RN or reference number) is an identifier that was automatically created by the previous version of CDS. Examples include `CERN-TH-2024-001` or `CERN-EP-2024-309`.
88

9-
In the legacy system, report numbers were often automatically added to submitted PDFs. However, they had significant limitations:
9+
In the legacy system, report numbers were often automatically added to submitted PDFs. However, they had significant limitations:
1010

11-
- **Non-unique references**: no mechanism ensured uniqueness, leading to duplicate references
12-
- **Difficult to search**: users couldn't reliably resolve or find records using report numbers
13-
- **Complex maintenance**: custom generation rules for different collaborations made the system complicated
14-
- **No reservation system**: users would guess the next number for PDFs before submission, but the number could change, causing errors
11+
- **Non-unique references**: no mechanism ensured uniqueness, leading to duplicate references
12+
- **Difficult to search**: users couldn't reliably resolve or find records using report numbers
13+
- **Complex maintenance**: custom generation rules for different collaborations made the system complicated
14+
- **No reservation system**: users would guess the next number for PDFs before submission, but the number could change, causing errors
1515

16-
!!! info "Important Change"
16+
!!! info "Important Change"
1717

18-
The new CDS repository **does not automatically generate report numbers**.
18+
The new CDS repository **does not automatically generate report numbers**.
1919

20-
Instead, you can:
20+
Instead, you can:
2121

22-
- Add your own report number(s) in the **Alternate Identifiers** field during submission.
23-
- Use any format your collaboration prefers.
24-
- CDS will ensure uniqueness to prevent duplicates.
25-
- You can re-use the same report number(s) across versions of the record.
22+
- Add your own report number(s) in the **Alternate Identifiers** field during submission.
23+
- Use any format your collaboration prefers.
24+
- CDS will ensure uniqueness to prevent duplicates.
25+
- You can re-use the same report number(s) across versions of the record.
2626

27-
![Report Number Alternative IDs](images/RN_alternate_ids.jpg)
27+
![Report Number Alternative IDs](images/RN_alternate_ids.jpg)
2828

29-
### Use DOIs instead
29+
??? question "Use DOIs instead"
3030

31-
The new CDS repository follows international open science best practices by assigning **DOIs (Digital Object Identifiers)** to all publications.
31+
The new CDS repository follows international open science best practices by assigning **DOIs (Digital Object Identifiers)** to all publications.
3232

33-
- **Prefix:** `10.17181`
34-
- **Registration:** All DOIs are registered with [DataCite](https://datacite.org)
35-
- **Assignment:** Automatic upon publication (or can be reserved in advance)
33+
- **Prefix:** `10.17181`
34+
- **Registration:** All DOIs are registered with [DataCite](https://datacite.org)
35+
- **Assignment:** Automatic upon publication (or can be reserved in advance)
3636

37-
!!! tip "Learn More"
37+
!!! tip "Learn More"
3838

39-
See the [Upload](deposit/upload.md) documentation to learn how to manage DOIs for your uploads.
39+
See the [Upload](deposit/upload.md) documentation to learn how to manage DOIs for your uploads.
4040

41-
### What is a DOI?
41+
??? question "What is a DOI?"
4242

43-
A DOI is a persistent, globally unique identifier for digital objects that:
43+
A DOI is a persistent, globally unique identifier for digital objects that:
4444

45-
- Provides a stable, permanent link to your publication
46-
- Follows the format `https://doi.org/10.xxxx/xxxxx`
47-
- Enables reliable citation and discovery across platforms
48-
- Is recognized worldwide as the standard for scholarly work
45+
- Provides a stable, permanent link to your publication
46+
- Follows the format `https://doi.org/10.xxxx/xxxxx`
47+
- Enables reliable citation and discovery across platforms
48+
- Is recognized worldwide as the standard for scholarly work
4949

50-
## How do I link a CDS publication with the one in arXiv?
50+
## Authors & ORCID
5151

52-
To do
52+
??? question "Why don't contributors appear in the citation?"
5353

54-
## How do I link a CDS publication with the one in INSPIREHep?
54+
Only **Creators** are included in the generated citation. **Contributors** are intentionally excluded — they record people who contributed to the work but should not be credited as authors for citation purposes.
5555

56-
To do
56+
If a person must appear in the citation, add them as a **Creator** instead. You can still assign them a specific role (e.g. Editor) in the creator form.
57+
58+
??? question "Why can't I find an author by ORCID™ iD in the deposit form?"
59+
60+
We update the authors' list periodically, if an author does not appear in the results, their ORCID may not have been imported yet.
61+
62+
In that case, please contact the [CDS support team](https://cern.service-now.com/service-portal?id=service_element&name=CDS-Service).
63+
64+
## Access & Sharing
65+
66+
??? question "How do I allow my colleague to edit my record?"
67+
68+
Click the **Share** button on the deposit form or record page, go to the **People** (or **Groups**) tab, search for the user or group, and set the permission to **Can edit**.
69+
70+
See [Access & Share](deposit/access-share.md) for full details.
71+
72+
??? question "How can I allow a researcher from outside CERN to access my restricted record?"
73+
74+
You can grant access to external collaborators using a **shareable link**. Click the **Share** button on the deposit form or record page, open the **Links** tab, and click **Create a new link**. Choose the appropriate permission level (**Can view** for read-only access) and copy the generated URL to share with the external researcher. No CERN account is required to use the link.
75+
76+
!!! danger "Always set an expiration date"
77+
78+
You **must** set an expiration date when creating shareable links for restricted records. Without an expiration, the link remains valid indefinitely — anyone who obtains it (e.g. through a forwarded email or a shared document) can access the restricted content forever.
79+
80+
Setting an expiration date ensures that access is time-limited and revoked automatically, reducing the risk of unintended long-term exposure of restricted material.
81+
82+
??? question "How do I see older or newer versions of a record?"
83+
84+
All versions of a record are listed in the **Versions** panel on the record page. Click any version to navigate to it directly, or use the **Copy latest version link** button to get a permanent link that always resolves to the most recent version.
85+
86+
![Versions panel on a record page](images/record_versions.png){ width="400" }
87+
88+
## Editing Records
89+
90+
??? question "My upload is 'in review', what can I do?"
91+
92+
When you submit a record to a community, it enters the **in review** state and waits for a community curator to approve or decline it. During this time:
93+
94+
- You can still **edit** the record metadata and files. Go to **My uploads** on your dashboard, open the record, make your changes, and save.
95+
- You can **cancel the review request** if you need to withdraw the submission.
96+
- You can **comment** on the review to communicate with the community curators.
97+
98+
If the record has been waiting for a long time, consider reaching out to the community managers.
99+
100+
See [Review process](review/review.md) for more details.
101+
102+
??? question "Can I edit a record after submitting it for review or after it is published?"
103+
104+
**While under review**, both metadata and files can still be edited. Go to your upload form (accessible from your dashboard under **My uploads**) and save your changes.
105+
106+
**After publication**, metadata can still be edited, but files on a published record cannot be edited. To add or replace files, you must create a new version of the record.
107+
108+
??? question "I made a mistake in my file. How can I replace it after publication?"
109+
110+
Files on a published record **cannot be edited or replaced directly**. To correct a file, you need to **create a new version** of the record:
111+
112+
1. Go to **My uploads** on your dashboard and open the published record.
113+
2. Click **New version**.
114+
3. Upload the corrected file(s).
115+
4. Save and publish the new version.
116+
117+
!!! info "Versioning"
118+
119+
Each version of a record is preserved and remains accessible. The latest version is shown by default, and all previous versions can be accessed from the **Versions** panel on the record page.
120+
121+
See [Published records](deposit/published-records.md) for more details.
122+
123+
## Linking Records
124+
125+
??? question "How do I link a CDS publication with the one in arXiv?"
126+
127+
Edit your record and scroll to the **Related works** (or use find feature ctrl+F to find the field) section of the deposit form. Click **Add related work** and fill in the form with:
128+
129+
| Field | Value |
130+
|-------|-------|
131+
| **Scheme** | *arXiv* |
132+
| **Identifier** | The arXiv ID, e.g. `2301.00001` |
133+
134+
![Adding an arXiv related work](images/add_arxiv_related_id.png)
135+
136+
Save the draft and publish. The arXiv entry will appear under "Related works" on the record page as a clickable link to arXiv.
137+
138+
??? question "How do I link a CDS publication with the one in INSPIRE-HEP?"
139+
140+
Edit your record and scroll to the **Related works** section of the deposit form. Click **Add related work** and fill in the form with:
141+
142+
| Field | Value |
143+
|-------|-------|
144+
| **Scheme** | *Inspire* |
145+
| **Identifier** | The numeric INSPIRE literature ID, e.g. `1234567` |
146+
147+
You can find the INSPIRE literature ID in the URL of the record on [inspirehep.net](https://inspirehep.net): `https://inspirehep.net/literature/<id>`.
148+
149+
![Adding an INSPIRE related work](images/add_inspire_related_id.png)
150+
151+
Save the draft and publish. The INSPIRE entry will appear under "Related works" on the record page as a clickable link to INSPIRE-HEP.
75 KB
Loading
75.1 KB
Loading

docs/images/record_versions.png

42 KB
Loading

docs/stylesheets/extra.css

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,28 @@
8383
.md-nav__item .md-nav__item {
8484
color: #333;
8585
}
86+
87+
/* FAQ collapsible admonitions */
88+
.md-typeset details.question {
89+
border: 1px solid var(--cern-blue) !important;
90+
border-left: 4px solid var(--cern-blue) !important;
91+
border-radius: 0 4px 4px 0;
92+
}
93+
94+
.md-typeset details.question > summary {
95+
color: #333;
96+
font-weight: 600;
97+
background-color: rgba(77, 148, 206, 0.12) !important;
98+
}
99+
100+
.md-typeset details.question > summary::before {
101+
background-color: var(--cern-blue) !important;
102+
}
103+
104+
.md-typeset details[open].question > summary {
105+
color: var(--cern-blue);
106+
}
107+
108+
.md-typeset details.question > summary::after {
109+
background-color: var(--cern-blue) !important;
110+
}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ markdown_extensions:
8383
# Python Markdown
8484
- abbr
8585
- admonition
86+
- pymdownx.details
8687
- attr_list
8788
- def_list
8889
- footnotes

0 commit comments

Comments
 (0)