From de7fcf1e3f2d5fcfe1263ac56bab127e9026787c Mon Sep 17 00:00:00 2001 From: wareya Date: Wed, 10 Apr 2019 17:06:54 -0400 Subject: [PATCH] update tutorial --- tutorial.md | 40 +++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/tutorial.md b/tutorial.md index 6dc386a..1ebaf5d 100644 --- a/tutorial.md +++ b/tutorial.md @@ -4,30 +4,24 @@ Install from [Mozilla's official Firefox addons website](https://addons.mozilla. # Settings -It's recommended to mess with the settings before using Nazeka for too long. The default settings are one-size-fits-all, but not actually very good for extensive reading. +Nazeka has many settings, and many of them only need to be changed if you run into personal problems with part of Nazeka's behavior. These are the ones that you're most likely to change. -![image: settings 1](https://i.imgur.com/EACEcsQ.png) +##Display -Recommendation: +Fixed width: Off by default. Enable if you're annoyed by the occasional narrow mouseover window, or by the mouseover window flipping when it changes width near the edge of the screen -- Set "Matching mode" to "All matches". If that makes Nazeka find too many results, use "Longest and second longest" instead. -- Make sure "Strict matching for alternative matches" is enabled so that the results list doesn't get filled with useless entries when you mouse over kana. -- Increase lookup throttle to something high like 50 or 100 (measured in thousandths of a second) if you have a very weak computer or an android device. +##Theme -![image: settings 2](https://i.imgur.com/TdpEqdB.png) +Background/foreground color: Light-on-dark by deafult, mild contrast. Change to a higher contrast color pair if your monitor has poor contrast. Or change to a dark-on-light color pair if you use a dim screen in a bright environment (light-on-dark is better otherwise). -Recommendation: +Highlight/reading color: Change to something easier to differentiate if you're fully colorblind. -- If the popup size is too small, increase "Lookup popup scale". -- The other defaults here are fine. You might want to enable "Fixed width" or "Position as though fixed width", or set "Popup positioning corner" to "Top right" if you read vertical text. The "bottom" positioning corners are inherently buggy because of limitations in how HTML and CSS define some overflow behavior stuff; they are only included for completeness. +Font overrides: Add your desired font or fonts. No trailing comma. They're prepended to the default font list. -![image: settings 3](https://i.imgur.com/BIT2o8Z.png) +## Behavior -Recommendation: +Enable live mining -- Enable the "Super border" if you have vision problems. -- Change the colors as desired. The default colors are very good for people with normal monitors and acceptable vision, but some people might want to make it dark-on-light instead of light-on-dark, or change the highlighting color. -- If you use a different operating system than Windows, you might want to add font overrides. # Using the reader/clipboard grabber @@ -43,16 +37,28 @@ Nazeka can be toggled from this page by right clicking the page and selecting th # Mining -Nazeka's mining support is extremely primitive and inflexible, and requires lots of user interaction. That said, Nazeka *does* technically support mining. +Nazeka supports both "storage" mining and "live" mining. + +Storage mining stores cards in Nazeka itself, and you need to transfer them into a flashcard program manually. + +Live mining communicates with Anikconnect while Anki is running so that cards are created without any interaction. + +## Configuring live mining + +If you want to use live mining, you need to install the Ankiconnect plugin for Anki, then configure live mining inside Nazeka. You can access the live mining configuration page either through the options menu or by right clicking Nazeka's toggle icon and selecting "Configure Live Mining". + +## Mining in general Press "m" while Nazeka's lookup popup is open to turn the popup into a mining UI. The mining UI moves to the top right corner of the screen. ![image: mining](https://i.imgur.com/z7Yjj1w.png) +## Storage mining + After clicking on the highlighted part of one of the entries, go back to a main browser window if you're in the Reader, then right click Nazeka's toggle icon again, and select "View Mined Cards". ![image: mined cards](https://i.imgur.com/bcERj3n.png) This shows a text field listing all the cards you've mined with Nazeka. Pressing "Reset" will clear Nazeka's memory of **all** mined cards. Don't do it unless you need to. -Each line in this list is tab-separated-fields. Spelling, tab, reading, tab, definition, tab, JMDict ID. This list can be imported into Anki, but you need to make a compatible deck. Nazeka doesn't have a formatting system yet, but whenever I add support for including the sentence you mined, it'll use a formatting system. +Each line in this list is tab-separated-fields. Spelling, tab, reading, tab, definition, tab, JMDict ID. This list can be imported into Anki, but you need to make a compatible deck.