wwwjdic 14.0.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 380e8ad232928dd7bfec1d0fc723cba15663e6e78448ac496ca6e8866c2a6eee
-  data.tar.gz: 60a0c44422d1782c80517a9b2f56ea23e395421a82a29ea8728c7cca08d2a2e1
+  metadata.gz: 621d43cda4b5e0a3dbdeee2aee5d6695052b4217740deffb1aa8d68dbd05d658
+  data.tar.gz: 97387f0af759186c8b320f6ee79110835e1ae73c95b8c51aab253808133f80c8
 SHA512:
-  metadata.gz: c0cc6224665ee383e667468d1a46c662a8d2fa8d9ebf9087134bd5d7ee884b62da536c80b5eac4a7d602184a84f0afc3be466ee1486f0ee13d0b2277f553391d
-  data.tar.gz: 1f30a13011f45c5f86d52977aab49135309c431fa0a4a243d2525605f9547ff353029e5ab57eef295da20b2bb7297ebaa1c6a462e20a0471b46e2d0d5df244ca
+  metadata.gz: e4be9a4e1cf0353ff2ec82d750b3b691bd1ff9f380afa47790fe5e1684dfb80a509a21d51c1ec08c6d25e83877b7c85b483e918dc986a2c77b4d1e091d426f1a
+  data.tar.gz: b3e10bfaee20de01ea13eccbd60f758ef61ac9ed701e5a3ac69b268bafb3fd46447989d8be90511600ab925d4e620704a8b089f815c4d72bf1f689f1e9d50ef6

data/CHANGELOG

@@ -1,3 +1,22 @@
+= Version 15.0.0
+  * MAJOR changed key search type default from "exact" to "english".
+  * MAJOR changed Monash dictionary server reference URL.
+  * MINOR introduce compliance to REUSE tool from FSF Europe
+  * MINOR add dependency to Rubocop
+  * PATCH update copyright notices
+  * PATCH remove test data form I18N files.
+  * PATCH update gem dependencies.
+  * PATCH update IntelliJ IDEA (RubyGem) project configuration.
+  * PATCH update to Ruby 2.7.x new things
+  * IN PROGRESS: restoring key configuration as allowed parameter, to
+    allow user asking for specific searches. Search key currently fixed
+    to 'E' (exact match) type search.
+  * IN PROGRESS: improving application RDoc to better comply with SemVer
+    point 1 (Software using Semantic Versioning MUST declare a public
+    API. This API could be declared in the code itself or exist strictly
+    in documentation. However it is done, it should be precise and
+    comprehensive.)
+
 = Version 14.0.0
   * MAJOR update from Ruby '~> 2.6' to Ruby '~> 2.7'.
   * MINOR update IntelliJ IDEA (RubyGem) project configuration.

data/Gemfile

@@ -1,5 +1,5 @@
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# © 2014 Marco Bresciani
 #
 # This file is part of wwwjdic.
 #
@@ -15,6 +15,10 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2014 Marco Bresciani
+#
+# SPDX-<span></span>License-Identifier: FSFAP
 
 source 'https://rubygems.org'
 

data/README.md

@@ -1,7 +1,7 @@
 <!--
 wwwjdic
 
-Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+(C) 2014 Marco Bresciani
 
 This file is part of wwwjdic.
 
@@ -17,114 +17,90 @@ more details.
 
 You should have received a copy of the GNU General Public License along
 with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
--->
 
+SPDX-FileCopyrightText: 2014 Marco Bresciani
+
+SPDX-License-Identifier: GFDL-1.3-or-later
+-->
 # WWWJDic
-![Gem](https://img.shields.io/gem/v/wwwjdic.svg?style=plastic)
-![Gem](https://img.shields.io/gem/dt/wwwjdic.svg?style=plastic)
-![Gem](https://img.shields.io/gem/dtv/wwwjdic.svg?style=plastic)
+![name](https://badgen.net/rubygems/n/wwwjdic)
+![platform](https://badgen.net/rubygems/p/wwwjdic)
+![version (stable)](https://badgen.net/rubygems/v/wwwjdic)
+![version (latest)](https://badgen.net/rubygems/v/wwwjdic/latest)
+![total downloads](https://badgen.net/rubygems/dt/wwwjdic)
+![latest version downloads](https://badgen.net/rubygems/dv/wwwjdic)
+
 ![Gem download rank](https://img.shields.io/gem/rt/wwwjdic.svg?style=plastic)
 ![Gem download rank (daily)](https://img.shields.io/gem/rd/wwwjdic.svg?style=plastic)
 ![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/rubygems/wwwjdic.svg?style=plastic)
+![Gems](https://img.shields.io/gem/u/MarcoBresciani?style=plastic)
 
-Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+![Security Headers](https://img.shields.io/security-headers?style=plastic&url=https%3A%2F%2Fsavannah.nongnu.org%2Fprojects%2Faamfp)
+![Chromium HSTS preload](https://img.shields.io/hsts/preload/savannah.nongnu.org?style=plastic)
+![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade/savannah.nongnu.org?publish&style=plastic)
+![Website](https://img.shields.io/website?style=plastic&url=https%3A%2F%2Fsavannah.nongnu.org%2Fprojects%2Faamfp)
 
-This file is part of wwwjdic.
-
-wwwjdic is free software: you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free
-Software Foundation, either version 3 of the License, or (at your
-option) any later version.
-
-wwwjdic is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
-more details.
+[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=plastic)](https://github.com/RichardLitt/standard-readme)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rubystyle.guide)
+[![REUSE status](https://api.reuse.software/badge/git.fsfe.org/reuse/api)](https://api.reuse.software/info/git.fsfe.org/reuse/api)
 
-You should have received a copy of the GNU General Public License along
-with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+This gem uses WWWJDic Backdoor Entry/API to interact with WWWJDic and
+translate to and from Japanese language.
 
-## Description
 This gem uses WWWJDic Backdoor Entry/API as described by
-http://www.csse.monash.edu.au/~jwb/wwwjdicinf.html#backdoor_tag to
-interact with WWWJDic and translate to and from Japanese language.
+http://www.edrdg.org/wwwjdic/wwwjdicinf.html#backdoor_tag to interact
+with WWWJDic and translate to and from Japanese language.
+WWWJDic is an online Japanese translation server made by Jim Breen and
+available at http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic?1C.
+GNU GPLv3 license; source code available through anonymous checkout:
+`hg clone http://hg.savannah.nongnu.org/hgweb/wwwjdic/` or write me, and
+I'll send it.
+You can even decide to contribute to this little free software project
+by registering to Savannah and ask to be part of the `wwwjdic` project!
+
+## Table of Contents
+* [Background](#background)
+* [Install](#install)
+  * [Savannah](#savannah)
+  * [RubyGems](#rubygems)
+* [Usage](#usage)
+* [Maintainers](#maintainers)
+* [Thanks](#thanks)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Background
+This gem uses WWWJDic Backdoor Entry/API as described by
+http://www.edrdg.org/wwwjdic/wwwjdicinf.html#backdoor_tag to interact
+with WWWJDic and translate to and from Japanese language.
 
 WWWJDic is an online Japanese translation server made by Jim Breen and
-available at http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic?1C .
+available at http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic?1C.
+
+Jim Breen's Japanese Page lists this gem:
+http://nihongo.monash.edu/japanese.html#links_software
 
 GNU GPLv3 license; source code available through anonymous checkout:
-`hg clone http://hg.savannah.nongnu.org/hgweb/wwwjdic/` or write me and
+`hg clone http://hg.savannah.nongnu.org/hgweb/wwwjdic/` or write me, and
 I'll send it.
 
 You can even decide to contribute to this little free software project
-by registering to Savannah and ask to be part of the 'WWWJDic' project!
+by registering to Savannah and ask to be part of the `wwwjdic` project!
 
 With great contributions from: Jim Breen, 新部裕, Jon Maken.
 
-## Documentation
-WWWJDic tries to follow semantic versioning (see <http://semver.org/>).
-There may be backward incompatible changes each time minor version
-number changes, but that any tiny version number change should be bug
-fixes and internal changes only.
-Be sure to read the CHANGELOG each time we cut a new release and lock
-your gems accordingly.
-
-RDoc documentation available in the html folder.
-
-### Installing WWWJDic
+## Install
 RubyGems is the preferred easy install method for WWWJDic.
-WWWJDic is intended to be installed via the
+WWWJDic should be installed via the
 [RubyGems](http://rubyforge.org/projects/rubygems/) system.
 To get the latest version, simply enter the following into your command
 prompt: `gem install wwwjdic`.
 
-### Supported Ruby Versions and Implementations
 Because WWWJDic is pure Ruby, it should run pretty much anywhere,
 including Rubinius, JRuby, MacRuby, etc.
 Officially the support is for \>= 2.7 YARV/KRI.
 
-### Support
-The easiest way to get help with WWWJDic is to post a message to the
-mailing list: `http://lists.nongnu.org/mailman/listinfo/wwwjdic-users`
-
-Feel free to post any question there, developers are responsive and will
-be happy to help you figure out how to use WWWJDic, or help you
-determine whether it's the right tool for the task you are working on.
-
-Please make your posts to the list as specific as possible, including
-code samples and output where relevant.
-Do not post any information that should not be shared publicly, and be
-sure to reduce your example code as much as possible so that those who
-are responding to your question can more easily see what the issue might
-be.
-
-### Contributing
-If you've found a bug, want to submit a patch, or have a feature
-request, please enter a ticket into our bug tracker:
-`https://savannah.nongnu.org/bugs/?func=additem&group=wwwjdic`
-
-We strongly encourage bug reports to come with failing tests or at least
-a reduced example that demonstrates the problem.
-
-Similarly, patches should include tests, API documentation, and an
-update to the manual where relevant.
-Feel free to clone early though and participate in the project, if you
-just want some feedback or a code review before preparing your code to
-be merged.
-
-If you are unsure about whether or not you've found a bug, or want to
-check to see whether we'd be interested in the feature you want to add
-before you start working on it, feel free to post to our mailing list.
-
-### License
-WWWJDic is released under GNU GPL v3 license: if you wish to contribute
-to WWWJDic, you will retain your own copyright but must agree to license
-your code under the same terms as the project itself (or any compatible
-license according to [GPL-Compatible Free Software
-Licenses](http://www.gnu.org/licenses/license-list.en.html#GPLCompatibleLicenses)).
-
-### Links
-
 #### Savannah
 * Project page: <https://savannah.nongnu.org/projects/wwwjdic/>
 * Source code (Mercurial) repository: <http://hg.savannah.gnu.org/hgweb/wwwjdic/>
@@ -138,139 +114,369 @@ Licenses](http://www.gnu.org/licenses/license-list.en.html#GPLCompatibleLicenses
 * Gem updates Atom Feed:
 <https://rubygems.org/gems/wwwjdic/versions.atom>
 
-#### Other links
-* WWWJDic: http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic?1C .
-* Jim Breen's Japanese Page: http://nihongo.monash.edu/japanese.html#links_software
-* "An HTTP/HTTPS/FTP file downloader library/CLI based upon
-  MiniPortile's HTTP implementation." gist by Jon Maken:
-  <https://gist.github.com/jonforums/2202048>.
-
-### Usage Examples
+## Usage
 See `examples` folder.
-To run the examples just run `ruby examples/`{EXAMPLE_NAME}`.rb`.
+To run the examples just run `ruby `{EXAMPLE_NAME}`.rb`.
 Running the examples you'll see both the example description and correct
 code usage to perform such action.
-Here below are listed the currently available examples:
+Here below there are the currently available examples:
 * The `basics.rb` example (run `ruby examples/basics.rb`) shows how to
   initialize and use a WWWJDic object through the `breener` factory
   method;
 * The `uri.rb` example (run `ruby examples/uri.rb`) shows how to ask for
-  translation URI at WWWJDic, with all available options and
-  configurations.
+  different types of translation URIs at WWWJDic, with all available
+  options and configurations.
 * The `translate.rb` example (run `ruby examples/translate.rb`) shows
   how to ask for an actual translation through WWWJDic Backdoor/API,
   with all available options and configurations.
   It will also show how to download such translation;
 
 Using this API is pretty simple.
-First, get a reference to the WWWJDic object, through its factory method
-with
-
-    my_wwwjdic = WWWJDic::breener
-
+First, remember that this API maintains a context, so you can save your
+preferred configuration of server, dictionary, output formats, ... by
+assigning those value to your object.
+Get a reference to the WWWJDic object, through its factory method, with
+`my_wwwjdic = WWWJDic::breener`.
 This will save a WWWJDic instance in your `my_wwwjdic` object.
-
-#### Parameters
-You can then start possibly manipulating some basic parameters that can
-be set and read from the API.
-These are not mandatory settings, but are useful whether you'll use your
-`my_wwwjdic` object for further similar requests: settings these values
-internally will save you type more parameters in the request, leaving
-only the word to search/translate as
-needed.
-* the `server` name/URL to use:
-
-        my_wwwjdic.server    # returns the default server URL http://www.csse.monash.edu.au/~jwb/cgi-bin/wwwjdic.cgi?
-        my_wwwjdic.to_s      # contains the URL above
-
-        # this below is (again) the default configured server
-        my_wwwjdic.server = :edrdg
-        my_wwwjdic.server    # returns the URL http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic.cgi?
-        my_wwwjdic.to_s      # contains the URL above
-
-        # this is the additional server
-        my_wwwjdic.server = :monash
-        my_wwwjdic.server    # returns the URL http://www.csse.monash.edu.au/~jwb/cgi-bin/wwwjdic.cgi?
-        my_wwwjdic.to_s      # contains the URL above
-* the default reference `dictionary` to use for translations.
-  All currently available dictionaries strings can be used: `'1'`,
-  `'2'`, `'3'`, `'4'`, `'5'`, `'6'`, `'7'`, `'8'`, `'9'`, `'A'`, `'B'`,
-  `'C'`, `'D'`, `'E'`, `'F'`, `'G'`, `'H'`, `'I'`, `'J'`, `'K'`, `'L'`,
-  `'M'`, `'N'`, `'O'`, `'P'`, `'Q'` and `'R'`.
-You can even use the whole (exact) dictionary strings as listed in the
-WWWJDic HTML source code: `'Jpn-Eng General (EDICT)'`,
-`'Japanese Names (ENAMDICT)'`, `'Computing/Telecomms'`,
-`'Life Sciences/Bio-Med'`, `'Legal Terms'`, `'Finance/Marketing'`,
-`'Buddhism'`, `'Miscellaneous'`, `'Special Text-glossing'`,
-`'Engineering/Science'`, `'Linguistics'`, `'River & Water Systems'`,
-`'Automobile Industry'`, `'Japanese Wordnet'`,
-`'Work-in-progress File'`, `'Japanese-German (WaDoku)'`,
-`'Japanese-French'`, `'Japanese-Russian'`, `'Japanese-Swedish'`,
-`'Japanese-Hungarian'`, `'Japanese-Spanish'`, `'Japanese-Dutch'`,
-`'Japanese-Slovenian'`, `'Japanese-Italian'`, `'Untranslated'`,
-`'Combined Jpn-Eng'`, `'Expanded Text-glossing'`.
-
-        my_wwwjdic.dictionary    # returns 0 as default, if not set
-
-        my_wwwjdic.dictionary = '7'
-        my_wwwjdic.dictionary    # returns the string '7'
-* Then you can obviously ask for a translation reference URL.
-  Basic examples:
-
-        my_wwwjdic.uri 'word'    # this return the URL for translation of 'word', with normal display format
-
-        my_wwwjdic.raw_uri 'word'    # this return the URL for translation of 'word', with raw display format
-
-        my_wwwjdic.json_uri 'word'    # this return the URL for translation of 'word', returning a JSON data as { 'word': 'url' } with normal display format
-* Then, instead of the pure URL to reference the WWWJDic site, you can
-  retrieve the actual translation itself or save it to a file:
-
-        my_wwwjdic.translate 'word'    # returns a string containing the web page content of the raw display format
-
-        my_wwwjdic.translate 'word', nil, filename    # regardless the nil (see it later) the third parameter is the filename where to save the retrieved translation
-* Another possible result for translation is to get it in JSON format
-  also with the possibility to save it in a file.
-
-        my_wwwjdic.json_translate 'word'    # returns the JSON format of the translation.
-
-    For this, the resulting JSON format will be:
-
+At this point the object does contain a default configuration in terms
+of dictionary, server, ...
+
+You can take a look at the current status/configuration of your
+`my_wwwjdic` object using the `dictionary` method
+`my_wwwjdic.dictionary` that shows the dictionary currently in use
+(default is `Jpn-Eng General (EDICT)`), or using the `server` method
+`my_wwwjdic.server` that shows the dictionary server currently in use
+(default is `http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic.cgi?`).
+
+* `dictionary`: you can set your own dictionary through the same
+  `dictionary` method, by assigning it one of the available
+  dictionaries, either using the dictionary number, or the (exact)
+  dictionary name.
+
+  | Number |       Dictionary Name     |
+  |:------:|---------------------------|
+  |    1   |  Jpn-Eng General (EDICT)  |
+  |    2   | Japanese Names (ENAMDICT) |
+  |    3   |    Computing/Telecomms    |
+  |    4   |   Life Sciences/Bio-Med   |
+  |    5   |        Legal Terms        |
+  |    6   |     Finance/Marketing     |
+  |    7   |          Buddhism         |
+  |    8   |       Miscellaneous       |
+  |    9   |   Special Text-glossing   |
+  |    A   |    Engineering/Science    |
+  |    B   |        Linguistics        |
+  |    C   |   River & Water Systems   |
+  |    D   |    Automobile Industry    |
+  |    E   |      Japanese Wordnet     |
+  |    F   |   Work-in-progress File   |
+  |    G   |  Japanese-German (WaDoku) |
+  |    H   |      Japanese-French      |
+  |    I   |      Japanese-Russian     |
+  |    J   |      Japanese-Swedish     |
+  |    K   |     Japanese-Hungarian    |
+  |    L   |      Japanese-Spanish     |
+  |    M   |       Japanese-Dutch      |
+  |    N   |     Japanese-Slovenian    |
+  |    O   |      Japanese-Italian     |
+  |    P   |        Untranslated       |
+  |    Q   |      Combined Jpn-Eng     |
+  |    R   |   Expanded Text-glossing  |
+
+  For example, with `my_wwwjdic.dictionary = '7'` you set the `Buddhism`
+  dictionary or with `my_wwwjdic.dictionary = 'Japanese Wordnet'` you
+  just set the `Japanese Wordnet` one.
+  Your `my_wwwjdic` object saves and maintains these values unless
+  reset.
+* `server`: you can set your own server through the same `server`
+  method, by assigning it one of the available servers.
+  Using `my_wwwjdic.server = :edrdg` the library will use the main
+  (default) URL at <http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic.cgi?>
+  for the dictionary server while instead using
+  `my_wwwjdic.server = :monash` will use the URL
+  <http://nihongo.monash.edu/cgi-bin/wwwjdic?> that relays on Monash
+  University mirror.
+* `uri`: you can ask for a translation reference URL; that is not a
+  translation by itself, but it's the full URL where to find the
+  translation.
+  * You can get the translation URL of a specific word using the command
+    `my_wwwjdic.uri '`word`'` that returns the normal URL.
+  * Then you can use the `my_wwwjdic.raw_uri '`word`'`, for the raw
+    display format.
+    The raw dictionary display option is useful for calls from other
+    programs, smartphones, etc.
+    It omits all header and footer information from the pages, and
+    displays the unedited dictionary entries in EDICT and KANJIDIC
+    format, one-per-line and encapsulated by <pre> ... </pre>.
+    In this option the output is always in UTF-8 coding.
+  * the `my_wwwjdic.json_uri '`word`'` command, instead, returns the URL
+    for translation of `word` in a JSON format as `{ "`word`: "`url`" }`
+    with normal display format.
+* `translate`: you can, finaly, obviously ask for a specific translation
+  using the configured parameters.
+  * you can get a simple translation with the command
+    `my_wwwjdic.translate 'word'`, that returns a string containing the
+    web page content of the translation of `word` in the raw display
+    format.
+    It's equivalent to `my_wwwjdic.translate 'word', display: :raw`.
+  * `my_wwwjdic.translate 'word', nil, filename`, regardless the `nil`
+    (see it later), the third `filename` parameter is the name of the
+    file where the translation will be saved into.
+    Specifying this `filename` parameter, the translation will not be
+    shown, but it will be saved in the specified file.
+  * Another possible result for translation is to get it in JSON format
+    also with the possibility to save it in a file:
+    `my_wwwjdic.json_translate 'word'`, returns the JSON format of the
+    translation:
+    * The JSON will contain a field having the same name of the word to
+      be translated that contains the URL of the translation from the
+      reference dictionary server used.
+      The URL is exatcly the same used to retrieve the translation and
+      filling the resulting JSON.
+    * The `title` field will contain the title of the translation page
+      result.
+    * The `translation` field will contain the raw translation as
+      received from the server.
+    * The `message` field will contain all the text that will possibly
+      be included as error message in the translation.
+      This means that if any `<p>` tag encloses some text, such text
+      will be presented in this `message` field.
+    * The `lines` field will contain an array of all the lines of the
+      translation, that is: the `lines` field contains a split of the
+      `translation` field using its existing `\n` characters.
+    * The `content` field contains an array of JSON objects, each
+      containing the formatted translation of each line:
+      * a field with the name of the word asked for translation,
+        containing the actual translation, first field of the
+        translation in each line;
+      * a `kana` field with the kana writing for the translation, as
+        shown in brackets, in each line;
+      * a `text` field containing the explanation associated to such
+        translation;
+      * a `meanings` field containing the different meaning associated
+        to each line.
+        The `/` characters mark the splitting point for each line.
+
+    So, basically, the JSON will contain the whole raw translation, the
+    same translation split into different lines, when asked by the
+    translation itself, and each of those lines above split again into a
+    set of available meanings.
+
+    For the example translation above, the resulting JSON format is:
+    ```json5
+    {
+      "word": "http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic.cgi?1ZDQword",
+      "title": "WWWJDIC: Word Display",
+      "translation": "伝言 [つてこと] /(n) (1) (See 伝言・でんごん) verbal message/word (from someone)/(n) (2) rumour/rumor/\n伝言 [でんごん] /(n,vs) verbal message/word (from someone)/(P)/\n一議 [いちぎ] /(n) word (opinion, objection)/\n言の葉 [ことのは;ことのえ] /(n) (1) (arch) word/(n) (2) (See 和歌) waka (classic Japanese poem, esp. a tanka)/\nワード /(n) (1) word/(n) (2) {comp} word/(n) (3) {comp} Word/Microsoft Word/(P)/\n語 [ご] /(n,n-suf) (1) language/(n,n-suf,ctr) (2) word/(P)/\n単語 [たんご] /(n,adj-no) {ling} word/vocabulary/(usually) single-character word/(P)/\n訪れ [おとずれ] /(n) (1) visit/call/(n) (2) arrival (e.g. of spring)/advent/coming/appearance/(n) (3) news/tidings/word/(P)/\n音沙汰;音さた [おとさた] /(n) news (from someone)/word/contact/\n言 [げん(P);こと] /(n) word/remark/statement/(P)/\n知らせ(P);報せ [しらせ] /(n) (1) (See お知らせ) news/word/tidings/notice/notification/information/(n) (2) omen/(P)/\n言葉(P);詞;辞 [ことば(P);けとば(言葉)(ok)] /(n) (1) (See 言語) language/dialect/(n) (2) (See 単語) word/words/phrase/term/expression/remark/(n) (3) speech/(manner of) speaking/(n) (4) learning to speak/language acquisition/(P)/",
+      "message": null,
+      "lines": [
+        "伝言 [つてこと] /(n) (1) (See 伝言・でんごん) verbal message/word (from someone)/(n) (2) rumour/rumor/",
+        "伝言 [でんごん] /(n,vs) verbal message/word (from someone)/(P)/",
+        "一議 [いちぎ] /(n) word (opinion, objection)/",
+        "言の葉 [ことのは;ことのえ] /(n) (1) (arch) word/(n) (2) (See 和歌) waka (classic Japanese poem, esp. a tanka)/",
+        "ワード /(n) (1) word/(n) (2) {comp} word/(n) (3) {comp} Word/Microsoft Word/(P)/",
+        "語 [ご] /(n,n-suf) (1) language/(n,n-suf,ctr) (2) word/(P)/",
+        "単語 [たんご] /(n,adj-no) {ling} word/vocabulary/(usually) single-character word/(P)/",
+        "訪れ [おとずれ] /(n) (1) visit/call/(n) (2) arrival (e.g. of spring)/advent/coming/appearance/(n) (3) news/tidings/word/(P)/",
+        "音沙汰;音さた [おとさた] /(n) news (from someone)/word/contact/",
+        "言 [げん(P);こと] /(n) word/remark/statement/(P)/",
+        "知らせ(P);報せ [しらせ] /(n) (1) (See お知らせ) news/word/tidings/notice/notification/information/(n) (2) omen/(P)/",
+        "言葉(P);詞;辞 [ことば(P);けとば(言葉)(ok)] /(n) (1) (See 言語) language/dialect/(n) (2) (See 単語) word/words/phrase/term/expression/remark/(n) (3) speech/(manner of) speaking/(n) (4) learning to speak/language acquisition/(P)/"
+      ],
+      "content": [
+        {
+          "word": "伝言",
+          "kana": "つてこと",
+          "text": "(n)(1) (See 伝言・でんごん) verbal message/word (from someone)/(n) (2) rumour/rumor",
+          "meanings": [
+            "(n) (1) (See 伝言・でんごん) verbal message",
+            "word (from someone)",
+            "(n) (2) rumour",
+            "rumor"
+          ]
+        },
+        {
+          "word": "伝言",
+          "kana": "でんごん",
+          "text": "(n,vs) verbal message/word (from someone)/(P)",
+          "meanings": [
+            "(n,vs) verbal message",
+            "word (from someone)",
+            "(P)"
+          ]
+        },
         {
-          word : translation uri for raw display format
-          'title' : title (extracted from <br>TITLE<br> tags in raw display format)
-          'translation' : translation content (extracted from <pre>TRANSLATION</pre> raw display format
-          'message' : possible error message or result (extracted from <p>MESSAGE\n raw display format
+          "word": "一議",
+          "kana": "いちぎ",
+          "text": "(n) word (opinion, objection)"
+        },
+        {
+          "word": "言の葉",
+          "kana": "ことのは;ことのえ",
+          "text": "(n) (1) (arch) word/(n) (2) (See 和歌) waka (classic Japanese poem, esp. a tanka)",
+          "meanings": [
+            "(n) (1) (arch) word",
+            "(n) (2) (See 和歌) waka (classic Japanese poem, esp. a tanka)"
+          ]
+        },
+        {
+          "kana": "ワード",
+          "word": "ワード",
+          "text": "(n) (1) word/(n) (2) {comp} word/(n) (3) {comp} Word/Microsoft Word/(P)",
+          "meanings": [
+            "(n) (1) word",
+            "(n) (2) {comp} word",
+            "(n) (3) {comp} Word",
+            "Microsoft Word",
+            "(P)"
+          ]
+        },
+        {
+          "word": "語",
+          "kana": "ご",
+          "text": "(n,n-suf) (1) language/(n,n-suf,ctr) (2) word/(P)",
+          "meanings": [
+            "(n,n-suf) (1) language",
+            "(n,n-suf,ctr) (2) word",
+            "(P)"
+          ]
+        },
+        {
+          "word": "単語",
+          "kana": "たんご",
+          "text": "(n,adj-no) {ling} word/vocabulary/(usually) single-character word/(P)",
+          "meanings": [
+            "(n,adj-no) {ling} word",
+            "vocabulary",
+            "(usually) single-character word",
+            "(P)"
+          ]
+        },
+        {
+          "word": "訪れ",
+          "kana": "おとずれ",
+          "text": "(n) (1) visit/call/(n) (2) arrival (e.g. of spring)/advent/coming/appearance/(n) (3) news/tidings/word/(P)",
+          "meanings": [
+            "(n) (1) visit",
+            "call",
+            "(n) (2) arrival (e.g. of spring)",
+            "advent",
+            "coming",
+            "appearance",
+            "(n) (3) news",
+            "tidings",
+            "word",
+            "(P)"
+          ]
+        },
+        {
+          "word": "音沙汰;音さた",
+          "kana": "おとさた",
+          "text": "(n) news (from someone)/word/contact",
+          "meanings": [
+            "(n) news (from someone)",
+            "word",
+            "contact"
+          ]
+        },
+        {
+          "word": "言",
+          "kana": "げん(P);こと",
+          "text": "(n) word/remark/statement/(P)",
+          "meanings": [
+            "(n) word",
+            "remark",
+            "statement",
+            "(P)"
+          ]
+        },
+        {
+          "word": "知らせ(P);報せ",
+          "kana": "しらせ",
+          "text": "(n) (1) (See お知らせ) news/word/tidings/notice/notification/information/(n) (2) omen/(P)",
+          "meanings": [
+            "(n) (1) (See お知らせ) news",
+            "word",
+            "tidings",
+            "notice",
+            "notification",
+            "information",
+            "(n) (2) omen",
+            "(P)"
+          ]
+        },
+        {
+          "word": "言葉(P);詞;辞",
+          "kana": "ことば(P);けとば(言葉)(ok)",
+          "text": "(n) (1) (See 言語) language/dialect/(n) (2) (See 単語) word/words/phrase/term/expression/remark/(n) (3) speech/(manner of) speaking/(n) (4) learning to speak/language acquisition/(P)",
+          "meanings": [
+            "(n) (1) (See 言語) language",
+            "dialect",
+            "(n) (2) (See 単語) word",
+            "words",
+            "phrase",
+            "term",
+            "expression",
+            "remark",
+            "(n) (3) speech",
+            "(manner of) speaking",
+            "(n) (4) learning to speak",
+            "language acquisition",
+            "(P)"
+          ]
         }
+      ]
+    }
+    ```
+    Please note that the resulting JSON is not pretty-printed, as shown
+    here.
 * Now let's come to the second parameter of the methods above (set to
   `nil` in the examples), the arguments for the translation.
   The default is to translate to/from English/Japanese with normal
   display layout and no other specificities, except that the API
   automatically identifies Japanese or English and manages the romaji
   and so on.
-  The returned URL is the default EDR&amp;DG one.
+  The returned URL is the default EDR&DG one, as required by Jim Breen
+  himself.
   What if the user wants to customize something?
   The `args`, second parameter of all those methods above, is a
-  dictionary (hash map) that allows to specify which parameters and to
+  dictionary (hash map) that allows specifying which parameters and to
   which values they shall be set.
 
   Valid parameters, and their values are:
     * `dict` parameter allows both numbers and (exact) strings to select
-      dictionaries: `'1'`, `'2'`, `'3'`, `'4'`, `'5'`, `'6'`, `'7'`,
-      `'8'`, `'9'`, `'A'`, `'B'`, `'C'`, `'D'`, `'E'`, `'F'`, `'G'`,
-      `'H'`, `'I'`, `'J'`, `'K'`, `'L'`, `'M'`, `'N'`, `'O'`, `'P'`,
-      `'Q'`, and `'R'`, together with the full (exact) strings
-      `'Jpn-Eng General (EDICT)'`, `'Japanese Names (ENAMDICT)'`,
-      `'Computing/Telecomms'`, `'Life Sciences/Bio-Med'`,
-      `'Legal Terms'`, `'Finance/Marketing'`, `'Buddhism'`,
-      `'Miscellaneous'`, `'Special Text-glossing'`,
-      `'Engineering/Science'`, `'Linguistics'`,
-      `'River & Water Systems'`, `'Automobile Industry'`,
-      `'Japanese Wordnet'`, `'Work-in-progress File'`,
-      `'Japanese-German (WaDoku)'`, `'Japanese-French'`,
-      `'Japanese-Russian'`, `'Japanese-Swedish'`,
-      `'Japanese-Hungarian'`, `'Japanese-Spanish'`, `'Japanese-Dutch'`,
-      `'Japanese-Slovenian'`, `'Japanese-Italian'`, `'Untranslated'`,
-      `'Combined Jpn-Eng'` and `'Expanded Text-glossing'`.
+      dictionaries:
+
+      | Number |       Dictionary Name     |
+      |:------:|---------------------------|
+      |    1   |  Jpn-Eng General (EDICT)  |
+      |    2   | Japanese Names (ENAMDICT) |
+      |    3   |    Computing/Telecomms    |
+      |    4   |   Life Sciences/Bio-Med   |
+      |    5   |        Legal Terms        |
+      |    6   |     Finance/Marketing     |
+      |    7   |          Buddhism         |
+      |    8   |       Miscellaneous       |
+      |    9   |   Special Text-glossing   |
+      |    A   |    Engineering/Science    |
+      |    B   |        Linguistics        |
+      |    C   |   River & Water Systems   |
+      |    D   |    Automobile Industry    |
+      |    E   |      Japanese Wordnet     |
+      |    F   |   Work-in-progress File   |
+      |    G   |  Japanese-German (WaDoku) |
+      |    H   |      Japanese-French      |
+      |    I   |      Japanese-Russian     |
+      |    J   |      Japanese-Swedish     |
+      |    K   |     Japanese-Hungarian    |
+      |    L   |      Japanese-Spanish     |
+      |    M   |       Japanese-Dutch      |
+      |    N   |     Japanese-Slovenian    |
+      |    O   |      Japanese-Italian     |
+      |    P   |        Untranslated       |
+      |    Q   |      Combined Jpn-Eng     |
+      |    R   |   Expanded Text-glossing  |
+
     * `display` parameter to select the final format of the referred
       HTML page (either regular HTML or raw): `:regular`, `:raw`.
     * `server` allows the user to select from the default URL (at
@@ -278,20 +484,83 @@ WWWJDic HTML source code: `'Jpn-Eng General (EDICT)'`,
       `:edrdg`, `:monash`.
 
   Some examples of these parameters' usage:
+   * `my_wwwjdic.translate 'Sprache', dict: 'G', key: english`, this
+     translates using the `F` dictionary, that is the German one
+  * `my_wwwjdic.uri 'Sprache', dict: 'G'`, same as above, but returns
+    the translation URL, instead
+  * `my_wwwjdic.raw_uri 'Sprache', dict: 'G'`, same as above, but
+    returns the translation URL with raw display, instead
+  * `my_wwwjdic.uri 'Sprache', dict: 'G', display: raw`
+
+## Maintainers
+* [Marco Bresciani](https://savannah.nongnu.org/users/marcobresciani)
+
+## Thanks
+* *Contributor*: [Jim
+  Breen](http://www.csse.monash.edu.au/~jwb/index.html)
+
+* *Author*: [Jon Maken](mailto:jon.forums@gmail.com), [An HTTP/HTTPS/FTP
+  file downloader library/CLI based upon MiniPortile's HTTP
+  implementation.](https://gist.github.com/jonforums/2202048)
+  About *An HTTP/HTTPS/FTP file downloader library/CLI based upon
+  MiniPortile's HTTP implementation*, please note that "License:
+  3-clause BSD".
+  This license is GNU GPLv3 compatible according to
+  <http://www.gnu.org/licenses/license-list.en.html#ModifiedBSD>.
+
+FSIJ理事会の理事長、[新部裕](mailto:gniibe@fsij.org)さんの日本語の翻訳。
+Japanese translation by [Yutaka Niibe](mailto:gniibe@fsij.org),
+President of Free Software Initiative of Japan.
+
+Thanks to Łukasz Niemier for his suggestions on possible improvements.
+
+## Contributing
+WWWJDic tries to follow semantic versioning (see <http://semver.org/>).
+There may be backward incompatible changes each time minor version
+number changes, but that any tiny version number change should be bug
+fixes and internal changes only.
+Be sure to read the `CHANGELOG` each time we cut a new release and lock
+your gems accordingly.
+
+RDoc documentation available in the `html` folder.
+
+The easiest way to get help with WWWJDic is to post a message to the
+mailing list: `http://lists.nongnu.org/mailman/listinfo/wwwjdic-users`
+
+Feel free to post any question there, developers are responsive and will
+be happy to help you figure out how to use WWWJDic, or help you
+determine whether it's the right tool for the task you are working on.
+
+Please make your posts to the list as specific as possible, including
+code samples and output where relevant.
+Do not post any information that should not be shared publicly, and be
+sure to reduce your example code as much as possible so that those who
+are responding to your question can more easily see what the issue might
+be.
 
-        my_wwwjdic.translate 'sprache', dict: 'F'            # this translates using the 'F' dictionary, that is the German one
+If you've found a bug, want to submit a patch, or have a feature
+request, please enter a ticket into our bug tracker:
+`https://savannah.nongnu.org/bugs/?func=additem&group=wwwjdic`
 
-        my_wwwjdic.uri 'sprache', dict: 'F'                  # same as above, but returns the translation URL, instead
+We strongly encourage adding bug reports with failing tests or at least
+a reduced example that demonstrates the problem.
 
-        my_wwwjdic.raw_uri 'sprache', dict: 'F'              # same as above, but returns the translation URL with raw display, instead
+Similarly, patches should include tests, API documentation, and an
+update to the manual where relevant.
+Feel free to clone early though and participate in the project, if you
+just want some feedback, or a code review before preparing your code to
+be merged.
 
-        my_wwwjdic.uri 'sprache', dict: 'F', display: raw    # same as above
+If you are unsure about whether you've found a bug, or want to check to
+see whether we'd be interested in the feature you want to add before you
+start working on it, feel free to post to our mailing list.
 
-------------------------------------------
+## License
+SPDX-FileCopyrightText: 2014 Marco Bresciani
 
-wwwjdic
+SPDX-License-Identifier: GFDL-1.3-or-later
 
-Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+(C) 2014 Marco Bresciani
 
 This file is part of wwwjdic.