Skip to content

Conversation

KoichiM0
Copy link

Creation of the CSL for the "Japan Journal of Stuttering and Other Fluency Disorders," a journal in Japanese and English. Validated with 1.0.2 strict, with an error with the variable "author-yomi" (appearing on three lines), which is required for sorting bibliography in Japanese, and should be overridden when registering in Zotero.

CSL for the Japan Journal of Stuttering and Other Fluency Disorders, a journal in Japanese and English. Validated with 1.0.2 strict, with an error of unknown variable "author-yomi" (appearing on three lines) that is required for sorting bibliography in Japanese, and should be overridden when registering in Zotero.
Copy link

Awesome! You just created a pull request to the Citation Styles Language styles repository. One of our human volunteers will try to get in touch soon (usually within a week). In the meantime, I will run some automated checks. You should be notified of the results in a few minutes.

If you haven't done so yet, please make sure your style validates and follows all our other Style Requirements.

To update this pull request, visit the "Files changed" tab above, click on the ellipsis button in the top-right corner of your style, and then select "Edit file" to start editing:

If you have any questions, please leave a comment and we'll get back to you. While we usually respond in English, feel free to write in whatever language you're most comfortable.

Copy link

😟 There are some issues with your submission.

2 tests failed

japan-journal-of-stuttering-and-other-fluency-disorders: must validate against the CSL 1.0.1 schema
Please check your style at http://validator.citationstyles.org/

expected `[[10, "10:0: ERROR: Element link failed to validate attributes"], [0, "ERROR: Extra element link in i...RROR: Did not expect element locale there"], [2, "2:0: ERROR: Expecting element locale, got style"]].empty?` to be truthy, got false

japan-journal-of-stuttering-and-other-fluency-disorders: may not have any unused macros

expected: []
     got: ["accessed", "event", "issued-citation"]

(compared using ==)

Please check the test report for details.

Copy link

😟 There are some issues with your submission.

2 tests failed

japan-journal-of-stuttering-and-other-fluency-disorders: must validate against the CSL 1.0.1 schema
Please check your style at http://validator.citationstyles.org/

expected `[[10, "10:0: ERROR: Element link failed to validate attributes"], [0, "ERROR: Extra element link in i...RROR: Did not expect element locale there"], [2, "2:0: ERROR: Expecting element locale, got style"]].empty?` to be truthy, got false

japan-journal-of-stuttering-and-other-fluency-disorders: may not have any unused macros

expected: []
     got: ["issued-year"]

(compared using ==)

Please check the test report for details.

Another unused macro deleted. "xml.lang" removed from <title> and parenthesized Japanese added to the title.
Copy link

😟 There are some issues with your submission.

1 test failed

japan-journal-of-stuttering-and-other-fluency-disorders: must validate against the CSL 1.0.1 schema
Please check your style at http://validator.citationstyles.org/

expected `[[10, "10:0: ERROR: Element link failed to validate attributes"], [0, "ERROR: Extra element link in i...RROR: Did not expect element locale there"], [2, "2:0: ERROR: Expecting element locale, got style"]].empty?` to be truthy, got false

Please check the test report for details.

@KoichiM0
Copy link
Author

I need help. I cannot understand the error message (lines 16 and 17). Where in the CSL it refers to? How should the CSL be changed? The CSL passes the validation test of 1.0.2 strict except one variable "author-yomi", which cannot be resolved because it is essential to the style I want to realize. (Validation with 1.0.1 generates more errors with some more variables that are validated by 1.0.2.) But the error message seems to me unrelated to those variable and pointing to something else. Can someone help me?

CSL for the Japan Journal of Stuttering and Other Fluency Disorders, a journal in Japanese and English. Validated with 1.0.2 strict, with an error of unknown variable "author-yomi" (appearing on three lines) that is required for sorting bibliography in Japanese, and should be overridden when registering in Zotero.
Another unused macro deleted. "xml.lang" removed from <title> and parenthesized Japanese added to the title.
Copy link

😟 There are some issues with your submission.

1 test failed

japan-journal-of-stuttering-and-other-fluency-disorders: must validate against the CSL 1.0.1 schema
Please check your style at http://validator.citationstyles.org/

expected `[[10, "10:0: ERROR: Element link failed to validate attributes"], [0, "ERROR: Extra element link in i...RROR: Did not expect element locale there"], [2, "2:0: ERROR: Expecting element locale, got style"]].empty?` to be truthy, got false

Please check the test report for details.

@bwiernik
Copy link
Member

bwiernik commented Aug 26, 2025

Thank you for your submission. We can only accept styles that validate against the CSL schema, and it is not possible to create a variable that is not part of the schema like author-yomi.

Could you explain what the "author-yomi" behavior is supposed to be?

Note that Zotero's citation processor, citeproc-js, was written by a Japanese legal scholar and was specifically designed to handle complexities of Japanese formatting, so I'm not sure any special handling of author name ordering is needed. Can you explain what is incorrect when you simply using the author variable?

@github-actions github-actions bot added the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Aug 26, 2025
@bwiernik
Copy link
Member

bwiernik commented Sep 1, 2025

@KoichiM0 could you answer the questions above?

@KoichiM0
Copy link
Author

KoichiM0 commented Sep 2, 2025

Thank you for your question. In order to sort bibliography including Japanese papers in accordance to the sort rules that the journal JJSFD requires, "author-yomi" is necessary. Because the journal requires sorting Japanese papers in the alphabetical order of author names that should be transliterated in alphabet (or romanized) just for the sorting purpose. Since transliteration of Japanese names can't be uniquely defined (one to multiple correspondence), transliteration must be provided manually and that should be used for sorting. I can't improvise any way around this issue without setting up an extra field as "author-yome". This is why the validation fails against the CSL scheme 1.0.2 strict. I wish I could find a way to solve this transliteration and sort issue without violating the scheme, but I can't. Is there any method that allows entry of transliteration and validates? Thank you for your attention.

Thank you for your submission. We can only accept styles that validate against the CSL schema, and it is not possible to create a variable that is not part of the schema like author-yomi.

Could you explain what the "author-yomi" behavior is supposed to be?

Note that Zotero's citation processor, citeproc-js, was written by a Japanese legal scholar and was specifically designed to handle complexities of Japanese formatting, so I'm not sure any special handling of author name ordering is needed. Can you explain what is incorrect when you simply using the author variable?

@github-actions github-actions bot removed the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Sep 2, 2025
@KoichiM0
Copy link
Author

KoichiM0 commented Sep 2, 2025

Additionally, it is rather common to sort alphabetically in scientific journals published in Japan, though most other journals requires numbered citations in the order of appearances. Perhaps legal documents may use the numbered references. If you do not specify how to read Japanese names, which are usually written in ideograms (Kanji), the order of bibliography becomes that of the character codes, which does not sort Japanese names correctly even in the Japanese alphabet (Kana, or Japanese phonogram).

@bwiernik
Copy link
Member

bwiernik commented Sep 2, 2025

citeproc-js includes functionality to transliterate Japanese text using Hepburn romanization. This is applied for titles, but I'm not sure if it is used for names.

Can you give a specific example of how names are sorted when you actually sort on author with Zotero and what the correct sort order should be?

In any event, we cannot accept a citation style in the repository that does not pass validation.

@github-actions github-actions bot added the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Sep 2, 2025
@bwiernik
Copy link
Member

bwiernik commented Sep 2, 2025

Tagging @fbennett in case you are available and have any insight

@KoichiM0
Copy link
Author

KoichiM0 commented Sep 3, 2025

Transliteration cannot be uniquely (or mechanically) determined for Japanese names. For instance, the same "角田" could be read either as "Kakuta" or "Tsunoda", depending on the person (or family) you are referring to. Transliteration of titles may be easier if you have a large dictionary. However, this again cannot be fully automated because some ideograms (Kanji) are read differently depending on the context.

I appreciate the better handling of Japanese names than other commercial bibliography database, especially the special treatment (or non-treatment) of initials (Japanese use full given names instead of initials). However, there still remains the problem of how to read and sort.

Here is what the sort order in the bibliography looks like if transliterated names are NOT used. Zotero most likely resort to the character codes when it sort Japanese names. It works just fine with English names, but not Japanese names written in the native forms. The order looks rather random to those who can read Japanese (the citations are from a paper written in Japanese, discarding English citations and tltles etc.):
伊藤絵美 (2021).
原由紀, 小林宏明, 坂田善政, 前新直志, 餅田亜希子, 村瀬忍, 安田菜穂 (2009).
坂田菩致 (2003).
坂野雄二, 東條光彦 (1986).
富里周太, 矢田康人, 白石紗衣, 和佐野浩一郎 (2020).
小澤恵美, 原由紀, 鈴木夏枝, 森山晴之, 大橋由紀江, 餅田亜希子, 坂田善政, et al. (2016).
嶋大樹, 川井智理, 柳原茉美佳, 熊野宏昭 (2016).
嶋大樹, 柳原茉美佳, 川井智理, 熊野宏昭 (2013).
川合紀宗 (2010).
朝倉聡, 井上誠士郎, 佐々木史, 佐々木幸哉, 北川信樹, 井上猛, 傳田健三, et al. (2002).
松崎朝樹 (2013).
森浩一 (2017).
清水秀美, 今栄国晴 (1981).
熊野宏昭 (2012).
角田航平, 坂田善政, 北條具仁, 酒井奈緒美, 森浩一 (2017).
酒井奈緒美, チュウシンイン, 森浩一, 餅田亜希子, 北條具仁, 坂田善政 (2014).
阿栄娜, 酒井奈緒美, 安啓一, 森浩一 (2018).
阿栄娜, 酒井奈緒美, 森浩一 (2015).

Below is the list of the same bibliography in the (correct) alphabetic order of transliterated author names, with the citation style with "author-yomi" added:
阿栄娜, 酒井奈緒美, 森浩一 (2015).
阿栄娜, 酒井奈緒美, 安啓一, 森浩一 (2018).
朝倉聡, 井上誠士郎, 佐々木史, 佐々木幸哉, 北川信樹, 井上猛, 傳田健三, et al. (2002).
原由紀, 小林宏明, 坂田善政, 前新直志, 餅田亜希子, 村瀬忍, 安田菜穂 (2009).
伊藤絵美 (2021).
角田航平, 坂田善政, 北條具仁, 酒井奈緒美, 森浩一 (2017).
川合紀宗 (2010).
熊野宏昭 (2012).
松崎朝樹 (2013).
森浩一 (2017).
小澤恵美, 原由紀, 鈴木夏枝, 森山晴之, 大橋由紀江, 餅田亜希子, 坂田善政, et al. (2016).
酒井奈緒美, チュウシンイン, 森浩一, 餅田亜希子, 北條具仁, 坂田善政 (2014).
坂野雄二, 東條光彦 (1986).
坂田菩致 (2003).
嶋大樹, 川井智理, 柳原茉美佳, 熊野宏昭 (2016).
嶋大樹, 柳原茉美佳, 川井智理, 熊野宏昭 (2013).
清水秀美, 今栄国晴 (1981).
富里周太, 矢田康人, 白石紗衣, 和佐野浩一郎 (2020).

I'm hoping that Zotero (or CSL) would officially provides a field to store transliterated names.
Perhaps an extension could be created that would sort the bibliography by reading the author-yomi field in the Extra, thus exempting the CSL from the necessity of reading author-yomi. But I am not capable of writing an extension.

@github-actions github-actions bot removed the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Sep 3, 2025
@bwiernik
Copy link
Member

bwiernik commented Sep 3, 2025

CSL 1.0.2 does not currently support any special treatment of transliterated names. This is something we could consider for a future version, but it is not available now.

You could look into the Jurism fork of Zotero and whether the added functionality for transliteration fits your needs, but not that this software is not actively maintained any longer. https://juris-m.readthedocs.io/en/latest/

For the time being, for this style to be included in the repository, you would need to remove the author-yomi variable.

You are of course welcome to host a style that doesn't strictly validate against CSL 1.0.2 on your own website.

@github-actions github-actions bot added the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Sep 3, 2025
@fbennett
Copy link
Member

fbennett commented Sep 3, 2025 via email

@github-actions github-actions bot removed the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Sep 3, 2025
@bwiernik
Copy link
Member

bwiernik commented Sep 3, 2025

Fantastic to hear from you @fbennett

@github-actions github-actions bot added the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Sep 3, 2025
@KoichiM0
Copy link
Author

KoichiM0 commented Sep 4, 2025

Thank you for the additional input, @fbennett. Juris-M surely seams to have everything that is needed for multilingual citation. However, after I tried Juris-M v.6.0.22 (current release) for the mac for a few hours, I have to say that it is unusable at this point because it incorrectly switches the first and last names of Japanese authors when the data are imported from J-Stage archive through Jurism Connector 6.0.30.1 installed in Brave browser (Chrome lookalike). And there is no "Add by Identifier..." import menu as available in Zotero. Also worrisome is the compatibility of the online database between Zotero and Juris-M if one wants to share it.
Now, back to Zotero7 I'm thinking of forging an existing validated variable, hopefully infrequently used, to assume the proxy role of holding transliterated creator names.

@github-actions github-actions bot removed the waiting-for-response-from-contributor The ticket/pull request is awaiting input from the contributor/depositor label Sep 4, 2025
@fbennett
Copy link
Member

fbennett commented Sep 4, 2025 via email

"author-yomi", which cannot be validated, is replaced by original-author. This may cause a conflict with the native ussage of the variable original-author, but it is expected to be very infrequent. However, the user should be warned about it. Hopefully this change would result in successful validation. There are other small changes like updated summary update that now contain both Japanese and English summaries in one place.
Copy link

github-actions bot commented Sep 4, 2025

😃 Your submission passed all our automated tests.

Below are some sample citations generated based on your proposed changes:

japan-journal-of-stuttering-and-other-fluency-disorders.csl (new)
(CSL Search by Example, 2012; Hancké et al., 2007)
(Fenner et al., 2019; Mares, 2001)

CSL search by example (2012) 2012- Retrieved December 15, 2012, from Citation style editor website: http://editor.citationstyles.org/searchByExample/.
Fenner, M., Crosas, M., Grethe, J. S., Kennedy, D., Hermjakob, H., Rocca-Serra, P., Durand, G., et al. (2019) A data citation roadmap for scholarly data repositories, Scientific Data, 6(1), 28 https://doi.org/10.1038/s41597-019-0031-8.
Hancké, B., Rhodes, M., Thatcher, M. (Eds.) (2007) Beyond varieties of capitalism: Conflict, contradictions, and complementarities in the European economy, Oxford: Oxford University Press https://doi.org/10.1093/acprof:oso/9780199206483.001.0001.
Mares, I. (2001) Firms and the welfare state: When, why, and how does social policy matter to employers?, Peter A. Hall, David Soskice (Eds.), Varieties of capitalism: The institutional foundations of comparative advantage, (pp. 184–212) https://doi.org/10.1093/0199247757.003.0005.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants