csl-editor icon indicating copy to clipboard operation
csl-editor copied to clipboard

Download doesn't work after changing style name and ID

Open bschilder opened this issue 2 years ago • 8 comments

Hello,

Thanks for creating such a useful resource. However, there seems to be some issues with the visual editor: https://editor.citationstyles.org/searchByName/

1.

I tried to edit the Human Molecular Genetics entry to match their current standards (et-al-min: 10) but the Edit button doesn't seem to do anything. Checked to see if this was a browser issue but same behaviour in both Chrome and Safari (on a Mac). I was able to view the CSL style code here, but the Edit Style button here also does not work. https://editor.citationstyles.org/styleInfo/?styleId=http%3A%2F%2Fwww.zotero.org%2Fstyles%2Fhuman-molecular-genetics

This first issue appears to be related to an issue opened in 2016 #191 Has there been any progress on this?

2.

Next, I tried editing the Database entry: https://editor.citationstyles.org/styleInfo/?styleId=http%3A%2F%2Fwww.zotero.org%2Fstyles%2Fdatabase/

This allowed me to enter the visual editor. However, after I made the desired changes (changed et-al-min to 10, the the name to "Human Molecular genetics corrected") and clicked Style --> Save Style --> Download, nothing happens. I can see from my Chrome console that it's returning a 404 error: "Failed to load resource: the server responded with a status of 404 ()"

I should also note, that I am able to Style --> Save Style --> Download the Database entry if I don't make any edits.

Thank you for your assistance. Please let me know if you need any more information.

Best, Brian

bschilder avatar Sep 20 '21 18:09 bschilder

Thanks -- I'm able to replicate this, and it occurs only after editing the filename. We'll try to look into that.

As a workaround, you can copy the content of the code editor into a text editor of your choice (Notepad++, VS Studio, Atom) and save the style as xyz.csl from there.

adam3smith avatar Sep 20 '21 19:09 adam3smith

Thanks @adam3smith, I downloaded the Human Molecular Genetics (HMG) CSL and made the minor edits described in my first post in VS Code:

<?xml version="1.0" encoding="utf-8"?>
<style xmlns="http://purl.org/net/xbiblio/csl" version="1.0" et-al-min="10" default-locale="en-GB">
  <info>
    <title>Human Molecular Genetics corrected</title>
    <title-short>HMG</title-short>
    <id>http://www.zotero.org/styles/human-molecular-genetics</id>
    <link href="http://www.zotero.org/styles/human-molecular-genetics" rel="self"/>
    <link href="http://www.zotero.org/styles/database" rel="independent-parent"/>
    <link href="http://www.oxfordjournals.org/our_journals/hmg/for_authors/general.html" rel="documentation"/>
    <category citation-format="numeric"/>
    <category field="medicine"/>
    <issn>0964-6906</issn>
    <eissn>1460-2083</eissn>
    <updated>2019-07-28T12:11:09+00:00</updated>
    <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>

However, when I went to go upload this to Paperpile (what I'm ultimately trying to use) it says: "Upload failed. Your style depends on another CSL file. Custom styles must be self-contained."

I don't know whether this is Paperpile-specific or common to many ref managers, but either way it would be nice to have the option of downloading the full file (without needing to depend on other external files).

I'm trying to merge the HMG CSL with the Database CSL manually in VS Code, but don't fully understand how to do this just yet. Do you have any tips for this?

Thanks

bschilder avatar Sep 20 '21 20:09 bschilder

Starting with Database and editing from there seemed to work better. Still, having the option to download the full file would be super helpful.

(merged HMG CSL with corrected: et-al-min="10" et-al-use-first="10") human-molecular-genetics-corrected.csl.txt

I also found this article helpful for understanding what each of the et-al fields are doing.

bschilder avatar Sep 20 '21 20:09 bschilder

@adam3smith how would one go about correcting the existing HMG CSL? Is there somewhere users can submit requests for corrections to be made, or is this something that the admin from the journals themselves must request?

I'm trying to loop in the editors of HMG since anyone who tries to use the current HMG format registered on https://citationstyles.org/ will be later asked by editors to change their reference style to "list a maximum of 10 author names before adding 'et al.'". .

bschilder avatar Sep 21 '21 14:09 bschilder

Anyone can submit style fixes to CSL, no need for the editors to get involved unless there are ambiguities in the author guidelines.

This is just a bit more involved here as it involves:

  1. Deleting the existing dependent style for HMG (I checked & Database still uses 4/3 et al, so should stay as is)
  2. Adding the fixed, now independent style for HMG

Are there any other issues with the style that you have identified? Otherwise it's probably quicker for us to just handle the fix

adam3smith avatar Sep 21 '21 14:09 adam3smith

I think replacing it with an independent style sounds like the right way to go. As far as I can tell, it was just the changes I made above that needed fixing.

Thanks for taking care of this!

bschilder avatar Sep 21 '21 14:09 bschilder

This is now fixed in the repository -- thanks for reporting (you can look at the linked pull request to see what I changed, but as I said, this is a bit more involved if you're not very familiar with git)

adam3smith avatar Sep 22 '21 13:09 adam3smith

@adam3smith excellent, thank you so much for swiftly taking care of this!

bschilder avatar Sep 22 '21 15:09 bschilder