aboutsummaryrefslogtreecommitdiff
path: root/ext/bg
diff options
context:
space:
mode:
authorAlex Yatskov <alex@foosoft.net>2017-04-08 18:01:36 -0700
committerAlex Yatskov <alex@foosoft.net>2017-04-08 18:01:36 -0700
commitd263a93d446096abfc33e47f591dbb71eb7fe928 (patch)
treee01643ee126dce24b0f8baae00a40b01e50dbf94 /ext/bg
parenta551b0d462585e7420153c266435b214f134617f (diff)
usage guide
Diffstat (limited to 'ext/bg')
-rw-r--r--ext/bg/guide.html32
-rw-r--r--ext/bg/js/options.js2
-rw-r--r--ext/bg/js/util.js6
-rw-r--r--ext/bg/js/yomichan.js10
-rw-r--r--ext/bg/options.html4
5 files changed, 27 insertions, 27 deletions
diff --git a/ext/bg/guide.html b/ext/bg/guide.html
index 6c38e351..4b01ae7c 100644
--- a/ext/bg/guide.html
+++ b/ext/bg/guide.html
@@ -9,28 +9,24 @@
<body>
<div class="container">
<div class="page-header">
- <h1>Welcome to Yomichan!</h1>
+ <h1>Yomichan Usage Guide</h1>
</div>
- <p>Thank you for downloading this extension! I hope that Yomichan will help you on your language learning journey.</p>
+ <p>
+ Read the steps below to get up and running with Yomichan. For complete documentation,
+ visit the <a href="https://foosoft.net/projects/yomichan/" target="_blank">official homepage</a>.
+ </p>
- <div>
- <h2>Quick Guide</h2>
+ <ol>
+ <li>Click on the <img src="/mixed/img/icon16.png" alt> icon in the browser toolbar to open the Yomichan actions dialog.</li>
+ <li>Click on the <em>monkey wrench</em> icon in the middle to open the options page.</li>
+ <li>Import the dictionaries you wish to use for term and Kanji searches.</li>
+ <li>Hold down <kbd>Shift</kbd> key or the middle mouse button as you move your mouse over text to display definitions.</li>
+ <li>Click on the <img src="/mixed/img/play-audio.png" alt> icon to hear the term pronounced by a native speaker.</li>
+ <li>Click on individual Kanji in the term definition results to view additional information about those characters.</li>
+ </ol>
- <p>
- Read the steps below to get up and running with Yomichan. For complete documentation,
- visit the <a href="https://foosoft.net/projects/yomichan/" target="_blank">official homepage</a>.
- </p>
-
- <ol>
- <li>Click on the <img src="/mixed/img/icon16.png" alt> icon in the browser toolbar to open the Yomichan actions dialog.</li>
- <li>Click on the <em>monkey wrench</em> icon in the middle to open the options page.</li>
- <li>Import the dictionaries you wish to use for term and Kanji searches.</li>
- <li>Hold down <kbd>Shift</kbd> key or the middle mouse button as you move your mouse over text to display definitions.</li>
- <li>Click on the <img src="/mixed/img/play-audio.png" alt> icon to hear the term pronounced by a native speaker.</li>
- <li>Click on individual Kanji in the term definition results to view additional information about those characters.</li>
- </ol>
- </div>
+ <p>This startup notification can be turned off on the Yomichan options page.</p>
</div>
</body>
</html>
diff --git a/ext/bg/js/options.js b/ext/bg/js/options.js
index 51f242c2..49544840 100644
--- a/ext/bg/js/options.js
+++ b/ext/bg/js/options.js
@@ -25,6 +25,7 @@ function formRead() {
return optionsLoad().then(optionsOld => {
const optionsNew = $.extend(true, {}, optionsOld);
+ optionsNew.general.showGuide = $('#show-usage-guide').prop('checked');
optionsNew.general.audioSource = $('#audio-playback-source').val();
optionsNew.general.audioVolume = $('#audio-playback-volume').val();
optionsNew.general.groupResults = $('#group-terms-results').prop('checked');
@@ -111,6 +112,7 @@ $(document).ready(() => {
handlebarsRegister();
optionsLoad().then(options => {
+ $('#show-usage-guide').prop('checked', options.general.showGuide);
$('#audio-playback-source').val(options.general.audioSource);
$('#audio-playback-volume').val(options.general.audioVolume);
$('#group-terms-results').prop('checked', options.general.groupResults);
diff --git a/ext/bg/js/util.js b/ext/bg/js/util.js
index 05c7ff27..64143ffe 100644
--- a/ext/bg/js/util.js
+++ b/ext/bg/js/util.js
@@ -89,7 +89,8 @@ function optionsSetDefaults(options) {
showAdvanced: false,
popupWidth: 400,
popupHeight: 250,
- popupOffset: 10
+ popupOffset: 10,
+ showGuide: true
},
scanning: {
@@ -144,6 +145,9 @@ function optionsVersion(options) {
} else {
options.general.audioSource = 'disabled';
}
+ },
+ () => {
+ options.general.showGuide = false;
}
];
diff --git a/ext/bg/js/yomichan.js b/ext/bg/js/yomichan.js
index feb74b6e..51e05c80 100644
--- a/ext/bg/js/yomichan.js
+++ b/ext/bg/js/yomichan.js
@@ -28,8 +28,8 @@ window.yomichan = new class {
this.translator.prepare().then(optionsLoad).then(this.optionsSet.bind(this)).then(() => {
chrome.commands.onCommand.addListener(this.onCommand.bind(this));
chrome.runtime.onMessage.addListener(this.onMessage.bind(this));
- if (chrome.runtime.onInstalled) {
- chrome.runtime.onInstalled.addListener(this.onInstalled.bind(this));
+ if (this.options.general.showGuide) {
+ chrome.tabs.create({url: chrome.extension.getURL('/bg/guide.html')});
}
});
}
@@ -157,12 +157,6 @@ window.yomichan = new class {
return Promise.resolve(handlebarsRender(template, data));
}
- onInstalled(details) {
- if (details.reason === 'install') {
- chrome.tabs.create({url: chrome.extension.getURL('/bg/guide.html')});
- }
- }
-
onCommand(command) {
const handlers = {
search: () => {
diff --git a/ext/bg/options.html b/ext/bg/options.html
index 0e73178a..e6c5e8be 100644
--- a/ext/bg/options.html
+++ b/ext/bg/options.html
@@ -26,6 +26,10 @@
<h3>General Options</h3>
<div class="checkbox">
+ <label><input type="checkbox" id="show-usage-guide"> Show usage guide on startup</label>
+ </div>
+
+ <div class="checkbox">
<label><input type="checkbox" id="group-terms-results"> Group term results</label>
</div>