alex/yomichan-import
1
Fork 0
Code Releases Activity
101 Commits 1 Branch 0 Tags 2.7 MiB
Go 99.2%
Shell 0.8%
f4a2883f00
Go to file
Alex Yatskov f4a2883f00 Updating README.md
2017-01-02 15:29:52 -08:00
bin adding interactive mode for command line newbs 2017-01-01 12:53:39 -08:00
zero-epwing@82158b0104 adding interactive mode for command line newbs 2017-01-01 12:53:39 -08:00
.gitignore re-implement interactive mode as a simple batch file wrapper 2017-01-02 15:14:09 -08:00
.gitmodules adding interactive mode for command line newbs 2017-01-01 12:53:39 -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
dict add gitignore 2017-01-02 15:00:47 -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 output stderr from execution of zero-epwing 2016-12-31 15:05:35 -08:00
kanjidic.go auto detect dictionary format 2016-12-28 17:45:33 -08:00
main.go re-implement interactive mode as a simple batch file wrapper 2017-01-02 15:14:09 -08:00
package.sh re-implement interactive mode as a simple batch file wrapper 2017-01-02 15:14:09 -08:00
README.md Updating README.md 2017-01-02 15:29:52 -08:00
yomichan-import.bat re-implement interactive mode as a simple batch file wrapper 2017-01-02 15:14:09 -08:00

README.md

Yomichan-Import

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

Yomichan Import is 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 Windows and Linux; MacOS X executables will be released at a later date.

Usage

Yomichan Import is a simple command line application. If you are a Windows user and are not comfortable using the terminal to input commands, you can use the provided yomichan-import.bat batch file instead of the yomichan-import.exe executable to run the application in interactive mode.

When invoked without any arguments (or executed with --help), the application will output usage instructions:

Usage: yomichan-import [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 is enough to simply 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 (shown on Linux):

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

Yomichan Import will now 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 dictionary processing is complete, the tool will start a local web server to enable the Yomichan extension to retrieve dictionary data. Users of Windows will likely see a firewall nag dialog at this point; you must grant network access in order to make the converted dictionary data accessible to the extension.

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

As a final step, open the Yomichan for Chrome options dialog and choose 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 terminate the Yomichan Import tool.

License

MIT