Skip to content

Commit 4a6b273

Browse files
authored
How to cite a dataset? (#216)
* How to cite a dataset? Add description on how the citation works and how to customize it. * How to cite a dataset? Example with additional. * Update source/user-guide/associating-resources/cite.rst * Update cite.rst
1 parent 94f4e50 commit 4a6b273

File tree

5 files changed

+65
-2
lines changed

5 files changed

+65
-2
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
.. _cite:
2+
3+
Cite a resource
4+
###############
5+
6+
The catalogue can provide an automatic citation based on information provided in the metadata record.
7+
8+
.. figure:: img/citation.png
9+
10+
The citation can be use to cite a dataset in publications.
11+
12+
13+
Citation text
14+
-------------
15+
16+
The citation generated by default follows general conventions on how to cite a dataset but can be customized.
17+
18+
The default is:
19+
* list of authors (and organisation)
20+
* publication year
21+
* title
22+
* list of publisher
23+
* DOI URL or landing page URL.
24+
25+
These are the data needed to create DOI (see :ref:`doi`).
26+
27+
Customization of the citation can be done in :code:`schemas/iso19115-3.2018/src/main/plugin/iso19115-3.2018/formatter/citation/common.xsl`.
28+
29+
An additional text may be stored in an online resource description with protocol ``WWW:LINK-1.0-http--publication-URL``.
30+
31+
.. figure:: img/citation-with-addition.png
32+
33+
Example: https://doi.org/10.12770/ad07a55f-5de7-4abc-ba89-8899b16c4b59
34+
35+
Configuration
36+
-------------
37+
38+
The citation can be displayed or not in the record view.
39+
Check the user interface configuration to customize it:
40+
41+
.. figure:: img/citation-ui-config.png
42+
43+
44+
Format
45+
------
46+
47+
Citation can be provided in various formats:
48+
49+
* HTML
50+
* Plain text
51+
* RIS
52+
* BibTex
53+
54+
API
55+
---
56+
57+
The citation can be displayed in the default XSL formatter used for the full view using: http://localhost:8080/geonetwork/srv/api/records/a46af25c-f949-48a2-9b7e-ac472230cda8?language=all&citation=true
58+
59+
60+
The formatter producing the citation can be accessed directly using: http://localhost:8080/geonetwork/srv/api/records/31255efc-c5c1-7787-2ae6-b8fc4bcd6e55/formatters/citation?format=ris
61+
62+
To list available formats use: http://localhost:8080/geonetwork/srv/api/records/31255efc-c5c1-7787-2ae6-b8fc4bcd6e55/formatters/citation?format=?
Loading
Loading
Loading

source/user-guide/associating-resources/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
Associating resources
44
#####################
55

6-
You can associate a record with different types of resources using the **Associated resources** panel.
6+
You can associate a record with different types of resources using the **Associated resources** panel.
77
This topic describes how to associate resources.
88

99

1010
- To add or edit associated resources, open the editor, and click Associate Resources to view the wizard panel.
1111

1212
.. figure:: img/onlinesrc.png
1313

14-
Use the wizard panel to create or delete associated resources.
14+
Use the wizard panel to create or delete associated resources.
1515
A list of currently attached resources grouped by types is also provided.
1616

1717
- To add a new online resource, click on the top + caret.
@@ -27,3 +27,4 @@ You can associate different types of resources:
2727
linking-documents.rst
2828
linking-records.rst
2929
doi.rst
30+
cite.rst

0 commit comments

Comments
 (0)