CSL editor update

CSL Development
21

Thanks, Steve. By the way, I’m always a bit confused about the exact
relationship between the
https://github.com/citation-style-editor/csl-editor and
https://github.com/citation-style-editor/csl-editor-demo-site
repositories, and the live versions at
http://editor.citationstyles.org/ and http://csl.mendeley.com/ . Could
you give a brief explanation? Are there any differences between the
versions at the two domains? And what is the current workflow to
deploy at http://editor.citationstyles.org/ ?

Rintze

22

I know it’s a bit confusing, I’ll try to explain.

The Different Repos

The motivation for having different repos was that different ref-managers
or clients should be able to share common code, but also be able to
customise their instance to work within their own websites or applications.
So we have:

Core Library - https://github.com/citation-style-editor/csl-editor

  • The vast majority of code is here
  • Load and Save style functions not provided, this is up to the specific
    instance to implement
  • All ref-manager instances should use and contribute back to this
  • No reference manager specific code allowed!

Demo Instance

  • The instance hosted by github pages at http://editor.citationstyles.org
  • Contains the Core Library as a git submodule
  • Adds the top navigation bar and /about page
  • Code to load and save styles to disk
  • Script to deploy to github pages
  • Intended to be forked by others and changed completely to suit their needs

Mendeley Instance - http://csl.mendeley.com/about/

  • Forked from the csl-editor-demo-site
  • Contains the Core Library as a git submodule
  • Code to authorise and load/save styles to Mendeley’s web service
  • Ask Carles for more info

Deployment

  1. If you alter the core library
    https://github.com/citation-style-editor/csl-editor, you may need to
    re-convert the schema files and re-generate the example citations. To do
    this, you’ll need node.js and it’s package manager npm installed, and then
    you simply run ./configure.sh
    It takes a good few minutes to generate all the example citations, but
    results of the configure are committed to the repo here:
    https://github.com/citation-style-editor/csl-editor/tree/master/generated so
    you’ll only need to reconfigure if you actually change the schema, or
    anything affecting the example citations.

  2. To re-deploy the demo-site to gh-pages:
    https://github.com/citation-style-editor/csl-editor-demo-site#to-deploy

(you’ll have to be a member of the github organisation to do this:
https://github.com/citation-style-editor - ask myself or Carles if you want
to join)

23

So how about Mendeley taking responsibility for maintaining the repos/projects?

:wink:

24

Hi all,

I ran into an issue the other day with validator.nu, which didn’t
accept the (deprecated) text/x-csl MIME content type of an uploaded
CSL style. (see https://github.com/validator/validator/issues/30 and
https://github.com/zotero/zotero-standalone-build/issues/36)

Dan suggested in 2012 to switch to
"application/vnd.citationstyles.style+xml", and has been using this
content type for the Zotero Style Repository for quite a while now.
Unless there are any objections, I would like to register this content
type at http://www.iana.org/form/media-types, and make it the official
content type for CSL styles.

Somewhat related is this thread,
http://xbiblio-devel.2463403.n2.nabble.com/CSL-editor-update-td7578209.html,
where Dan mentions that Zotero uses
"application/vnd.citationstyles.csl+json" for CSL JSON, which we might
want to register at a later date.

Rintze

25

application/vnd.citationstyles.style+xml is now registered for use
with CSL styles:

http://www.iana.org/assignments/media-types/application/vnd.citationstyles.style+xml

Rintze