You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-82Lines changed: 1 addition & 82 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ and currently consists of the following files:
45
45
To render citations and bibliographies, CSL processors not only require CSL style and locale files, but also bibliographic metadata.
46
46
The citeproc-js CSL processor [introduced](http://gsl-nagoya-u.net/http/pub/citeproc-doc.html#data-input) a JSON format to store such metadata,
47
47
and this format has since been adopted by various other software products.
48
-
The format, also known as "citeproc-JSON", has been codified in the CSL-JSON Schema.
48
+
The format, also known as "citeproc-JSON", has been codified in the CSL-JSON Schema. This same schema van be used to validate YAML.
49
49
50
50
**At this point the CSL-JSON schema is not yet fully normative, and care must be taken to ensure compatibility with other tools built around CSL-JSON.**
51
51
@@ -54,87 +54,6 @@ Whereas `csl-data.json` describes how the metadata of bibliographic items can be
54
54
This includes information such as the order in which items are cited,
55
55
which items are cited together in a single citation, etc.
56
56
57
-
### Mendeley CSL-JSON
58
-
59
-
Mendeley provided the following documentation on their use of CSL-JSON:
60
-
61
-
Support for the CSL Embedded Citation Object format is available in Mendeley Desktop 1.0 and later.
62
-
63
-
The CSL citation data object consists of:
64
-
65
-
* a required "schema" element of type "string", set to the URI of the schema
66
-
* a required "citationID" element of type "string" or "number", set to ???
67
-
* a "citationItems" element of type "array", containing "objects" with the data of the individual cites.
68
-
The individual cite object are structured as:
69
-
+ a required "id" element of type "string" or "number", set to an unique cite ID
70
-
+ a "itemData" element of type "object", described in `csl-data.json/#/items` ,
71
-
containing the metadata of a single bibliographic item
72
-
(this object is returned in citeproc-js by `sys.retrieveItem()` )
73
-
+ an "uris" element of type "array", which can contain any number of URIs (of type "string") to the bibliographic item
74
-
+ a "prefix" element of type "string"
75
-
+ a "suffix" element of type "string"
76
-
+ a "locator" element of type "string"
77
-
+ a "label" element of type "string", set to one of the CSL locator types (see <https://docs.citationstyles.org/en/1.0.1/specification.html#locators>)
78
-
+ a "suppress-author" element of type "string", "boolean" or "number"
79
-
+ a "author-only" element of type "string", "boolean" or "number"
80
-
* a "properties" element of type "object" containing:
81
-
+ a "noteIndex" element of type "number", set to the index of the footnote or endnote
82
-
* (Mendeley-specific) a "mendeley" element of type "object" containing:
83
-
+ a "previouslyFormattedCitation" element of type "string",
84
-
set to the rendered output of the cite of the previous rendering round
85
-
(this can be used to determine if the user manually altered the output)
86
-
+ a "manualFormatting" element of type "string",
87
-
set to the user-customized output of the cite (this output will be used in favor of the generated output)
88
-
89
-
The method to embed metadata for citations and bibliographies typically varies between word processors.
90
-
Currently Mendeley uses:
91
-
92
-
* For Word for Windows:
93
-
in-text citations and bibliographies are represented by a field code of type `wdFieldAddin` or temporarily represented as a bookmark if exporting to OpenOffice.
94
-
95
-
* For OpenOffice:
96
-
in-text citations are of type `com.sun.star.text.ReferenceMark`.
97
-
Bibliographies are of type `com.sun.star.text.TextSection` or temporarily represented as a bookmark if exporting to Word.
98
-
99
-
An example of an embedded citation object from Mendeley:
0 commit comments