1 | {
|
2 | "title": "Cite",
|
3 | "@id": "stencila:Cite",
|
4 | "extends": "Entity",
|
5 | "category": "text",
|
6 | "role": "secondary",
|
7 | "status": "unstable",
|
8 | "description": "A reference to a CreativeWork that is cited in another CreativeWork.",
|
9 | "$comment": "A `Cite` node is used within a [`CreativeWork`](./CreativeWork), usually an\n[`Article`](./Article), to refer to an other `CreativeWork`.\nOften a `Cite` will be associated with other citations, in a [`CiteGroup`](./CiteGroup).\n",
|
10 | "properties": {
|
11 | "type": {
|
12 | "@id": "schema:type",
|
13 | "description": "The name of the type.",
|
14 | "type": "string",
|
15 | "enum": [
|
16 | "Cite"
|
17 | ],
|
18 | "default": "Cite",
|
19 | "from": "Entity"
|
20 | },
|
21 | "id": {
|
22 | "@id": "schema:id",
|
23 | "description": "The identifier for this item.",
|
24 | "type": "string",
|
25 | "from": "Entity"
|
26 | },
|
27 | "meta": {
|
28 | "@id": "stencila:meta",
|
29 | "description": "Metadata associated with this item.",
|
30 | "type": "object",
|
31 | "from": "Entity"
|
32 | },
|
33 | "citationMode": {
|
34 | "@id": "stencila:citationMode",
|
35 | "description": "Determines how the citation is shown within the surrounding text.",
|
36 | "type": "string",
|
37 | "enum": [
|
38 | "Parenthetical",
|
39 | "Narrative",
|
40 | "NarrativeAuthor",
|
41 | "NarrativeYear",
|
42 | "normal",
|
43 | "suppressAuthor"
|
44 | ],
|
45 | "default": "parenthetical",
|
46 | "$comment": "There are two main citation modes: parenthetical and narrative (a.k.a textual).\nSee https://apastyle.apa.org/style-grammar-guidelines/citations/basic-principles/parenthetical-versus-narrative\nfor an explanation.\n\nThis property is optional and tools are recommended to assume `parenthetical` if missing.\n\nNarrative citations will usually be of form \"As noted by Smith (1992),\" but `narrative-author`\nallows for \"In the early nineties, Smith noted\" and `narrative-year` allows for \"As noted by Smith in 1992 and 1993\".\n\nPandoc's `CitationMode` enumeration has `Normal` (for `parenthetical`), `AuthorInText` (for `textual`),\nand `SuppressAuthor` (for `textual-year`).\nSee https://github.com/jgm/pandoc-types/blob/0158cd0e2a2ca9d6f14389a1a57bc64cab45a7dd/src/Text/Pandoc/Definition.hs#L353.\n\nLaTeX's `natbib` package has `\\citep{}` (for `parenthetical`), `\\citet{}` (for `textual`),\n`\\citeauthor{}` (for `textual-author`), `\\citeyear{}` (for `textual-year`).\nSee https://www.overleaf.com/learn/latex/Natbib_citation_styles.\n",
|
47 | "from": "Cite"
|
48 | },
|
49 | "citationIntent": {
|
50 | "@id": "stencila:citationIntent",
|
51 | "description": "The type/s of the citation, both factually and rhetorically.",
|
52 | "type": "array",
|
53 | "items": {
|
54 | "$ref": "CitationIntentEnumeration.schema.json"
|
55 | },
|
56 | "from": "Cite",
|
57 | "isArray": true
|
58 | },
|
59 | "content": {
|
60 | "@id": "stencila:content",
|
61 | "description": "Optional structured content/text of this citation.",
|
62 | "type": "array",
|
63 | "items": {
|
64 | "$ref": "InlineContent.schema.json"
|
65 | },
|
66 | "from": "Cite",
|
67 | "isArray": true
|
68 | },
|
69 | "pageStart": {
|
70 | "@id": "schema:pageStart",
|
71 | "description": "The page on which the work starts; for example \"135\" or \"xiii\".",
|
72 | "anyOf": [
|
73 | {
|
74 | "type": "integer"
|
75 | },
|
76 | {
|
77 | "type": "string"
|
78 | }
|
79 | ],
|
80 | "from": "Cite"
|
81 | },
|
82 | "pageEnd": {
|
83 | "@id": "schema:pageEnd",
|
84 | "description": "The page on which the work ends; for example \"138\" or \"xvi\".",
|
85 | "anyOf": [
|
86 | {
|
87 | "type": "integer"
|
88 | },
|
89 | {
|
90 | "type": "string"
|
91 | }
|
92 | ],
|
93 | "from": "Cite"
|
94 | },
|
95 | "pagination": {
|
96 | "@id": "schema:pagination",
|
97 | "description": "Any description of pages that is not separated into pageStart and pageEnd;\nfor example, \"1-6, 9, 55\".\n",
|
98 | "type": "string",
|
99 | "from": "Cite"
|
100 | },
|
101 | "citationPrefix": {
|
102 | "@id": "stencila:citationPrefix",
|
103 | "description": "Text to show before the citation.",
|
104 | "type": "string",
|
105 | "$comment": "Previously this was name `prefix` but for consistency with `citationMode`\nand `honorificPrefix`, to avoid ambiguity with other prefixes was renamed\nto `citationPrefix`.\n",
|
106 | "from": "Cite"
|
107 | },
|
108 | "citationSuffix": {
|
109 | "@id": "stencila:citationSuffix",
|
110 | "description": "Text to show after the citation.",
|
111 | "type": "string",
|
112 | "$comment": "See comment on `citationPrefix` regarding naming.\n",
|
113 | "from": "Cite"
|
114 | },
|
115 | "target": {
|
116 | "@id": "stencila:target",
|
117 | "description": "The target of the citation (URL or reference ID).",
|
118 | "type": "string",
|
119 | "from": "Cite"
|
120 | }
|
121 | },
|
122 | "required": [
|
123 | "type",
|
124 | "target"
|
125 | ],
|
126 | "examples": [
|
127 | {
|
128 | "type": "Article",
|
129 | "title": "An example of using the Cite node type",
|
130 | "authors": [
|
131 | {
|
132 | "type": "Person",
|
133 | "givenNames": [
|
134 | "Joe"
|
135 | ],
|
136 | "familyNames": [
|
137 | "Bloggs"
|
138 | ]
|
139 | }
|
140 | ],
|
141 | "content": [
|
142 | {
|
143 | "type": "Paragraph",
|
144 | "content": [
|
145 | "A citation of ",
|
146 | {
|
147 | "type": "Cite",
|
148 | "target": "some-one-else-1991"
|
149 | },
|
150 | "."
|
151 | ]
|
152 | }
|
153 | ],
|
154 | "references": [
|
155 | {
|
156 | "type": "Article",
|
157 | "id": "some-one-else-1991",
|
158 | "title": "Another article by someone else",
|
159 | "authors": [
|
160 | {
|
161 | "type": "Person",
|
162 | "givenNames": [
|
163 | "Some",
|
164 | "One"
|
165 | ],
|
166 | "familyNames": [
|
167 | "Else"
|
168 | ]
|
169 | }
|
170 | ],
|
171 | "datePublished": "1991"
|
172 | }
|
173 | ]
|
174 | }
|
175 | ],
|
176 | "file": "Cite.schema.yaml",
|
177 | "children": [],
|
178 | "descendants": [],
|
179 | "$schema": "http://json-schema.org/draft-07/schema#",
|
180 | "$id": "https://schema.stenci.la/v1/Cite.schema.json",
|
181 | "source": "https://github.com/stencila/schema/blob/master/schema/Cite.schema.yaml",
|
182 | "type": "object",
|
183 | "additionalProperties": false,
|
184 | "propertyAliases": {}
|
185 | }
|