v0.1.2

This is the first stable version of dictutil. Everything has been tested manually, and dictutil now implements all features supported by Kobo. Dictgen is also complete, and the dictfile format is stable. The documentation here is finished (with the exception of infomation about word matching, which I haven't finished testing).

Dictutil is compatible with firmware versions 4.7.10364+ (December 2017). Images are supported on 4.20.14601+ (February 2020).

Features

dictutil:

• Full support for all Kobo dictionary features: HTML, images, multiple entries for a word, variants, word prefixes, and Unicode.
• Completely correct, tested, and documented word prefix calculation.
• Supports v2 dictionaries (see the docs for more info).
• All operations are lossless and deterministic.
• Can install and uninstall custom and built-in dictionaries.
• Can unpack and pack dictionaries.
• Can calculate prefixes for one or more words, with multiple output formats.

dictgen:

• Full support for all features from dictutil.
• Easy to use dictfile format.
• Can merge multiple dictionaries.
• Definitions can be written in Markdown or HTML.
• Images in multiple formats can be included.

examples/gotdict-convert:

• Full support for all features from GOTDict, with the exception of cross-references (which aren't supported by nickel).
• Can optionally include or exclude images.
• Can directly convert GOTDict without any manual intervention.
• Output is written to a dictfile (which makes it easy to modify).

examples/webster1913-convert:

• Parses and converts Project Gutenberg's Webster's 1913 Unabridged Dictionary to a dictfile.
• Will preserve multiple entries for a word.
• Will include all variants, tenses, and phrase definitions as variants for easy lookup.
• Over 113000 unique entries and
• Will preserve and format examples, etymology, pronunciation information, definition categories, and other features.
• Can export the parsed dictionary as JSON for further processing.
• Output is written to a dictfile (which makes it easy to modify).

Links

Binaries for the tools can be downloaded below. See the website for more detailed documentation, examples, and usage information.

Pre-built dictionaries from gotdict-convert and webster1913-convert can be downloaded from here:

• GOTDict (with images, firmware 4.20.14601+): dictzip (dicthtml-gt.zip), source dictfile (gotdict.df)
• GOTDict (without images): dictzip (dicthtml-gt.noimg.zip), source dictfile (gotdict.noimg.df)
• Webster's 1913 Dictionary: dictzip (dicthtml-wb.zip), source dictfile (webster1913.df)

API documentation for embedding dictutil as a library can be found on pkg.go.dev.

Note: This release replaces v0.1.0, which had an issue with 32-bit binaries on Windows (see #2) and v0.1.1, which had an issue with file permissions on Windows.