diff options
| author | toasted-nutbread <toasted-nutbread@users.noreply.github.com> | 2020-12-12 12:35:56 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-12 12:35:56 -0500 |
| commit | e9027457ab6aa083bbe226a5787a11f94e6373f1 (patch) | |
| tree | 96136eb9ab7e05badc4cf7b776937f9b3d53c684 /ext/bg/permissions.html | |
| parent | ddb71af6bd8092cfed9f91401d5ecded6ef4c4b6 (diff) | |
Add permissions page and documentation (#1098)
Diffstat (limited to 'ext/bg/permissions.html')
| -rw-r--r-- | ext/bg/permissions.html | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/ext/bg/permissions.html b/ext/bg/permissions.html new file mode 100644 index 00000000..a1138aee --- /dev/null +++ b/ext/bg/permissions.html @@ -0,0 +1,144 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + <title>Yomichan Permissions</title> + <link rel="icon" type="image/png" href="/mixed/img/icon16.png" sizes="16x16"> + <link rel="icon" type="image/png" href="/mixed/img/icon19.png" sizes="19x19"> + <link rel="icon" type="image/png" href="/mixed/img/icon32.png" sizes="32x32"> + <link rel="icon" type="image/png" href="/mixed/img/icon38.png" sizes="38x38"> + <link rel="icon" type="image/png" href="/mixed/img/icon48.png" sizes="48x48"> + <link rel="icon" type="image/png" href="/mixed/img/icon64.png" sizes="64x64"> + <link rel="icon" type="image/png" href="/mixed/img/icon128.png" sizes="128x128"> + <link rel="stylesheet" type="text/css" href="/bg/css/settings2.css"> +</head> +<body> + +<!-- Main content --> +<div class="content-outer"><div class="content"> +<div class="content-center"> + + <span tabindex="-1" id="content-scroll-focus"></span> + + <h1>Yomichan Permissions</h1> + + <h2 id="permissions"></h2> + <div class="settings-group"> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label"><code><all_urls></code></div> + <div class="settings-item-description"> + Yomichan 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. + </div> + </div> + </div></div> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label"><code>storage</code> and <code>unlimitedStorage</code></div> + <div class="settings-item-description"> + Yomichan uses storage permissions in order to save extension settings and dictionary data. + <code>unlimitedStorage</code> is used to help prevent web browsers from unexpectedly + deleting dictionary data. + </div> + </div> + </div></div> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label"><code>webRequest</code> and <code>webRequestBlocking</code></div> + <div class="settings-item-description"> + <p> + Yomichan uses these permissions to ensure certain requests have valid and secure headers. + This sometimes involves removing or changing the <code>Origin</code> request header, + as this can be used to fingerprint browser configuration. + </p> + <p> + Example: <code>Origin: <span id="extension-id-example"></span></code> + </p> + </div> + </div> + </div></div> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label"><code>nativeMessaging</code></div> + <div class="settings-item-description"> + Yomichan has the ability to communicate with an optional native messaging component in order to support + parsing large blocks of Japanese text using + <a href="https://en.wikipedia.org/wiki/MeCab" target="_blank" rel="noopener noreferrer">MeCab</a>. + The installation of this component is optional and is not included by default. + </div> + </div> + </div></div> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label"><code>clipboardWrite</code></div> + <div class="settings-item-description"> + Yomichan supports simulating the <code>Ctrl+C</code> (copy to clipboard) keyboard shortcut + when a definitions popup is open and focused. + </div> + </div> + </div></div> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label"><code>clipboardRead</code> <span class="light">(optional)</span></div> + <div class="settings-item-description"> + Yomichan 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 + to copy text from those applications to the clipboard. + </div> + </div> + <div class="settings-item-right"> + <label class="toggle"><input type="checkbox" id="permission-checkbox-clipboard-read"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label> + </div> + </div></div> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label">Allow in private windows <span class="light">(optional)</span></div> + <div class="settings-item-description"> + <p> + When enabled, Yomichan is able to scan text and show definitions in private/incognito web browser windows. + </p> + <p> + This option can be configured from the web browser's extension settings pages. + </p> + </div> + </div> + <div class="settings-item-right"> + <label class="toggle"><input type="checkbox" id="permission-checkbox-allow-in-private-windows" disabled><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label> + </div> + </div></div> + <div class="settings-item"><div class="settings-item-inner"> + <div class="settings-item-left"> + <div class="settings-item-label">Allow access to file URLs <span class="light">(optional)</span></div> + <div class="settings-item-description"> + <p> + When enabled, Yomichan is able to scan text and show definitions on local HTML files located using the <code>file://*</code> scheme. + </p> + <p data-show-for-browser="chrome edge"> + This option can be configured from the web browser's extension settings pages. + </p> + </div> + </div> + <div class="settings-item-right"> + <label class="toggle"><input type="checkbox" id="permission-checkbox-allow-file-url-access" disabled><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label> + </div> + </div></div> + </div> + + <div class="footer-padding"></div> + +</div> +</div></div> + +<!-- Scripts --> +<script src="/mixed/js/core.js"></script> +<script src="/mixed/js/yomichan.js"></script> +<script src="/mixed/js/comm.js"></script> +<script src="/mixed/js/api.js"></script> + +<script src="/bg/js/permissions-main.js"></script> + +</body> +</html> |