search

citation-style-language / csl-evolution

Central repository for coordinating CSL development
2 stars 2 forks source link

Rename `annote` to `annotation` #32

Closed denismaier closed 4 years ago

denismaier commented 4 years ago

I think "annote" (which doesn't seem to be a word: https://www.merriam-webster.com/dictionary/annote) should be changed to "annotation" (https://www.merriam-webster.com/dictionary/annotation).

Originally posted by @rmzelle in https://github.com/citation-style-language/documentation/pull/73#issuecomment-621596569

Yes, annotation is a much better name for the variable.

But wouldn't that be backwards incompatible, and therefore something for a later version?

On the other hand, I don't know how severe that would be. Changing the styles to use the new variable should be trivial, and GUI applications should just change how they map their own fields to CSL variables. (CSL does not know aliases for variables, right?)

rmzelle commented 4 years ago

But wouldn't that be backwards incompatible, and therefore something for a later version?

Yes.

CSL does not know aliases for variables, right?

Not yet. (and it probably shouldn't)

CSL JSON (https://github.com/citation-style-language/schema/blob/master/csl-data.json) also has found some unexpected uses, so it's not just CSL processors we're concerned with in terms of backwards compatibility.

bwiernik commented 4 years ago

I made a comment in the other thread about problems with annotation. There is potentially a fair amount of meta-analysis data in the wild using annote, so unless aliases are adopted, my preference would be to leave annote as-is.