diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/permissions.md | 18 | ||||
| -rw-r--r-- | docs/templates.md | 18 |
2 files changed, 18 insertions, 18 deletions
diff --git a/docs/permissions.md b/docs/permissions.md index b2b1a34c..92d5e06f 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -1,21 +1,21 @@ -# Yomichan Permissions +# Yomitan Permissions * `<all_urls>` <br> - Yomichan requires access to all URLs in order to run scripts to scan text and show the definitions popup, + 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` <br> - Yomichan uses storage permissions in order to save extension settings and dictionary data. + 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` <br> - Yomichan uses this permission to ensure certain requests have valid and secure headers. + 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` <br> - Yomichan needs to inject content scripts and stylesheets into webpages in order to + Yomitan needs to inject content scripts and stylesheets into webpages in order to properly display the search popup. * `offscreen` _(Chrome only)_ <br> @@ -24,17 +24,17 @@ actions that require access to DOM APIs, such as any that require clipboard access. * `clipboardWrite` <br> - Yomichan supports simulating the `Ctrl+C` (copy to clipboard) keyboard shortcut + Yomitan supports simulating the `Ctrl+C` (copy to clipboard) keyboard shortcut when a definitions popup is open and focused. * `clipboardRead` _(optional)_ <br> - Yomichan supports automatically opening a search window when Japanese text is copied to the clipboard + 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 Yomichan to support scanning text from external applications, provided there is a way + 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)_ <br> - Yomichan has the ability to communicate with an optional native messaging component in order to support + 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/templates.md b/docs/templates.md index e75e4635..18274ed5 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -2,7 +2,7 @@ ## Helpers -Yomichan supports several custom Handlebars helpers for rendering templates. +Yomitan supports several custom Handlebars helpers for rendering templates. The source code for these templates can be found [here](../ext/js/templates/sandbox/anki-template-renderer.js). @@ -586,12 +586,12 @@ Joins the arguments to a single string with a separator, flattening any argument ```handlebars {{set "index" 32~}} - {{~join "_" "yomichan" (get "index") "value"}} + {{~join "_" "yomitan" (get "index") "value"}} ``` Output: ```html - yomichan_32_value + yomitan_32_value ``` </details> @@ -613,12 +613,12 @@ Joins the arguments to a single string, without flattening arguments that are ar ```handlebars {{set "index" 32~}} - {{~concat "yomichan_" (get "index") "_value"}} + {{~concat "yomitan_" (get "index") "_value"}} ``` Output: ```html - yomichan_32_value + yomitan_32_value ``` </details> @@ -727,11 +727,11 @@ These functions are used together in order to request media and other types of o Output: ```html - The audio file name is: yomichan_audio_にほんご_日本語.mp3 + The audio file name is: yomitan_audio_にほんご_日本語.mp3 - The screenshot file name is: yomichan_browser_screenshot_にほんご_日本語.png + The screenshot file name is: yomitan_browser_screenshot_にほんご_日本語.png - The clipboard image file name is: yomichan_clipboard_image_にほんご_日本語.png + The clipboard image file name is: yomitan_clipboard_image_にほんご_日本語.png The clipboard text is: This is the clipboard text @@ -741,7 +741,7 @@ These functions are used together in order to request media and other types of o This is an example of text with generated furigana: <ruby>日本語<rt>にほんご</rt></ruby> - The remapped file name for image.png is: yomichan_dictionary_media_1_にほんご_日本語.png + The remapped file name for image.png is: yomitan_dictionary_media_1_にほんご_日本語.png ``` </details> |