Go to file

Alex Yatskov b610c19a2f Updating README.md		2016-12-29 17:35:03 -08:00
bin	adding windows junk	2016-12-18 19:47:11 -08:00
common.go	auto detect dictionary format	2016-12-28 17:45:33 -08:00
daijirin.go	don't bother tagging daijirin entries	2016-12-27 18:38:06 -08:00
edict.go	auto detect dictionary format	2016-12-28 17:45:33 -08:00
enamdict.go	auto detect dictionary format	2016-12-28 17:45:33 -08:00
epwing.go	fixes for windoze	2016-12-29 11:04:48 -08:00
kanjidic.go	auto detect dictionary format	2016-12-28 17:45:33 -08:00
main.go	website link	2016-12-29 11:28:36 -08:00
README.md	Updating README.md	2016-12-29 17:35:03 -08:00

README.md

Yomichan-Import

Yomichan Import is a utility which allows users of the Yomichan Chrome extension to import custom dictionary files. It currently supports the following formats:

JMdict
JMnedict
KANJIDIC2

EPWING

  Daijirin (三省堂　スーパー大辞林)

Yomichan Import is currently being expanded to support other EPWING dictionaries based on user demand. This is a mostly non-technical and (although laborious) process that requires writing regular expressions and creating font tables; volunteer contributions are welcome.

Installation

Yomichan Import is currently available for Linux and Windows and can be downloaded in a single, combined archive. MacOS X executables will be released when I get access to Mac hardware (or somebody is nice enough to build Zero-EPWING binaries for me). The packaged executables do not require installation and do not modify your system whatsoever.

Usage

Yomichan Import is a simple command line application. When invoked without any arguments (or with --help), Yomichan Import will output usage instructions:

Usage: yomichan-import_linux [options] input-path [output-dir]
https://foosoft.net/projects/yomichan-import/

Parameters:
  -format string
    	dictionary format [edict|enamdict|kanjidic|epwing]
  -port int
    	port to serve dictionary JSON on (default 9876)
  -pretty
    	output prettified dictionary JSON
  -serve
    	serve dictionary JSON for extension
  -stride int
    	dictionary bank stride (default 10000)
  -title string
    	dictionary title

In the vast majority of cases it should sufficient to provide the path to the dictionary resource you wish to process, without explicitly specifying a format. Yomichan Import will attempt to automatically determine the format of the dictionary based on the contents of the path:

Format	Resource
edict	file named `JMDict_e.xml`
enamdict	file named `JMNedict.xml`
kanjidic	file named `kanjidic2.xml`
epwing	directory with file named `CATALOGS`

For example, if you wanted to process an EPWING dictionary titled Daijirin, you could do so with the following command (assuming that you are running the Linux executable):

$ ./yomichan-import_linux dict/Kokugo/Daijirin/

Yomichan Import will begin the conversion process, which can take a couple of minutes to complete:

2016/12/29 17:12:12 converting 'dict/Kokugo/Daijirin/' to '/tmp/yomichan_tmp_825860502' in 'epwing' format...

After the processing is complete, Yomichan Import will start a local HTTP server which enables the Yomichan Chrome extension to retrieve the dictionary data. Windows users will likely see a firewall nag dialog at this point; access must be allowed for the import process to complete:

2016/12/29 17:12:20 starting dictionary server on port 9876...

Finally, open the Yomichan Chrome options dialog and select the Local dictionary item in the dictionary importer drop-down menu. When you see that http://localhost:9876/index.json displayed in the address text-box, you can press the Import button to begin the import process. Once the imported dictionary is displayed on the options screen, it is safe to simply close the Yomichan Import tool.

License

MIT