Kanji Word Association Tool Files

Kanji Word Association Tool
---------------------------

Description:
------------
This tool was created for students who want to learn kanji and words at the same time in the most
optimal fashion possible. Based on a user-provided list of kanji, this tool will generate a list of
words that are associated with each kanji and ensure that each word consists only of kanji that you
have already studied up to that point and kana. In addition, words are sorted by frequency and no
duplicate words are used.

For example, assume that 径 is the 882nd kanji in the user-provided kanji list and that we are
using the default options. The words that will be generated for 径 will only contain kanji from the
1st kanji in the list to the 882nd kanji in the list.


How to Install/Launch (Windows Users):
--------------------------------------
1) Unzip Kanji Word Association Tool.
2) In the unzipped directory, simply double-click JapaneseTextAnalysisTool.exe.
   Note: Requires .Net Framework 3.5.


Options:
--------

* File that contains the list of kanji (one kanji per line):

  The user-provided list of kanji. If a line contains multiple tab-separated columns, you may
  specify which column contains the kanji. Several kanji lists come pre-packaged in the
  "Sample_Kanji_Lists" directory:

    kanji_in_jtat_novel_frequency_order.txt - Kanji are listed based on Japanese Text Analysis Tool's
                                              frequency report for a corpus of 5000+ Japanese novels.
    kanji_in_kanjidic_frequency_order.txt   - Kanji are listed based on KANJIDIC frequency.
    rtk_1_and_3_kanji.txt                   - Kanji are listed in Remembering the Kanji 1 and 3 order.
    rtk_1_kanji_only.txt                    - Kanji are listed in Remembering the Kanji 1 order.
    rtk_lite.txt                            - Kanji are listed on the user community's "lite"
                                              version of Remembering the Kanji 1.

* Look-ahead range:

  When determining which entries to associate with the current kanji being processed, one of the
  following look-ahead range options is used, where N is the number of the current kanji being
  processed in the kanji list, and R is a value that is specified by the user:

  - Don't lookahead (default). Range: [1 to N].
    Only associate the current kanji being processed with words that contain a kanji that has already
    been encountered. Example: For N = 367, the range would be [1-367].

  - Dynamic. Range: [1 to N + R].
    Associate the current kanji being processed with any words that contain a kanji that has already
    been encountered or with a kanji that is the user-specified number of kanji ahead of the current
    kanji. Example: For N = 367 and R = 100, the range would be [1 to 467].

  - Step. Range: [1 to get_next_multiple(N, R)].
    Associate the current kanji being processed with any words that contain a kanji that has already
    been encountered or with a kanji that is within the next multiple of R. Example:
    For N = 367 and R = 100, the range would be [1 to 400].

* [optional] File that contains a list of words that you already know (one word per line):

  Words in this list will not be added to the output file. If a line contains multiple tab-separated
  columns, you may specify which column contains the word

* Don't associate words that consist of only a single kanji

  Example: For the kanji 旭, ignore the entry "旭 (あさひ) morning sun" because the expression is
  only a single kanji.

* Maximum number of entries to associate with each kanji:

  Hopefully self-explanatory.

* Entry format:

  The format of each entry in the output file using these tokens:
    Definition  %d    Reading  %r
    Expression  %e    Tab      %t
    Frequency   %f

  Example: %e%t%r%t%f%t%d tells this tool to format each entry like this:
           Expression[tab]Reading[tab]Frequency[tab]Definition

* Add kanji to the output file

  Example: If 調 is the current kanji being processed, add 調 to the output file in a separate column.

* Add kanji number to the output file

  Kanji number is the nth position of the kanji in the kanji list input file.

  Example: Assume that 調 is the 349th kanji in the kanji list file. When 調 is processed and this
  option is checked, the number 349 will be added to a separate column in the output file.

* Output file format:

  The format of the output file. There are two choices:
    Place all entries on a single line
    Place entries on separate lines

* Output directory:

  Directory where the output file(s) will be placed. There are 2 output files:
    1) kwat_kanji_words.tsv - Contains list of kanji and associated entries.
    2) kwat_kanji_without_associations.txt - Contains list of kanji that have no associated entries.

Advanced Options:
-----------------

* Dictionary file

  Specify the dict.dat file to use. You can create your own dict.dat file with the
  Kanji Word Association Tool Dictionary Generator:
  https://sourceforge.net/projects/kanjiwordassoci/files/DictionaryGenerator/
  
* Allow associations to entries consisting of any kanji (not just those already encountered or
  those in the user's kanji list)
  
  Warning: checking this option defeats the primary intent of this program, that is, to only 
  generate words based on the kanji that the user already knows.
    
* Output a list of kanji in the user's kanji list that were not used by any of the associated entries

  This output file is named "kwat_unused_kanji.txt".


Contact:
--------
Christopher Brochtrup
cb4960@gmail.com


Special Thanks:
---------------
nest0r
louischa

--------------------------------------------------------------------------------

Version History:
----------------

[Version 2.2 (27-October-2013)]
- Updated dict.dat.

[Version 2.1 (19-July-2013)]
- Added advanced option: "Allow associations to entries consisting of any kanji (not just
  those already encountered or those in the user's kanji list)"
- Added advanced option: "Output a list of kanji in the user's kanji list that were not used
  by any of the associated entries"
- Fixed bug that prevented entries without frequency from being used for associations.
- Fixed bug where the selection of the dictionary file (in Advanced Options) could only be
  performed once.

[Version 2.0 (13-July-2013)]
- Added column selectors to the kanji list and known words files.
- Placeholders are no longer generated when "Place all entries on a single line" is selected.
- Added "kwat_kanji_without_associations.txt" output file.
- Added "Advanced options..." link.
- Added "Advanced Options" dialog.
- Added advanced option to specify which dictionary file to use.
- Changed "Output file" to "Output directory".
- The output file is now named "kwat_kanji_words.txt" and cannot be changed by the user.

[Version 1.0 (29-June-2013)]
- Initial version.