Files
SubMiner/vendor/yomitan/quick-start-guide.html
2026-02-09 19:04:19 -08:00

160 lines
9.0 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Quick Start Guide</title>
<link rel="icon" type="image/png" href="/images/icon16.png" sizes="16x16">
<link rel="icon" type="image/png" href="/images/icon19.png" sizes="19x19">
<link rel="icon" type="image/png" href="/images/icon32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/images/icon38.png" sizes="38x38">
<link rel="icon" type="image/png" href="/images/icon48.png" sizes="48x48">
<link rel="icon" type="image/png" href="/images/icon64.png" sizes="64x64">
<link rel="icon" type="image/png" href="/images/icon128.png" sizes="128x128">
<link rel="stylesheet" type="text/css" href="/css/material.css">
<link rel="stylesheet" type="text/css" href="/css/settings.css">
<script src="/js/pages/generic-page-main.js" type="module"></script>
</head>
<body hidden>
<!-- Main content -->
<div class="content-outer"><div class="content scrollbar">
<div class="content-left"></div>
<div class="content-center">
<span tabindex="-1" id="content-scroll-focus"></span>
<h1>Yomitan Quick Start Guide</h1>
<!-- Content -->
<h2>Quick Actions</h2>
<div class="settings-group">
<div class="settings-item">
<div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
Clicking the <img src="/images/yomitan-icon.svg" class="inline-icon" alt=""> <em>Yomitan</em> button in the browser bar will open the quick-actions popup.
</div></div></div>
<div id="action-popup-container">
<img id="action-popup" src="/images/browser-action-popup.webp" alt="browser-action-popup">
<div class="settings-item-children settings-item-children-group">
<div class="settings-item"><div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
The <img src="/images/cog.svg" class="inline-icon" alt=""> <em>cog</em> button will open the <a href="/settings.html" target="_blank" rel="noopener">Settings</a> page.
</div></div></div></div>
<div class="settings-item"><div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
The <img src="/images/magnifying-glass.svg" class="inline-icon" alt=""> <em>magnifying glass</em> button will open the <a href="/search.html" target="_blank" rel="noopener">Search</a> page,
enabling text and terms to be looked up using the installed dictionaries.
This can even be used in offline mode!
</div></div></div></div>
<div class="settings-item"><div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
The <img src="/images/question-mark-circle.svg" class="inline-icon" alt=""> <em>question mark</em> button will open the <a href="/info.html" target="_blank" rel="noopener">Information</a> page,
which has some helpful information and links about Yomitan.
</div></div></div></div>
</div>
</div>
</div>
</div>
<h2>Installing Dictionaries</h2>
<div class="settings-group">
<div class="settings-item">
<div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
Yomitan requires one or more dictionaries to be installed in order to look up terms, kanji, and other information.
<br><br>
To get started, first select your desired language in the <a href="/settings.html#general" rel="noopener">Settings</a> page.
Then, click on <i>Get recommended dictionaries</i> under the <a href="/settings.html#dictionaries" rel="noopener">Dictionaries</a> section to find dictionaries for your language.
You can also visit <a href="https://yomitan.wiki/dictionaries/" target="_blank" rel="noopener noreferrer">Yomitan Wiki</a> to learn more about Yomitan dictionaries.
Once downloaded, dictionaries can be configured and managed from the same <a href="/settings.html#dictionaries" rel="noopener">Settings</a> page.
<br><br>
<img class="quick-start-img" src="/images/settings-dictionaries-popup.webp" alt="settings-dictionaries-popup">
</div></div></div>
</div>
</div>
<h2>Scanning Text</h2>
<div class="settings-group">
<div class="settings-item">
<div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
After dictionaries have been installed, webpage text can be scanned by moving the cursor while holding a modifier key.
The default key is <kbd>Shift</kbd>, which can be disabled or configured in the <a href="/settings.html#backup">Settings</a> page.
</div></div></div>
<img class="quick-start-img" src="/images/scanning-popup.webp" alt="scanning">
<div class="settings-item-children settings-item-children-group">
<div class="settings-item"><div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
Clicking the <img src="/images/play-audio.svg" class="inline-icon" alt=""> <em>speaker</em> button of an entry in the search results
will play an audio clip of a term's pronunciation using an online dictionary, if available.
</div></div></div></div>
<div class="settings-item"><div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
Clicking on a kanji character in a term's definition will show additional information about that character.
<span class="light">(Requires a kanji dictionary to be installed.)</span>
</div></div></div></div>
</div>
</div>
</div>
<h2>Migrating to Yomitan</h2>
<div class="settings-group">
<div class="settings-item">
<div class="settings-item-inner"><div class="settings-item-left"><div class="settings-item-label">
You can also import an exported collection of dictionaries from the <a href="/settings.html#backup">Backup section of the Settings</a> page.
<br><br>
If you are migrating from Yomichan, you may be interested in importing your data into Yomitan.
Please follow instructions from <a href="https://yomitan.wiki/yomichan-migration/#migrating-from-yomichan" target="_blank" rel="noopener noreferrer">Yomitan Wiki</a> for that.
<br><br>
If you are using or planning to use custom templates for Anki note creation, note that <a href="https://yomitan.wiki/yomichan-migration/#custom-templates" target="_blank" rel="noopener noreferrer">some syntax has changed from Yomichan and Yomibaba.</a>
Please ensure that your custom templates are using the updated syntax.
</div></div></div>
</div>
</div>
<h2>Links</h2>
<div class="settings-group">
<a href="/welcome.html" rel="noopener" class="settings-item settings-item-button"><div class="settings-item-inner">
<div class="settings-item-left">
<div class="settings-item-label">Go to Welcome page</div>
</div>
<div class="settings-item-right open-panel-button-container">
<button type="button" class="icon-button"><span class="icon-button-inner"><span class="icon" data-icon="material-right-arrow"></span></span></button>
</div>
</div></a>
<a href="/info.html" rel="noopener" class="settings-item settings-item-button"><div class="settings-item-inner">
<div class="settings-item-left">
<div class="settings-item-label">Go to Info page</div>
</div>
<div class="settings-item-right open-panel-button-container">
<button type="button" class="icon-button"><span class="icon-button-inner"><span class="icon" data-icon="material-right-arrow"></span></span></button>
</div>
</div></a>
<a href="https://yomitan.wiki/" rel="noopener noreferrer" class="settings-item settings-item-button"><div class="settings-item-inner">
<div class="settings-item-left">
<div class="settings-item-label outer-link"><strong>New to Yomitan? Head to Yomitan Wiki!</strong></div>
</div>
<div class="settings-item-right open-panel-button-container">
<button type="button" class="icon-button"><span class="icon-button-inner"><span class="icon" data-icon="material-right-arrow"></span></span></button>
</div>
</div></a>
</div>
<div class="footer-padding"></div>
</div>
<div class="content-right"></div>
</div></div>
</body>
</html>