{"id":27817950,"url":"https://github.com/ben-kerman/anki-jrp","last_synced_at":"2025-05-01T15:29:26.611Z","repository":{"id":42560872,"uuid":"455741099","full_name":"Ben-Kerman/anki-jrp","owner":"Ben-Kerman","description":"Anki add-on for generating furigana and pitch accent coloring \u0026 graphs, including optional flexible card styling","archived":false,"fork":false,"pushed_at":"2023-01-02T00:02:02.000Z","size":525,"stargazers_count":33,"open_issues_count":6,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T15:34:32.680Z","etag":null,"topics":["anki","anki-addon","furigana","japanese","japanese-study","pitch-accent"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ben-Kerman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-05T00:55:40.000Z","updated_at":"2024-11-09T03:11:27.000Z","dependencies_parsed_at":"2023-02-01T01:31:05.836Z","dependency_job_id":null,"html_url":"https://github.com/Ben-Kerman/anki-jrp","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ben-Kerman%2Fanki-jrp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ben-Kerman%2Fanki-jrp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ben-Kerman%2Fanki-jrp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ben-Kerman%2Fanki-jrp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ben-Kerman","download_url":"https://codeload.github.com/Ben-Kerman/anki-jrp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251898221,"owners_count":21661783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["anki","anki-addon","furigana","japanese","japanese-study","pitch-accent"],"created_at":"2025-05-01T15:29:26.128Z","updated_at":"2025-05-01T15:29:26.603Z","avatar_url":"https://github.com/Ben-Kerman.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Japanese Readings and Pitch Accent Add-on\n\nThis Anki add-on allows automatically generating readings (furigana) and pitch\naccent information for an entire field with a single button press. It can also\nconvert any amount of cards in bulk.\n\n\u003cimg src=\"https://i.imgur.com/8NFw0HB.png\"\u003e\n\nThe add-on is currently experimental and you'll probably encounter bugs or\ncrashes. Data corruption is extremely unlikely (probably even impossible), the\nspecific notes being changed aside, but you should still make backups,\nespecially when bulk converting notes, and enable Anki's built-in automatic\nbackups if you haven't already.  \n[See below](#reporting-issues) for details on how to report issues.\n\n## Getting Started\n\n1. Make sure you have a supported version of Anki installed. See [the AnkiWeb\n   page](https://ankiweb.net/shared/info/1845503807) for further information.\n2. On non-Windows platforms only, [install MeCab](/doc/mecab.md) since only a\n   Windows executable is bundled with the add-on.\n3. Install the full version of the add-on from\n   [AnkiWeb](https://ankiweb.net/shared/info/1845503807).  \n   Alternatively, download one of the `.ankiaddon` files from the\n   [latest release](https://github.com/Ben-Kerman/anki-jrp/releases/latest)\n   and manually install it from the add-on menu.\n    - The smallest file contains only the add-on itself, which means you will\n      need to supply your own pitch accent/variant data and install MeCab as\n      well as a MeCab dictionary alongside a dictionary for it to use\n      externally.\n    - The `full` file has everything except a MeCab dictionary, but including\n      a MeCab exe for Windows.\n    - The `ipadic` file contains everything the add-on needs out of the box and\n      is probably what most users will want to install initially.  \n      This is also the version shared on AnkiWeb.\n4. Restart Anki, open the _Manage Note Types_ menu (`Ctrl`+`⇧`+`N`) and set up\n   your templates as described [here](/doc/template-setup.md).\n5. Open the add-on's preferences under _Tools_ in Anki's main menu bar, go the\n   _Note Types_ tab, then select and _Add_ all note types you set up in the last\n   step.  \n   Click `Remove MIA/Migaku` for any note types you previously used the Migaku\n   Japanese Add-on with to remove the script and styling from that add-on,\n   otherwise this add-on will not work properly.\n6. Save your preferences. You should now be able to preview or review any cards\n   that contain reading/accent syntax with furigana and accent coloring /\n   indicators.\n\n## Adding Readings and Pitch Accent Information\n\n### Individual\n\nTo generate or remove readings and accent info for a single note, select it in\nthe Anki browser, focus the field you want to change and click one of the\nconversion buttons at the right of the editor toolbar or press the associated\nshortcut.\n\n### Bulk Conversion\n\nThe _Notes_ entry in the browser's menu bar contains an action for converting\nnotes in bulk.\n\nSelect any notes you want to change, choose the bulk conversion action from the\nmenu bar, adjust the configuration dialog to what you want and click _Convert_.\nAll notes need to be of the same note type, since it wouldn't be possible to\ndetermine the target field otherwise.\n\nWith the _Default_ and _Migaku_ conversion types, any notes that already contain\nreading/accent syntax will be converted directly to the closest equivalent in\nthe target syntax without regenerating (unless the corresponding option is\nchecked), or left unchanged if the existing syntax type is the same as the\ntarget.\n\nIf you're converting large amounts of notes, such as sentence mining decks\ncontaining hundreds or thousands of cards, make sure to back everything up\nbefore running the conversion. Exporting the deck(s) with scheduling information\n(but without media, since the conversion only changes the notes themselves)\nshould be sufficient.\n\n## Syntax\n\nThe add-on supports its own fully-featured syntax and is also compatible with\nthe syntax from the old Migaku Japanese Add-on.\n\n### Default\n\nIn the default syntax, readings are written in square brackets with kanji on the\nleft and furigana on the right separated by a `|`, like `[振|ふ]り[仮名|がな]`.  \nWords with pitch accent information are enclosed in curly braces that contain\nthe word (including reading tags) itself and accent information after a\nsemicolon: `{[受|う]け[入|い]れる;Y4,0}`.\n\nThe accent information normally consists of a comma-separated list of numbers,\neach representing the accented mora, or 0 for unaccented (平板) words. The only\nspecial cases are unknown accents marked with a `?`, which can only occur by\nconverting from Migaku syntax, and split accents like 一目瞭然 (いち↓もく・りょ→うぜん)\nwhich are composed of several parts separated by dashes. Each part consists of\nthe number of the accented mora, an `@` sign, and the number of moras it applies\nto. For example: `{[一目瞭然|いちもくりょうぜん];2@4-0@4,0}`.\n\nAn `!` and `Y` can be placed before the actual pitch accent information.  \nExclamation marks indicate ambiguous accents, such as for many kana-only words\nor certain words with multiple accents. The add-on automatically inserts\nambiguity marks if it found more than one possible set of accents with the same\nreading for a word. You should then manually look up the words in question and\nadjust the accent tags as necessary.  \nIf present, a Y (from 用 as in 活用・用言) will cause all accents other than [0]\nto be displayed as the kifuku (起伏) pattern. Ys are added to all words identified\nas 動詞 (verbs) or 形容詞 (i-adjectives) by MeCab.\n\nBase readings for conjugated words can be indicated in two ways, inline\nlike `{[行|い][って=く];Y0}`, or after the accent(s) like `{[来|き]た;Y1|くる}`.\n\n### Migaku\n\nFor backwards compatibility, Migaku-style syntax is also supported, but it has\nsome limitations compared to the new syntax:\n\n- Only one reading per word is possible, leading to furigana frequently\n  duplicating characters from the word, like \u003cruby\u003eこの先\u003crt\u003eこのさき\u003c/rt\u003e\u003c/ruby\u003e,\n  \u003cruby\u003e付き合\u003crt\u003eつきあ\u003c/rt\u003e\u003c/ruby\u003eう or \u003cruby\u003e変わり身\u003crt\u003eかわりみ\u003c/rt\u003e\u003c/ruby\u003e.\n- The base reading of conjugable words must always be included in full, even the\n  part identical to the reading of the conjugated form. This is also true if the\n  base reading and actual reading are the same, so the Migaku version of what\n  would be `{[陥|おとしい]れる;Y5,0}` in default syntax is `陥[おとしい,おとしいれる;k5,h]れる`.\n- Since words are space-separated, regular ASCII spaces can't be represented\n  properly and are replaced with en spaces (U+2002).\n- Ambiguous accents can't be marked and thus won't be highlighted.\n- Split accents can't be accurately represented and will be displayed as\n  unknown.\n\n## Migrating from the Migaku Japanese Add-on\n\nFollow the guide to [getting started](#getting-started) above. You'll need to\nmanually transfer your accent pattern colors to the note type style settings if\nyou want to keep them. The add-ons have different default colors.\n\nYou can easily migrate existing notes to the new syntax without losing any\nmanual changes by selecting them in the browser and\n[bulk converting](#bulk-conversion) them with the _Default_ conversion type as\nlong as _Regenerate contents_ is disabled. Make sure to back up all notes in\ncase there are bugs in the conversion algorithm.\n\n## Reporting Issues\n\nIf you encounter a bug or crash while using the add-on please report it. You can\neither open a GitHub issue in this repository or contact me on Discord, where\nyou can find me in the [Refold community servers](https://refold.la/join/).\n\nExplain what you were doing when the issue occurred as accurately as possible,\nideally with a list of steps to reproduce it. If the problem is related to\nspecific cards, consider including an `.apkg` export of those cards (_Notes_\n→ _Export Notes..._ in the Anki browser while having the cards in question\nselected). If there was an error message include its full contents as well, if\npossible as selectable text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-kerman%2Fanki-jrp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fben-kerman%2Fanki-jrp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-kerman%2Fanki-jrp/lists"}