diff --git a/docs/advanced-options.md b/docs/advanced-options.md deleted file mode 100644 index dde6190f79..0000000000 --- a/docs/advanced-options.md +++ /dev/null @@ -1,10 +0,0 @@ -## Advanced Options - -Click the `Advanced` toggle switch in the bottom left corner of the Settings page to enable advanced options. - -### Parse sentences using MeCab - -[MeCab](https://taku910.github.io/mecab/) is a third-party program which uses its own dictionaries and parsing algorithm to decompose sentences into individual words. MeCab may provide more accurate parsing results than Yomitan's internal parser. - -In order for Yomitan to use it, both MeCab and a native messaging component must be installed. -A setup guide can be found [here](https://github.com/yomidevs/yomitan-mecab-installer/blob/master/README.md). diff --git a/docs/anki-integration.md b/docs/anki-integration.md deleted file mode 100644 index 3a87286411..0000000000 --- a/docs/anki-integration.md +++ /dev/null @@ -1,161 +0,0 @@ -## Anki Integration - -Yomitan features automatic flashcard creation for [Anki](https://apps.ankiweb.net/), a free application designed to help you -retain knowledge. This feature requires the prior installation of an Anki plugin called [AnkiConnect](https://foosoft.net/projects/anki-connect). -Check the respective project page for more information about how to set up this software. - -### Flashcard Configuration - -Before flashcards can be automatically created, you must configure the templates used to create term and/or kanji notes. -If you are unfamiliar with Anki deck and model management, this would be a good time to reference the [Anki -Manual](https://docs.ankiweb.net/#/). In short, you must specify what information should be included in the -flashcards that Yomitan creates through AnkiConnect. - -Flashcard fields can be configured with the following steps: - -1. Open the Yomitan options page and scroll down to the section labeled _Anki Options_. -2. Tick the checkbox labeled _Enable Anki integration_ (Anki must be running with [AnkiConnect](https://foosoft.net/projects/anki-connect) installed). -3. Select the type of template to configure by clicking on either the _Terms_ or _Kanji_ tabs. -4. Select the Anki deck and model to use for new creating new flashcards of this type. -5. Fill the model fields with markers corresponding to the information you wish to include (several can be used at - once). -6. _(optional, advanced)_ Users can also configure the actual [Handlebars](https://handlebarsjs.com/) templates used to create - the flashcard contents. - - #### Markers for Term Cards - - | Marker | Description | - | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `{audio}` | Audio of the term's pronunciation from one of the audio sources (if available). | - | `{clipboard-image}` | An image which is stored in the system clipboard, if present. | - | `{clipboard-text}` | Text which is stored in the system clipboard, if present. | - | `{cloze-body}` | Raw, inflected term as it appeared before being reduced to dictionary form by Yomitan. | - | `{cloze-body-kana}` | Kana reading for `{cloze-body}`. | - | `{cloze-prefix}` | Fragment of the containing `{sentence}` starting at the beginning of `{sentence}` until the beginning of `{cloze-body}`. | - | `{cloze-suffix}` | Fragment of the containing `{sentence}` starting at the end of `{cloze-body}` until the end of `{sentence}`. | - | `{conjugation}` | Conjugation path from the raw inflected term to the source term. | - | `{dictionary}` | Original name of the dictionary from which the card is being created (unavailable in _grouped_ mode). | - | `{dictionary-alias}` | Display name of the dictionary from which the card is being created (unavailable in _grouped_ mode). | - | `{document-title}` | Title of the web page that the term appeared in. | - | `{expression}` | Term expressed as kanji (will be displayed in kana if kanji is not available). | - | `{frequencies}` | Frequency information for the term. | - | `{frequency-harmonic-rank}` | The harmonic mean of frequency data for the current term. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based term usage. | - | `{frequency-harmonic-occurrence}` | The harmonic mean of frequency data for the current term. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based term usage. | - | `{frequency-average-rank}` | The average of frequency data for the current term. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based term usage. | - | `{frequency-average-occurrence}` | The average of frequency data for the current term. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based term usage. | - | `{furigana}` | Term expressed as kanji with furigana displayed above it (e.g. 日本語にほんご). | - | `{furigana-plain}` | Term expressed as kanji with furigana displayed next to it in brackets (e.g. 日本語[にほんご]). | - | `{glossary}` | List of definitions for the term (output format depends on whether running in _grouped_ mode). | - | `{glossary-brief}` | List of definitions for the term in a more compact format. | - | `{glossary-no-dictionary}` | List of definitions for the term, except the dictionary tag is omitted. | - | `{glossary-first}` | First definition for the term (output format depends on whether running in _grouped_ mode). | - | `{glossary-first-brief}` | First definition for the term in a more compact format. | - | `{glossary-first-no-dictionary}` | First definition for the term, except the dictionary tag is omitted. | - | `{part-of-speech}` | Part of speech information for the term. | - | `{phonetic-transcriptions}` | List of phonetic transcriptions for the term. | - | `{pitch-accents}` | List of pitch accent downstep notations for the term. | - | `{pitch-accent-graphs}` | List of pitch accent graphs for the term. | - | `{pitch-accent-graphs-jj}` | List of pitch accent graphs for the term (styled after Jidoujisho). | - | `{pitch-accent-positions}` | List of accent downstep positions for the term as a number. | - | `{pitch-accent-categories}` | List of pitch accent categories for the term (e.g. heiban, kifuku, atamadaka, odaka, nakadaka). | - | `{reading}` | Kana reading for the term (empty for terms where the expression is the reading). | - | `{screenshot}` | Screenshot of the web page taken at the time the term was added. | - | `{search-query}` | The full search query shown on the search page. | - | `{popup-selection-text}` | The selected text on the search page or popup. | - | `{sentence}` | Sentence, quote, or phrase that the term appears in from the source content. | - | `{sentence-furigana}` | Sentence, quote, or phrase that the term appears in from the source content, with furigana added. | - | `{single-glossary-DICT-NAME}` | Same as `{glossary}`, but with entries from only a single dictionary. The dictionary name will likely be modified, use the options from the ▼ dropdown. | - | `{single-glossary-DICT-NAME-brief}` | See `{single-glossary-DICT-NAME}` and `{glossary-brief}`. | - | `{single-glossary-DICT-NAME-no-dictionary}` | See `{single-glossary-DICT-NAME}` and `{glossary-no-dictionary}`. | - | `{tags}` | Grammar and usage tags providing information about the term (unavailable in _grouped_ mode). | - | `{url}` | Address of the web page in which the term appeared in. | - - #### Markers for Kanji Cards - - | Marker | Description | - | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | - | `{character}` | Unicode glyph representing the current kanji. | - | `{clipboard-image}` | An image which is stored in the system clipboard, if present. | - | `{clipboard-text}` | Text which is stored in the system clipboard, if present. | - | `{cloze-body}` | Raw, inflected parent term as it appeared before being reduced to dictionary form by Yomitan. | - | `{cloze-prefix}` | Fragment of the containing `{sentence}` starting at the beginning of `{sentence}` until the beginning of `{cloze-body}`. | - | `{cloze-suffix}` | Fragment of the containing `{sentence}` starting at the end of `{cloze-body}` until the end of `{sentence}`. | - | `{dictionary}` | Original name of the dictionary from which the card is being created. | - | `{dictionary-alias}` | Display name of the dictionary from which the card is being created. | - | `{document-title}` | Title of the web page that the kanji appeared in. | - | `{frequencies}` | Frequency information for the kanji. | - | `{frequency-harmonic-rank}` | The harmonic mean of frequency data for the current kanji. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based kanji usage. | - | `{frequency-harmonic-occurrence}` | The harmonic mean of frequency data for the current kanji. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based kanji usage. | - | `{frequency-average-rank}` | The average of frequency data for the current kanji. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based kanji usage. | - | `{frequency-average-occurrence}` | The average of frequency data for the current kanji. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based kanji usage. | - | `{glossary}` | List of definitions for the kanji. | - | `{kunyomi}` | Kunyomi (Japanese reading) for the kanji expressed as hiragana. | - | `{onyomi}` | Onyomi (Chinese reading) for the kanji expressed as katakana. | - | `{onyomi-hiragana}` | Onyomi (Chinese reading) for the kanji expressed as hiragana. | - | `{screenshot}` | Screenshot of the web page taken at the time the kanji was added. | - | `{search-query}` | The full search query shown on the search page. | - | `{popup-selection-text}` | The selected text on the search page or popup. | - | `{sentence}` | Sentence, quote, or phrase that the character appears in from the source content. | - | `{sentence-furigana}` | Sentence, quote, or phrase that the character appears in from the source content, with furigana added. | - | `{stroke-count}` | Number of strokes that the kanji character has. | - | `{url}` | Address of the web page in which the kanji appeared in. | - -When creating your model for Yomitan, _make sure that you pick a unique field to be first_; fields that will -contain `{expression}` or `{character}` are ideal candidates for this. Anki does not allow duplicate flashcards to be -added to a deck by default; it uses the first field in the model to check for duplicates. For example, if you have `{reading}` -configured to be the first field in your model and 橋はし is already in your deck, you will not -be able to create a flashcard for 箸はし because they share the same reading. - -### Flashcard Creation - -Once Yomitan is configured, it becomes trivial to create new flashcards with a single click. You will see the following -icons next to term definitions: - -- Clicking ![](../img/btn-add-expression.png) adds the current expression (e.g. 食べる). -- Clicking ![](../img/btn-add-reading.png) adds the current expression's reading (e.g. たべる). - -If _Check for card duplicates_ is on, and a card for the current definition already exists in the deck, you will see the book icon. -If _When a duplicate is detected_ is set to `Prevent adding`, the icons will appear grayed out. If set to `Allow adding`, the icons will change to: - -- ![](../img/btn-add-duplicate-expression.png): to add the expression -- ![](../img/btn-add-duplicate-reading.png): to add the reading - -Below are some troubleshooting tips you can try if you are unable to create new flashcards: - -- If all of the buttons appear grayed out, then you should double-check your deck and model configuration settings. -- If no icons appear at all, make sure that Anki is running in the background and that [AnkiConnect](https://foosoft.net/projects/anki-connect) has been installed. - -### Anki Note Generation - -Using the `Generate Anki Notes (Experimental)...` feature in the settings page it is possible to easily generate and export large amounts of Anki cards. - -> [!WARNING] -> This feature is experimental! - -First, get a newline separated list of terms. For example: - -``` -雪 -雨 -竜巻 -``` - -Enter this list into the large text box in the `Anki Note Generator` popup window. - -Next, select either `Send to Anki` or `Export to File`. - -**Send to Anki:** - -`Send to Anki` will send all the terms to the active Anki deck using the active Anki model specified on the page. To change the active Anki deck or Anki model, edit them in the `Configure Anki card format...` setting. - -Make sure to confirm you are exporting to the correct deck and with the correct Anki model. After the notes are sent to Anki there is no way to automatically undo the changes. - -To include media in notes sent to Anki, make sure to enable the `Add media to notes` option. Media includes audio, images, and svgs. Exporting with media may take significantly longer than without it. - -To prevent duplicate notes being sent to Anki, enable the `Prevent sending duplicate notes` option. This will check for duplicate notes that already exist. The `Check for duplicates across all models` and `Duplicate card scope` settings are used to determine what is considered a duplicate card. **This does not remove duplicates in the term list.** - -**Export to File:** - -`Export to File` will export all the terms to an Anki deck file using the active Anki card format specified on the page and in Anki's `Notes in plain text (.txt)` format. After exporting completes you will be prompted to save the file. This file can later be imported into Anki. - -Media cannot be included when exporting in this format. diff --git a/docs/audio.md b/docs/audio.md deleted file mode 100644 index e175d7a2a9..0000000000 --- a/docs/audio.md +++ /dev/null @@ -1,34 +0,0 @@ -# Audio - -## Default audio sources - -After looking up a term, you can click on the _speaker_ button to hear the term's pronunciation. When searching for audio, multiple audio sources are checked until the first source with audio for the term is found. If no audio is found, you will hear a short click instead. Right-clicking the button allows choosing the source manually. - -The default audio sources are: - -- LanguagePod101 -- Jisho.org (japanese only) -- Lingua Libre -- Wiktionary - -Depending on language, you may want to increase coverage by adding additional sources, as described below. - -## Configuration - -Audio sources can be configured in `Settings` > `Audio` > `Configure audio playback sources` to reorder them or add new ones. Besides the four sources mentioned above, you can also use your browser's inbuilt text-to-speech (TTS) engine or add a custom URL source: - -### Text-to-speech (TTS) - -To enable this, just add a new playback source with the `Text-to-speech` type and choose your desired voice. This is the simplest way to get pronunciation audio, though there a few points to keep in mind: - -- TTS voices vary between browsers and so might not support all languages. For instance, [Microsoft Edge](https://www.microsoft.com/en-us/edge) offers a wide selection of free Azure natural voices for a variety of languages. Edge provides over 300 voices, compared to around 25 in Google Chrome (see [here](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt) for a list of supported languages). -- TTS audio can be inaccurate for languages with complex pronunciation such as Japanese, where words can have multiple possible readings and pitch accents. -- ⚠️ Note that the TTS voices cannot be sent to Anki; this is a [limitation of the browser SpeechSynthesis API](https://github.com/yomidevs/yomitan/issues/864). - -### Custom URL - -You can add a custom URL from which audio will be fetched. One use case for this is fetching audio from Forvo: - -#### Yomichan Forvo Server - -[Forvo](https://forvo.com/) is currently the largest online pronunciation database, with native pronunciation audio for various languages. One way to get Forvo audio in Yomitan is via the [Yomichan Forvo Server](https://ankiweb.net/shared/info/580654285) Anki add-on. It fetches from Forvo, at the cost of a slight delay. After installing it in Anki, add a `Custom URL (JSON)` audio source with the URL `http://localhost:8770?term={term}&reading={reading}&language=en` (replacing `en` with the desired language's ISO code). diff --git a/docs/dictionaries.md b/docs/dictionaries.md deleted file mode 100644 index 4cd770592d..0000000000 --- a/docs/dictionaries.md +++ /dev/null @@ -1,58 +0,0 @@ -## Dictionaries - -You must download and import the dictionaries you wish to use in order to enable Yomitan definition lookups. There are several free dictionaries available for Yomitan, some of them with glossaries available in different languages. - -Be aware that non-English dictionaries generally contain fewer entries than their English counterparts. Even if your primary language is not English, you may consider also importing the English version for better coverage. - -### Recommended Dictionaries - -#### Japanese - -- [Jitendex](https://github.com/stephenmk/Jitendex) - An improved version of JMdict for Yomitan. It features better formatting and some other improvements, and is actively being improved by its author. -- [JMdict](https://github.com/yomidevs/jmdict-yomitan#jmdict-for-yomitan-1) - There are daily automatically updated builds of JMdict for Yomitan available in this repository. It is available in multiple languages and formats, but we recommend installing the more modern Jitendex for English users. -- [JMnedict](https://github.com/yomidevs/jmdict-yomitan#jmnedict-for-yomitan) - Lists readings of person/place/organization names and other proper nouns. -- [KANJIDIC](https://github.com/yomidevs/jmdict-yomitan#kanjidic-for-yomitan) - An English dictionary listing readings, meanings, and other info about kanji characters. -- [BCCWJ Frequency Dictionary](https://github.com/Kuuuube/yomitan-dictionaries?tab=readme-ov-file#bccwj-suw-luw-combined) - A frequency dictionary based on the Balanced Corpus of Contemporary Written Japanese. -- [JPDB Frequency Dictionary](https://github.com/Kuuuube/yomitan-dictionaries?tab=readme-ov-file#jpdb-v22-frequency) - A frequency dictionary based on the corpus from the online Japanese dictionary and SRS system at https://jpdb.io. - -#### Other Languages - -- **Multilingual** - - [KTY](https://github.com/yomidevs/kaikki-to-yomitan) - Wiktionaries in various languages converted to Yomitan format. - - [Wikipedia for Yomitan](https://github.com/MarvNC/wikipedia-yomitan) - All of Wikipedia in Yomitan for various languages. -- **Korean** - - [KRDICT/STDICT](https://github.com/Lyroxide/yomitan-ko-dic/releases) - Korean dictionaries for Yomitan. -- **Cantonese** - - [words.hk for Yomitan](https://github.com/MarvNC/wordshk-yomitan) - A free Cantonese-English and Cantonese-Cantonese dictionary for Yomitan. -- **Mandarin** - - [CC-CEDICT for Yomitan](https://github.com/MarvNC/cc-cedict-yomitan) - A free Chinese-English dictionary for Yomitan. - -#### EPWING Dictionaries - -Yomitan supports dictionaries in the esoteric but popular [EPWING](https://ja.wikipedia.org/wiki/EPWING) format. They were often utilized in portable electronic dictionaries. These dictionaries are often sought after by language learners for their correctness and excellent coverage of the Japanese language. - -Unfortunately, as most of the dictionaries released in this format are proprietary, you will need to procure these dictionaries yourself and import them using [Yomitan Import](https://github.com/yomidevs/yomitan-import). Check the project page for additional details. - -### Bulk Importing Dictionaries - -Yomitan also supports exporting and importing your entire collection of dictionaries. - -#### Importing a Dictionary Collection - -- Go to Yomitan's settings page (click on the extension's icon then click on the cog icon from the popup) -- Click `Import Dictionary Collection` and select the database file you want to import -- Wait for the import to finish then turn all the dictionaries back on from the `Dictionaries > Configure installed and enabled dictionaries` section -- Refresh the browser tab to see the dictionaries in effect - -#### Exporting the Dictionary Collection - -- Click `Export Dictionary Collection` from the backup section of Yomitan's settings page -- It will show you a progress report as it exports the data then initiates a - download for a file named something like `yomitan-dictionaries-YYYY-MM-DD-HH-mm-ss.json` - (e.g. `yomitan-dictionaries-2023-07-05-02-42-04.json`) - -### Importing and Exporting Personal Configuration - -Note that you can also similarly export and import your Yomitan settings from the `Backup` section of the Settings page. - -You should be able to replicate your exact Yomitan setup across devices by exporting your settings and dictionary collection from the source device then importing those from the destination. diff --git a/docs/faq.md b/docs/faq.md deleted file mode 100644 index 2cd1830161..0000000000 --- a/docs/faq.md +++ /dev/null @@ -1,50 +0,0 @@ -## Frequently Asked Questions - -**I can't scan text in Firefox!** - -In Firefox's Manifest V3, host permissions are treated as opt-in. For Yomitan to work properly, the recommended permissions -must be explicitly set. In the Yomitan welcome page, go to the `Recommended Permissions (Important)` section and check `Enable recommended permissions`. - -**I'm having problems importing dictionaries in Firefox, what do I do?** - -Yomitan uses the cross-browser IndexedDB system for storing imported dictionary data into your user profile. Although -everything "just works" in Chrome, depending on settings, Firefox users can run into problems due to browser bugs. -Yomitan catches errors and tries to offer suggestions about how to work around Firefox issues, but in general at least -one of the following solutions should work for you: - -- Make sure you have cookies enabled. It appears that disabling them also disables IndexedDB for some reason. You - can still have cookies be disabled on other sites; just make sure to add the Yomitan extension to the whitelist of - whatever tool you are using to restrict cookies. You can get the extension "URL" by looking at the address bar when - you have the search page open. -- Make sure that you have sufficient disk space available on the drive Firefox uses to store your user profile. - Firefox limits the amount of space that can be used by IndexedDB to a small fraction of the disk space actually - available on your computer. -- Make sure that you have history set to "Remember history" enabled in your privacy settings. When this option is - set to "Never remember history", IndexedDB access is once again disabled for an inexplicable reason. -- As a last resort, try using the [Refresh Firefox](https://support.mozilla.org/en-US/kb/reset-preferences-fix-problems) - feature to reset your user profile. It appears that the Firefox profile system can corrupt itself preventing - IndexedDB from being accessible to Yomitan. - -**Will you add support for online dictionaries?** - -Online dictionaries will not be implemented because it is not possible to support them in a robust way. In order to -perform deinflection, Yomitan must execute dozens of database queries for every single word. Factoring in -network latency and the fragility of web scraping, it would not be possible to maintain a good and consistent user -experience. - -**Is it possible to use Yomitan with files saved locally on my computer with Chrome?** - -In order to use Yomitan with local files in Chrome, you must first tick the _Allow access to file URLs_ checkbox -for Yomitan on the extensions page. Due to the restrictions placed on browser addons in the WebExtensions model, it -will likely never be possible to use Yomitan with PDF files. - -**Is it possible to delete individual dictionaries without purging the database?** - -Yomitan is able to delete individual dictionaries, but keep in mind that this process can be _very_ slow and can -cause the browser to become unresponsive. The time it takes to delete a single dictionary can sometimes be roughly -the same as the time it originally took to import, which can be significant for certain large dictionaries. - -**Why aren't EPWING dictionaries bundled with Yomitan?** - -The vast majority of EPWING dictionaries are proprietary, so they are unfortunately not able to be included in -this extension due to copyright reasons. diff --git a/docs/keyboard-shortcuts.md b/docs/keyboard-shortcuts.md deleted file mode 100644 index bf12a84af4..0000000000 --- a/docs/keyboard-shortcuts.md +++ /dev/null @@ -1,25 +0,0 @@ -## Keyboard Shortcuts - -The following shortcuts are globally available: - -| Shortcut | Action | -| ---------------------------------- | ------------------------ | -| Alt + Insert | Open search page. | -| Alt + Delete | Toggle extension on/off. | - -The following shortcuts are available on search results: - -| Shortcut | Action | -| -------------------------------- | --------------------------------------- | -| Esc | Cancel current search. | -| Alt + PgUp | Page up through results. | -| Alt + PgDn | Page down through results. | -| Alt + End | Go to last result. | -| Alt + Home | Go to first result. | -| Alt + Up | Go to previous result. | -| Alt + Down | Go to next result. | -| Alt + B | Go to back to source term. | -| Alt + E | Add current term as expression to Anki. | -| Alt + R | Add current term as reading to Anki. | -| Alt + P | Play audio for current term. | -| Alt + K | Add current kanji to Anki. | diff --git a/docs/permissions.md b/docs/permissions.md deleted file mode 100644 index 342866ff4f..0000000000 --- a/docs/permissions.md +++ /dev/null @@ -1,43 +0,0 @@ -# Yomitan Permissions - -- ``
- Yomitan requires access to all URLs in order to run scripts to scan text and show the definitions popup, - request audio for playback and download, and connect with Anki. - -- `storage` and `unlimitedStorage`
- Yomitan uses storage permissions in order to save extension settings and dictionary data. - `unlimitedStorage` is used to help prevent web browsers from unexpectedly - deleting dictionary data. - -- `declarativeNetRequest`
- Yomitan uses this permission to ensure certain requests have valid and secure headers. - This sometimes involves removing or changing the `Origin` request header, - as this can be used to fingerprint browser configuration. - -- `scripting`
- Yomitan needs to inject content scripts and stylesheets into webpages in order to - properly display the search popup. - -- `contextMenus`
- Yomitan adds a context menu interface that lets you look up highlighted words. - -- `offscreen` _(Chrome only)_
- Yomitan uses this permission to create a secondary backend document that has DOM access, given that Manifest v3 - service workers do not. Service workers can then reach out to out to this document in order to complete - actions that require access to DOM APIs, such as any that require clipboard access. - -- `clipboardWrite`
- Yomitan supports simulating the `Ctrl+C` (copy to clipboard) keyboard shortcut - when a definitions popup is open and focused. - -- `clipboardRead` _(optional)_
- Yomitan supports automatically opening a search window when Japanese text is copied to the clipboard - while the browser is running, depending on how certain settings are configured. - This allows Yomitan to support scanning text from external applications, provided there is a way - to copy text from those applications to the clipboard. - -- `nativeMessaging` _(optional, unavailable on Firefox for Android)_
- Yomitan has the ability to communicate with an optional native messaging component in order to support - parsing large blocks of Japanese text using - [MeCab](https://en.wikipedia.org/wiki/MeCab). - The installation of this component is optional and is not included by default. diff --git a/docs/supported-languages.md b/docs/supported-languages.md deleted file mode 100644 index d4ef4c3c9c..0000000000 --- a/docs/supported-languages.md +++ /dev/null @@ -1,44 +0,0 @@ -# Supported Languages - -Yomitan supports a variety of languages, although the level of support may vary depending on the extent to which deinflections and text transforms have been implemented. - -These are the languages currently supported by Yomitan: - -| Language | Code | -| -------------- | ---- | -| Albanian | sq | -| Ancient Greek | grc | -| Arabic | ar | -| Cantonese | yue | -| Chinese | zh | -| Danish | da | -| Dutch | nl | -| English | en | -| Finnish | fi | -| French | fr | -| German | de | -| Greek | el | -| Hungarian | hu | -| Indonesian | id | -| Italian | it | -| Japanese | ja | -| Khmer | km | -| Korean | ko | -| Lao | lo | -| Latin | la | -| Mongolian | mn | -| Old Irish | sga | -| Persian | fa | -| Polish | pl | -| Portuguese | pt | -| Romanian | ro | -| Russian | ru | -| Serbo-Croatian | sh | -| Spanish | es | -| Swedish | sv | -| Tagalog | tl | -| Thai | th | -| Turkish | tr | -| Vietnamese | vi | - -For more information on how to add or improve support for a language, please refer to the [language features documentation](./development/language-features.md). diff --git a/docs/yomichan-migration.md b/docs/yomichan-migration.md deleted file mode 100644 index c583cda943..0000000000 --- a/docs/yomichan-migration.md +++ /dev/null @@ -1,31 +0,0 @@ -## Migrating from Yomichan - -### Exporting Data - -If you are an existing user of Yomichan, you can export your dictionary collection and settings such that they can be imported into Yomitan to reflect your setup exactly as it was. - -You can export your settings from Yomichan's Settings page. Go to the `Backup` section and click on `Export Settings`. - -Yomichan doesn't have first-class support to export the dictionary collection. Please follow the instructions provided in the following link to export your data: -https://github.com/yomidevs/yomichan-data-exporter#steps-to-export-the-data - -You can then import the exported files into Yomitan from the `Backup` section of the `Settings` page. Please see [the section on importing dictionaries](#importing-dictionaries) further below for more explicit steps. - -### Custom Templates - -If you do not use custom templates for Anki note creation, this section can be skipped. - -Due to security concerns, an alternate implementation of Handlebars is being used which behaves slightly differently. -This revealed a bug in four of Yomitan's template helpers, which have now been fixed in the default templates. If your -custom templates use the following helpers, please ensure their use matches the corrected forms. - -| Helper | Example | Corrected | -| ---------------- | ------------------------------------------------------------- | ------------------------------------ | -| `formatGlossary` | `{{#formatGlossary ../dictionary}}{{{.}}}{{/formatGlossary}}` | `{{formatGlossary ../dictionary .}}` | -| `furigana` | `{{#furigana}}{{{definition}}}{{/furigana}}` | `{{furigana definition}}` | -| `furiganaPlain` | `{{~#furiganaPlain}}{{{.}}}{{/furiganaPlain~}}` | `{{~furiganaPlain .~}}` | -| `dumpObject` | `{{#dumpObject}}{{{.}}}{{/dumpObject}}` | `{{dumpObject .}}` | - -Authors of custom templates may be interested to know that other helpers previously used and documented in the block -form (e.g. `{{#set "key" "value"}}{{/set}}`), while not broken by this change, may also be replaced with the less verbose -form (e.g. `{{set "key" "value"}}`). The default templates and helper documentation have been changed to reflect this.