Skip to content

Document pinyin citation keys for Chinese author names - #701

Open
ansonpoh wants to merge 1 commit into
JabRef:mainfrom
cs467-team4:pinyin-citation-keys
Open

ansonpoh wants to merge 1 commit into
JabRef:mainfrom
cs467-team4:pinyin-citation-keys

Conversation

@ansonpoh

Copy link
Copy Markdown

Pull Request Description

Summary

Adds the :transliterate modifier and a section on generating pinyin citation keys for Chinese author names to the citation key patterns page.

Steps to test

Open JabRef, set the default key pattern to [auth:transliterate:camel][authForeIni:transliterate:camel][year], create an entry with author 万征 and year 2016, and generate the key. It should be WanZheng2016.

Related issues and pull requests

Documents JabRef/jabref#17366

AI usage

Claude Code (model claude-opus-5-5)

Checklist

  • I reviewed and take ownership of all content in this PR, including any AI-assisted text
  • I opened JabRef and followed these instructions myself to confirm they still work (tested on version: development build, commit JabRef/jabref@7e567c2)
  • [/] Any links I added or changed work (no 404s)
  • [/] Any images or tables I added display correctly
  • I checked spelling/grammar

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can open the rule or relationship behind a finding in one click

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document pinyin citation keys for Chinese author names

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Document :transliterate as a citation key modifier, including pinyin conversion.
• Add patterns for Chinese author names and explain name parsing, key collisions, and preserving
 existing keys.
Diagram

graph TD
  A["Chinese author"] --> B["Author markers"] --> C["Pinyin transliteration"] --> D["Case formatting"] --> E["Append year"] --> F{"Key collision?"}
  F -->|Yes| G["Add suffix"] --> H["Citation key"]
  F -->|No| H
Loading
High-Level Assessment

Adding the modifier to its existing list and placing the worked examples on the citation key patterns page keeps the guidance where readers configure keys. A separate page would fragment this short, closely related explanation.

Files changed (1) +15 / -0

Documentation (1) +15 / -0
citationkeypatterns.mdExplain transliteration and pinyin citation key patterns +15/-0

Explain transliteration and pinyin citation key patterns

• Adds ':transliterate' to the modifier list and provides patterns yielding full and abbreviated pinyin keys for Chinese author names. Explains comma-dependent name parsing, collisions between transliterated surnames, and the preference for retaining existing keys.

en/setup/citationkeypatterns.md

This branch has not been deployed

No deployments
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.

1 participant