home *** CD-ROM | disk | FTP | other *** search
/ Blackhawk for Windows 95 1997 June / blackhawk-for-windows95-june19 / utils / jreader / jreadr25.doc < prev    next >
Text File  |  1997-05-28  |  21KB  |  446 lines
  1.  
  2.                            J R E A D E R
  3.  
  4.       Japanese Text Reader with Online Dictionary Search & Yomikata Lookup
  5.       ====================================================================
  6.  
  7.                             Version 2.5 
  8.  
  9.                                        
  10.                            (Copyright)
  11.                             J.W. Breen
  12.                            January 1995
  13.                                     
  14.  
  15.                              CONTENTS
  16.  
  17.                         1. INTRODUCTION
  18.  
  19.                         2. THIS DOCUMENT
  20.  
  21.                         3. INSTALLATION
  22.  
  23.                         4. ENVIRONMENT
  24.  
  25.                         5. OPERATION
  26.  
  27.                         6. DICTIONARY SEARCHING 
  28.  
  29.                         7. VERB & ADJECTIVE MODIFICATION
  30.  
  31.                         8. YOMIKATA SEARCHING
  32.  
  33.                         9. KANJI INFORMATION
  34.  
  35.                        10. JREADER ON A PALMTOP
  36.  
  37.                        11. ADDITIONS TO PREVIOUS VERSION(S)
  38.  
  39.                        12. AUTHOR'S COMMENT
  40.  
  41.  
  42.  
  43. 1. INTRODUCTION 
  44.  
  45. This program provides a PC operating under MS-DOS with the capability to read 
  46. and  display a text file containing Japanese characters (kana & kanji),  with 
  47. the option of looking up the displayed words in a Japanese/English dictionary 
  48. file or in a kanji-to-kana yomikata file.  
  49.  
  50. The Japanese characters in the text files can either be in the EUC,  New-JIS, 
  51. Old-JIS  or Shift-JIS codes.  Hankaku codes are supported for Shift-JIS,  but 
  52. not for EUC.  Codes which are not supported,  such as NEC-JIS or EUC-hankaku, 
  53. can be converted into one of the supported codes  using  a  utility  such  as 
  54. JCONV. 
  55.                  
  56. Although JREADER is  intended  to  help  non-Japanese  people  read  Japanese 
  57. language  text  files,  it can also be used by Japanese to read English text.  
  58. Its usefulness in this role is limited  by  the  dictionary,  which  is  more 
  59. oriented  to  the Japanese to English mode,  and the fact that the dictionary 
  60. search cannot cope with things like English's "strong" verbs (swim/swam/swum, 
  61. be/am/are, go/went, etc.). 
  62.  
  63. JREADER is an extension of the  author's  JDIC  (Japanese/English  Dictionary 
  64. Display)  program,  which  has  been  designed  specifically  to operate on a 
  65. dictionary in the "EDICT" format originally used  by  the  MOKE  (Mark's  Own 
  66. Kanji  Editor)  Japanese  text  editor.  As  with  JDIC,  JREADER's operating 
  67. environment has been designed to be similar to MOKE's,  and it  can  use  the 
  68. same  environment  variables  and control file as MOKE.  
  69.  
  70. The executable code and documentation of JREADER is hereby  released  to  the 
  71. public for general use.  It is covered by the author's copyright,  and may be 
  72. freely distributed with the proviso that it not be distributed as part  of  a 
  73. commercial system without the author's permission.  All usage of this program 
  74. is at the user's risk, and there is no warranty on its performance. 
  75.  
  76. All  the  Japanese  displayed is in kana and kanji,  so if you cannot read at 
  77. least hiragana and katakana,  this program will not be much use for you.  The 
  78. author has NO intention of producing a version using romanized Japanese. 
  79.  
  80.  
  81. 2. THIS DOCUMENT
  82.  
  83. JREADER  is  an  extension of JDIC,  and shares a similar operating method as 
  84. JDIC.  Consequently this document file only includes details of where JREADER 
  85. differs  from  JDIC.  Please  make  sure  you  have  and read the appropriate 
  86. JDICnn.doc file. 
  87.  
  88.  
  89. 3. INSTALLATION
  90.  
  91. This program is distributed in a "zoo" archive (jdic25.zoo).  Both  JDIC  and 
  92. JREADER share a common operating environment.  Please follow the installation 
  93. details in JDIC25.DOC, which is in the "JDIC25.ZOO" file. 
  94.  
  95. In addition, to get the full function from JREADER, you should have the files 
  96. WSKTOK.DAT  and  WSKTOK.IND.  These  are the kanji_to_kana file from MOKE and 
  97. its index file.  Without them the "y" (yomikata  lookup)  function  will  not 
  98. operate. If you are a MOKE user (Version 2.0 or later) you will have them. 
  99.  
  100. The author has produced an expanded form of the WSKTOK.DAT file by adding  in 
  101. the  additional entries in EDICT,  plus further entries from the full WNN and 
  102. SKK dictionaries.  This is available in the WSKWNN.ZOO  file,  along  with  a 
  103. matching WSKTOK.IND index file. 
  104.  
  105. (For the curious,  there is an explanation of these files in an  Appendix  to 
  106. JDIC25.DOC.) 
  107.  
  108.  
  109. 4. ENVIRONMENT
  110.  
  111. JREADER  uses  the  same  environment variables and JDIC.RC/MOKE.RC fields as 
  112. JDIC (and MOKE).  These affect things like paths and colours.  See JDIC25.DOC 
  113. for details. 
  114.  
  115. JREADER has one special (optional) entry in  the  JDIC.RC/MOKE.RC  file.  The 
  116. verb/adjective  deinflection  function  (see  below)  can  be disabled by the 
  117. following line in JDIC.RC/MOKE.RC: 
  118.  
  119. jverb   off
  120.  
  121. The default is for this option to be enabled.
  122.  
  123.  
  124. 5. OPERATION
  125.  
  126. (a) LOADING
  127.  
  128. JREADER is simple to operate. The command-line invocation is: 
  129.  
  130.          jreader <options> text-file(s)
  131.  
  132. The same -l,  -f,  -v,  -cDIR and -bnn  options  are  used  as  in  JDIC.  In 
  133. addition, JREADER uses: 
  134.  
  135.  -sn (3 < n < 8) specifies that the text window is to use n/10 of the screen, 
  136.                    The default is n = 7. 
  137.  
  138.  -ddictionary-file  specifies  the file that is to be used as the dictionary, 
  139.                    along with an index file  with  an  extension  of  ".jdx".  
  140.                    This latter file must be created using the JDXGEN utility.  
  141.                    The default is "edict" with "edict.jdx" as the index file, 
  142.                    or "jtoe.dct" and "jtoe.jdx", whichever is present. 
  143.                                        
  144.  -Llogfile  specifies the name of a file to log possible new "edict" entries. 
  145.                    The default name is "jreader.log". 
  146.  
  147.  -/search_string specifies a string for which a search is  invoked  when  the 
  148.                    file  is  read.  See  the  section  below on searching for 
  149.                    strings.  The same options are available as  in  a  string 
  150.                    entered from the keyboard, and as well a serach string can 
  151.                    be in (EUC coded) kanji or kana. 
  152.                    
  153. One or more file names can be provided. MS-DOS wildcards can be used also. 
  154.            
  155. (b) READING FILES
  156.  
  157. The working screen of JREADER contains two windows.  The upper  displays  the 
  158. text being read,  the lower displays control information,  and the dictionary 
  159. and yomikata search results. 
  160.  
  161. The lower window also displays a short "help" display when the window is  not 
  162. being  used for a regular display.  The help display can be turned off by the 
  163. "-v" command-line option and the "verbose off" line in the JDIC.RC  file.  It 
  164. can also be toggled on and off by the "o" command. 
  165.  
  166. The first screenful of the text file is displayed when  the  program  starts. 
  167. From then on most operation is by single keystroke commands. They are: 
  168.  
  169. <PgDn> reads the next screen of the file.  The  last  line  of  the  previous 
  170. screen is repeated as the first line of the next. 
  171.  
  172. <PgUp> reads the previous screen  of  the  file.  The  backspacing  technique 
  173. involves backspacing the number of lines on the current screen,  so it should 
  174. usually result in the previous screen being displayed,  unless  there  are  a 
  175. number of "folded" lines. 
  176.  
  177. <Ctrl-PgUp> restarts the file from the beginning. 
  178.           
  179. <Ctrl-PgDn> skips to the end of the file, and displays the last 10 lines. 
  180.  
  181. <Arrow>  The  four  arrow  keys  can  be  used to position the cursor under a 
  182. character which may be used as the start of a key for a dictionary search.  A 
  183. down-arrow while on the last line causes the display to scroll down one line, 
  184. and an up-arrow on the first line causes an upwards scroll. 
  185.  
  186. <Enter> positions the cursor at the start of the next line. 
  187.  
  188. <End> positions the cursor at the end of the current line. 
  189.  
  190. <Home> positions the cursor at the start of the current line. 
  191.  
  192. <Ctrl-Home> positions the cursor at the start of the screen. 
  193.  
  194. <Ctrl-End> positions the cursor at the last line of the s