kokodoko / gogo-nihongo Goto Github PK

A chrome extension that replaces English words with the first basic kanji or kana characters from your study book.

JavaScript 77.68% CSS 11.24% HTML 11.08%

gogo-nihongo's Introduction

Go Go Nihongo

A chrome extension that replaces English words with the first basic kanji or kana characters from your study book. The extension replaces words mentioned in the file words.csv with kanji.

Running in the browser

Download this repository.
Open the Chrome extensions page, enable developer mode
Click "Load Unpacked" and choose the folder you just downloaded

Edit the CSV file

You can edit or replace the words.csv file
The first row has column names, and will be ignored by the extension
A word list starts with a row with the list title (ex. "JLPT4")
Followed by rows that contain at least a column for english and one for the kanji.

Edit the style files

popup.html has the layout and css for the little popup window
style.css has the styles that show kanji and a tooltip in all html pages

After editing, upgrade the version number in the manifest.json file, this should automatically update the extension in chrome.

Scripts

The extension has three scripts that run in their own context:

Background.js - this is the extension script that loads and saves user preferences, and tells the DOM to start translating.
Popup.js - this is the script for the small popup menu. The script will send changes in user preferences to background.js
Main.js - this is the DOM script that gets inserted in all HTML pages that the user visits. This script parses the DOM content and replaces it with kanji from the csv file.

Communication between these three files is done via sendMessage and addListener.

Chrome Extension Documentation