-
-
Notifications
You must be signed in to change notification settings - Fork 21
/
release-notes.txt
583 lines (431 loc) · 19.3 KB
/
release-notes.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
CSL 1.0.1 Release Notes
=======================
by `Rintze M. Zelle, PhD <https://twitter.com/rintzezelle>`_
|CCBYSA|_
.. |CCBYSA| image:: /media/cc-by-sa-80x15.png
.. _CCBYSA: http://creativecommons.org/licenses/by-sa/3.0/
.. contents:: **Table of Contents**
Preface
-------
These release notes describe the changes in Citation Style Language (CSL) 1.0.1
as compared to the CSL 1.0 schema and specification (2010-05-30 update). Many of
the new features listed here are described in more detail in the `CSL 1.0.1
specification <specification.html>`_.
With minor exceptions (discussed below), CSL 1.0.1 is a backwards compatible
release, and valid CSL 1.0 styles and locale files will generally validate
against the CSL 1.0.1 schema and work with any CSL 1.0.1-compatible CSL
processor.
Cite Grouping
-------------
Within in-text citations, cites with identical names are sometimes grouped. E.g.
"(Doe 2001, Doe 2004, Smith 2002)" instead of a chronologically ordered "(Doe
2001, Smith 2002, Doe 2004)". We refer to this as "cite grouping". In CSL 1.0,
cite grouping was active when the ``collapse`` attribute on ``cs:citation`` was
used (with ``collapse`` set to "year", the previous example would group and
collapse to "(Doe 2001, 2004, Smith 2002)").
CSL 1.0.1 introduces a new attribute, ``cite-group-delimiter``, which can be
used on ``cs:citation`` to customize the delimiter for cites within cite groups
(the default cite delimiter is specified with ``delimiter`` on ``cs:layout``).
As an added benefit, because cite grouping is now activated whenever the
``cite-group-delimiter`` or ``collapse`` attribute is used, it is now also
possible to group cites without any cite collapsing taking place.
See `Cite Grouping
<specification.html#cite-grouping>`_ in the
CSL 1.0.1 specification.
"dataset" Item Type
-------------------
A new item type, "dataset", is available to describe datasets.
Disambiguation
--------------
The default value of the ``givenname-disambiguation-rule`` attribute has been
changed from "all-names" to "by-cite". The latter is a less aggressive
disambiguation method that is limited to ambiguous cites.
See `Disambiguation
<specification.html#disambiguation>`_ in the
CSL 1.0.1 specification.
Input Data Model
----------------
The `CSL schema <https://github.com/citation-style-language/schema>`_ GitHub
repository now contains a JSON schema describing the CSL input data model
(csl-data.json, and, to describe the citation objects that are embedded in word
processor documents, csl-citation.json). At this point, it is modeled on the
input model used by `citeproc-js
<https://bitbucket.org/fbennett/citeproc-js/wiki/Home>`_. The schemas are not
necessarily complete and are not (yet) normative.
- https://github.com/citation-style-language/schema/blob/master/csl-data.json
- https://github.com/citation-style-language/schema/blob/master/csl-citation.json
Line Spacing
------------
The minimum value for the ``line-spacing`` attribute has been increased to "1".
See `Whitespace <specification.html#whitespace>`_
in the CSL 1.0.1 specification.
Locale Metadata
---------------
Locale files may now include ``cs:info`` as the first child element of the
``cs:locale`` root element. This element may contain one or more
``cs:translator`` child elements, as well as a ``cs:rights`` and ``cs:updated``
child element. ``cs:translator`` can be used to specify the translator of the
locale file, using the same child elements available for ``cs:author`` and
``cs:contributor`` in styles: ``cs:name``, ``cs:email`` and ``cs:uri``. For
example:
.. sourcecode:: xml
<locale>
<info>
<translator>
<name>John Doe</name>
<email>john.doe@domain.com</email>
</translator>
<rights license="http://creativecommons.org/licenses/by-sa/3.0/">This
work is licensed under a Creative Commons Attribution-ShareAlike 3.0
License</rights>
<updated>2011-10-10T23:31:02+00:00</updated>
</info>
...
</locale>
See `Locale Files - Structure
<specification.html#locale-files-structure>`_
in the CSL 1.0.1 specification.
Names
-----
Affixes on ``cs:et-al``
~~~~~~~~~~~~~~~~~~~~~~~
The ``prefix`` and ``suffix`` attributes are no longer available on
``cs:et-al``.
See `Et-al <specification.html#et-al>`_ in
the CSL 1.0.1 specification.
Affixes on Name-parts
~~~~~~~~~~~~~~~~~~~~~
The ``prefix`` and ``suffix`` attributes are now also allowed on
``cs:name-part``, allowing for name formatting like "DOE (Jane)".
See `Name-part Formatting
<specification.html#name-part-formatting>`_
in the CSL 1.0.1 specification.
``cs:name`` Optional
~~~~~~~~~~~~~~~~~~~~
The ``cs:name`` element is no longer a required child element of ``cs:names``.
See `Name <specification.html#name>`_ in the
CSL 1.0.1 specification.
``delimiter-precedes-et-al``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
With CSL 1.0, the "et-al" and "and others" terms were always preceded by a space
when rendered as a result of et-al abbreviation. With the new optional
``delimiter-precedes-et-al`` attribute for ``cs:name``, the name delimiter can
be used instead (e.g. "Doe, et al. 2000" instead of "Doe et al. 2000").
See `Name <specification.html#name>`_ in the
CSL 1.0.1 specification.
``delimiter-precedes-et-al`` and ``delimiter-precedes-last`` - "after-inverted-name"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A new value has been added to the ``delimiter-precedes-et-al`` and
``delimiter-precedes-last`` attributes. With "after-inverted-name", the name
delimiter is only included before the "et-al" or "and" term when the preceding
name has been inverted as a result of the ``name-as-sort-order`` attribute.
E.g.:
::
"Doe, J., and T. Williams"
"Doe, J., S. Smith and T. Williams"
See `Name <specification.html#name>`_ in the
CSL 1.0.1 specification.
Et-al Abbreviation with Last Name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
By using the new ``et-al-use-last`` attribute for ``cs:name``, it is now
possible to use et-al abbreviation and show the last author, as required by the
6th edition of APA Style. An ellipsis, preceded by the name delimiter, separates
the last name from the abbreviated name list, e.g.:
::
A. Goffeau, B. G. Barrell, H. Bussey, R. W. Davis, B. Dujon, H. Feldmann, …
S. G. Oliver
The accompanying new ``names-use-last`` attribute for ``cs:key`` can be used to
override the value of ``et-al-use-last`` for sorting.
See `Name <specification.html#name>`_ and
`Sorting <specification.html#sorting>`_ in
the CSL 1.0.1 specification.
Independent ``names-min`` and ``names-use-first``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The CSL schema now allows the ``names-min`` and ``names-use-first`` attributes
to be set independently on ``cs:key``.
See `Sorting <specification.html#sorting>`_
in the CSL 1.0.1 specification.
Normalizing Initials in "long" Form Names
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The new ``initialize`` attribute for ``cs:name`` can be set to "false" (the
default is "true") to stop ``initialize-with`` from activating name
initializing. In this case, the value of ``initialize-with`` is still appended
to initials already present in the "long" form of names. For example,
.. sourcecode:: xml
<names variable="author">
<name initialize-with=". " initialize="false"/>
</names>
reformats the names "James T Kirk" and "Hunter S. Thompson" to "James T. Kirk"
and "Hunter S. Thompson".
See `Name <specification.html#name>`_ in the
CSL 1.0.1 specification.
Subsequent Author Substitution
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A new attribute for ``cs:bibliography``, ``subsequent-author-substitute-rule``,
gives more options for subsequent author substitution. Whereas previously only
the whole name list could be substituted in case of a complete match, now names
can be substituted on an individual basis, even for incomplete matches for the
name list. For example, it is now possible to obtain bibliographic entries like:
::
Doe, Johnson & Williams. 2001.
--- & Smith. 2002.
Doe, Stevens & Miller. 2003.
---, --- & ---. 2004.
See `Reference Grouping
<specification.html#reference-grouping>`_ in
the CSL 1.0.1 specification.
Numbers
-------
The rules for rendering number variables with ``cs:number`` have changed, as
have the criteria for the "is-numeric" condition. Multiple numbers are now
recognized as such (e.g., "2, 3 & 4"), as are numbers with affixes ("2E").
See `Number <specification.html#number>`_
and `Choose <specification.html#choose>`_ in
the CSL 1.0.1 specification.
Ordinals
--------
Gender-specific Ordinals
~~~~~~~~~~~~~~~~~~~~~~~~
It is now possible to define feminine, masculine and neuter variants of ordinal
suffixes, and specify the gender of the relevant CSL variables representing
nouns. For example, the English "1st" and "first" can now automatically localize
in French to "1er" and "premier" if the target noun is masculine (e.g., "1er
janvier" for "January 1st"), and "1re" and "première" if the noun is feminine
(e.g., "1re édition" for "1st edition").
See `Gender-specific Ordinals
<specification.html#gender-specific-ordinals>`_
in the CSL 1.0.1 specification.
Localization of Ordinals
~~~~~~~~~~~~~~~~~~~~~~~~
To improve support for the localization of ordinals, such as "2nd" and "3rd",
the number of ordinal terms has been expanded, and a ``match`` attribute has
been introduced on ``cs:term``.
In addition, a ``limit-day-ordinals-to-day-1`` attribute has been added for use
on ``cs:style-options``. This localized option can be used to limit day ordinals
to the first day of the month when rendering date variables, as is required for
languages such as French.
See `Ordinal Suffixes
<specification.html#ordinal-suffixes>`_ and
`Locale Options
<specification.html#locale-options>`_ in the
CSL 1.0.1 specification.
Page Range Formats
------------------
Page ranges can now be reformatted in the format used by the Oxford University
Standard for Citation of Legal Authorities (OSCOLA). With ``page-range-format``
set to "minimal-two", page ranges are abbreviated as with "minimal", except that
the second number keeps at least two digits for numbers of 10 and up (e.g.
"1-5", "20-28", "100-16").
Also, an error in the CSL 1.0 specification has been corrected: the "minimal"
page range format was previously mistakenly listed as "minimum".
See `Page Ranges
<specification.html#page-ranges>`_ in the
CSL 1.0.1 specification.
Specification
-------------
The CSL specification has been largely rewritten for improved precision and
clarity. There are several new paragraphs (e.g., `Terminology
<specification.html#terminology>`_ and `File
Types <specification.html#file-types>`_),
and every `CSL variable
<specification.html#appendix-iv-variables>`_
is now accompanied by a short description.
Style Locale in Dependent Styles
--------------------------------
While it was already possible to set the ``default-locale`` attribute on
``cs:style`` in dependent styles, doing so had no effect. Now, when a dependent
style sets a style locale with ``default-locale``, this locale overrides the
style locale of the independent parent style.
See `The Root Element - cs:style
<specification.html#the-root-element-cs-style>`_
in the CSL 1.0.1 specification.
Style Metadata
--------------
eISSN
~~~~~
Previously, the ``cs:issn`` and ``cs:issnl`` elements could already be used to
indicate respectively the different ISSNs for journal-specific styles (e.g. of
the print and online editions), and the journal's ISSN-L. The new optional
``cs:eissn`` element allows the ISSN of the online edition (the eISSN) to be
explictly specified, e.g.:
.. sourcecode:: xml
<info>
<title>Applied and Environmental Microbiology</title>
<issn>0099-2240</issn>
<eissn>1098-5336</eissn>
</info>
See `Info <specification.html#info>`_ in the
CSL 1.0.1 specification.
License
~~~~~~~
The ``cs:rights`` element may now carry a ``license`` attribute to indicate the
URI of the style license, e.g.:
.. sourcecode:: xml
<info>
<rights license="http://creativecommons.org/licenses/by-sa/3.0/">This work
is licensed under a Creative Commons Attribution-ShareAlike 3.0
License</rights>
</info>
See `Info <specification.html#info>`_ in the
CSL 1.0.1 specification.
Short Title
~~~~~~~~~~~
The new optional ``cs:title-short`` element can be used to give a shortened
style title, e.g.:
.. sourcecode:: xml
<info>
<title>Proceedings of the National Academy of Sciences</title>
<title-short>PNAS</title-short>
</info>
See `Info <specification.html#info>`_ in the
CSL 1.0.1 specification.
Terms
-----
New Terms: "available at", "scale", and "version"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Three new terms in the "miscellaneous" category are now available: "available
at", "scale" (accompanying the new "scale" variable), and "version".
See `Appendix II - Terms
<specification.html#appendix-ii-terms>`_ in
the CSL 1.0.1 specification.
New Terms: "ordinal", "ordinal-00", and "ordinal-05" through "ordinal-99"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The terms "ordinal", "ordinal-00", and "ordinal-05" through "ordinal-99" are now
available to improve the `localization of ordinals`_.
See `Appendix II - Terms
<specification.html#appendix-ii-terms>`_ in
the CSL 1.0.1 specification.
New Term: "page-range-delimiter"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The new term "page-range-delimiter" makes it possible to customize (and
localize) the delimiter used for page ranges. The delimiter is only used when
the ``page-range-format`` attribute is set. As this term did not exist in CSL
1.0 and will be absent from CSL 1.0 locale files, it defaults to an en-dash if
not defined.
See `Page Ranges
<specification.html#page-ranges>`_ in the
CSL 1.0.1 specification.
Retired Terms: "field" Categories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
CSL 1.0 locale files contained terms for all the field categories (the values of
the ``field`` attribute on ``cs:category``). While potentially useful (e.g. for
localizing a style browsing UI), they have been removed to make the locale files
more compact.
Text Case
---------
The specification now describes how sentence and title case conversions work
(which are selected with the ``text-case`` attribute). Title casing is now
limited to items that can be assumed to be English.
In addition, the ``text-case`` attribute can now also be used on ``cs:date``.
This allows dates to be formatted as "April 2002" and "24 april 2002", where the
month is only capitalized in the absence of a preceding day.
See `Text-case
<specification.html#text-case>`_ in the CSL
1.0.1 specification.
Validation
----------
The schema has become slightly stricter when it comes to style validation. While
this causes some backward incompatibility, the additional validation only
concerns attributes that had no logical use in CSL 1.0 styles, and shouldn't
affect any CSL 1.0 styles obtained from the `official CSL style repository
<https://github.com/citation-style-language/styles>`_.
No "verb" and "verb-short" Forms on Standalone ``cs:label``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is no longer allowed to set the ``form`` attribute to "verb" or "verb-short"
on standalone ``cs:label`` elements (these values are still allowed if
``cs:label`` is a child element of ``cs:names``).
See `Label <specification.html#label>`_ in
the CSL 1.0.1 specification.
Tests for conditions on ``cs:if`` and ``cs:else-if``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
While the specification already required ``cs:if`` and ``cs:else-if`` to carry
at least one condition attribute, the CSL schema also validated cases where no
conditions were specified. This has been corrected.
See `Choose <specification.html#choose>`_ in
the CSL 1.0.1 specification.
Variables
---------
More Number Variables
~~~~~~~~~~~~~~~~~~~~~
The CSL variables "chapter-number", "collection-number" and "number-of-pages",
which previously were standard variables, have now become number variables. As a
result, they can now be rendered through either ``cs:number`` or ``cs:text``.
See `Number Variables
<specification.html#number-variables>`_ in
the CSL 1.0.1 specification.
New Variables: "container-title-short" and "title-short"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Previously, "title" and "container-title" abbreviations were only accessible
through the "short" forms of these variables. As a result, it was impossible to
specifically test whether an abbreviation existed (``<if variable="title"/>``
tests "true" whether a "long" or "short" form of "title" exists).
Now, these abbreviations can also be accessed through the dedicated
"title-short" and "container-title-short" variables. For example,
.. sourcecode:: xml
<choose>
<if variable="title-short">
<group delimiter=" ">
<text variable="title-short"/>
<text variable="title" prefix="(" suffix=")"/>
</group>
</if>
<else>
<text variable="title"/>
</else>
</choose>
would give title listings like:
::
The Hobbit (The Hobbit, or There and Back Again)
Lord of the Rings
Free Culture (Free Culture: The Nature and Future of Creativity)
See `Standard Variables
<specification.html#standard-variables>`_ in
the CSL 1.0.1 specification.
New Variables: "dimensions", "director", "illustrator", "ISSN", "PMCID", "PMID", "scale", and "source"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New CSL variables have been introduced:
- "dimensions" - for physical (e.g., size of an object) or temporal (e.g., the
running time of a movie) dimensions
- "director" - name variable for directors of e.g. films
- "illustrator" - name variable for illustrators of e.g. comics or children's
books
- "ISSN" - International Standard Serial Number
- "PMCID" - PubMed Central reference number
- "PMID" - PubMed reference number
- "scale" - scale of e.g. a map
- "source" - origin of the item (e.g., a library catalog or database)
See `Standard Variables
<specification.html#standard-variables>`_
and `Name Variables
<specification.html#name-variables>`_ in the
CSL 1.0.1 specification.
New Variables: "reviewed-author" and "reviewed-title"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A new name variable, "reviewed-author", and a new standard variable,
"reviewed-title", have been introduced for (basic) support of reviews (e.g.,
book reviews). These variables should be made available on the
"article-magazine", "article-newspaper", and "article-journal" item types.
"sub verbo" Locator Type
~~~~~~~~~~~~~~~~~~~~~~~~
CSL 1.0 contained a bug: it was impossible to test for the "sub verbo" locator
type, because the value of the "locator" attribute is read as a list, and "sub
verbo" is read as "sub" and "verbo". To circumvent this limitation, "sub-verbo"
can now be used as a test value (the "sub verbo" term and input field remain
unchanged). An example:
.. sourcecode:: xml
<choose>
<if locator="page sub-verbo" match="any">
...
</if>
</choose>
See `Choose <specification.html#choose>`_ in
the CSL 1.0.1 specification.
Using ``cs:label`` with Number Variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``cs:label`` element, which previously could only be used for the "locator"
and "page" variables (and name variables, when used as a child element of
``cs:names``), can now be used with any number variable.
See `Label <specification.html#label>`_ and
`Number Variables
<specification.html#number-variables>`_ in
the CSL 1.0.1 specification.