monokakido/README.md

monokakido.rs

A Rust library for parsing and interpreting the Monokakido dictionary format. Aiming for full test coverage and efficient implementation with minimal dependencies.

TODO:

• Add headline support
• Refactor as a workspace to separate the dependencies of the library and the binaries
• Move to mmap-based indexes
• Add graphics support
• Add TTY detection to CLI (prevent binary output to shell)
• Add proper argument parser lib to CLI
• Refine CLI according to the plan below
• Document the rsc, nrsc and keystore and headline formats

Test:

• Audio using "rsc" (CCCAD, WISDOM3)
• Audio using "nrsc" (DAIJISEN2, NHKACCENT2, OALD10, OLDAE, OLEX, OLT, RHEJ, SMK8)
• Multiple contents (WISDOM3, OLEX)

CLI　（Planned）

Tab-separated output formats:

• keyword
• headline
• iid (item id)
• pid (page id)
• aid (audio id)
• gid (graphics id)

\n\n separated output formats:

• item
• page

binary output formats:

• audio
• graphics

Planned to support:

• WISDOM3
• SMK8
• RHEJ
• OLT
• OLEX
• OLDAE
• OCD
• OALD10
• NHKACCENT2
• DAIJISEN2
• CCCAD