WordnetJapanDiagram

Draw a diagram of Japanese WordNet about the hypernyms and hyponyms of the search word.

example: search プログラミング

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add wordnet_japan_diagram

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install wordnet_japan_diagram

Usage

1. Prepare Japanese WordNet SQLite3 file

Download Japanese WordNet SQLite3 file, unzip the file.

2. Execute the command using the above file

If the above file path is ./tmp/wnjpn.db, specify the path with --wordnet_japan_db_file_path option.

$ wordnet_japan_diagram --wordnet_japan_db_file_path ./tmp/wnjpn.db --search_word サウナ

# If you were using bundler
$ bundle exec wordnet_japan_diagram --wordnet_japan_db_file_path ./tmp/wnjpn.db --search_word サウナ

3. Check the diagram that is the result of the command execution

The diagram is located under the same path as the command execution.

The diagram name is wordnet_japan_diagram_[%Y%m%d%H%M%S].png.

※ If you want to specify the diagram path, use --output_diagram_path option.

4. As needed, use options for the command

$ wordnet_japan_diagram --help
Usage: wordnet_japan_diagram [-v]

Specific options:
        --wordnet_japan_db_file_path=text
                                     Sets wordnet japan db file path
                                     default: ./wnjpn.db
        --search_word=text           [Required] Sets japanese word to search
        --graph_rankdir=[TB|BT|LR|RL]Sets direction of graph layout
                                     default: BT
                                     TB: Top to bottom
                                     BT: Bottom to top
                                     LR: Left to right
                                     RL: Right to left
        --node_contents=[synset|synset_and_words]
                                     Sets node contents
                                     default: synset_and_words
        --height_from_target=number  Sets height from target node
        --depth_from_target=number   Sets depth from target node
        --output_diagram_path=text   Sets output diagram path (The file extension is either .pdf, .png, .jpg, or .svg)
                                     default: wordnet_japan_diagram_[%Y%m%d%H%M%S].png

Common options:
        --help                       Show this options information
    -v, --version                    Show version and quit.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wordnet_japan_diagram. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the WordnetJapanDiagram project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.