Juris-M / citeproc-js-docs

Documentation for citeproc-js
13 stars 14 forks source link

Could you expand on the date-variable documentation? #14

Open mrenvoize opened 7 years ago

mrenvoize commented 7 years ago

We're trying to ensure we output consistent csl-json from our reading lists solution, and we're struggling to understand how the various elements of the date-variable all fit together.

The json schema is rather loose around it, so doesn't clarify much, and even reading the code in citeproc.js has confused me.

What we're really interested in is some documentation around the expected forms: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html#date-field-type is a good start for explaining the expectations of date-parts and raw (we have mostly got iso standard date strings in raw at the moment).

I'd love to see some detail regarding how 'literal' is used and what format(s) it may expect, along with best practice regarding the circa and season fields, and how it all fits together when some fields are populated and others arent.. what takes precedence for instance if both date-parts and raw are filled in for the same record?

Any hints, tips, directions would be greatly appreciated.