@database KEZACO.guide



This is the AmigaGuide® file KEZACO.guide, produced by hand.


@Node Main "KEZACO.guide"
@Next "COPYRIGHT NOTE"

                 `      Kanji Editor by Z-chan for Amiga Computers Only       `
  V1.55          @                © 1996-97 by Benoit Socias                  @
               .^_^.                 All Rights Reserved                    .^_^.

 @{" COPYRIGHT NOTE        " Link "COPYRIGHT NOTE"}    Is this a Shareware ?
 @{" DISCLAIMER            " Link "DISCLAIMER"}    I was using KEZACO, and suddenly a red flashing rectangle appeared...
 @{" SYSTEM REQUIREMENTS   " Link "SYSTEM REQUIREMENTS"}    Does it suit my Windows NT system ?
 @{" FEATURES              " Link "FEATURES"}    Will it wash my trousers ?
 @{" GETTING STARTED       " Link "GETTING STARTED"}    KEZACO for dummies
 @{" INSTRUCTIONS          " Link "INSTRUCTIONS"}    to November'96 Edition
 @{" COMPATIBLITY          " Link "COMPATIBLITY"}    Is there any support for Java in KEZACO ?
 @{" TO DO                 " Link "TO DO"}    Will it be of some use in the future ?
 @{" HOW TO SUPPORT KEZACO " Link "HOW TO SUPPORT KEZACO"}    Dôshiyô... dôshiyô ??
 @{" THANKS                " Link "THANKS"}    Who made this possible
 @{" HISTORY               " Link "HISTORY"}    Have those stupid bugs been smashed since last version ?
@EndNode

@Node "COPYRIGHT NOTE" 
@Next "DISCLAIMER"
@Prev "Main"
@Toc "Main"

COPYRIGHT NOTE
¯¯¯¯¯¯¯¯¯¯¯¯¯¯
The program KEZACO is copyrighted © 1996 by Benoit Socias.
All rights reserved.

KEZACO isn't yet a SHAREWARE. This program may be freely distributed as long as
   - the executable and documentation remain unchanged and are included
     in the distribution

   - no other charge is made than to cover time and copying costs

   - it isn't spread on Microsoft Network... but who'd be interrested in it there ?

WHY NOT A SHAREWARE
¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
I've spent many hours to build it from scratch...  To reverse engineer the EDict index
structure, to reverse engineer the JIS24 font (that was an easy one...), to reverse
engineer the Verb Inflection table, to build with my few japanese notions an ascii to
kana table (thanks to the old AmigaBasic manual's ASCII table ^_^;;), to discover
Blitz2 little by little, each time a word tokenized... (I'm at last beginning to
read the instruction manual), to make KEZACO "workbench compliant" (huh ?), to type
plenties of japanese texts (which aren't included), ... in one word : to make it work.

I now know that KEZACO could be a SHAREWARE... but then... what could I ask for it ?
I think it isn't yet powerful enough to ask people to send some money, and anyway, I
don't know how much I should ask for such a program.

So, there's how I'll do it :
I saw that some http/ftp sites asked donations, so that they can buy new hard disks
and so on to give more things to their users...  so, you mustn't send anything, but
if you ever do, it'll be welcome...
Money could be welcome... but you or I would have to change currencies... and I don't
think anybody enjoys this.  I'd be quite happy if you sent me some japanese stuff :
audio tapes, CD (oops... that's quite expensive) or even video tapes (SP or LP PAL, or
SP NTSC or SP SECAM)... but then first contact me, so that you don't send me something
I already have !

KEZACO is freely distributed, and will always be, with all functionality available for
the moment...  There won't be disabled things and so on, 'cos I don't want to send
disks around the world...  But if you ever need to get the last version via mail
(because you haven't InterNet access, or the last shop selling Aminet CDs in your country
just closed, then, that's allright, I'll send you a copy.)

All I ask you for now is to send me a mail telling me that you use it, and with tons
of remarks : how did you succeed in crashing it, what would be nice in next version
and so on..., even if you don't send me anything else... we'll call this 'registration'.

Registrated users with an e-mail address will be subscribed to the KEZACO NEWS mail list,
it'll only send a message every time some new version is available.

bsocias@ulb.ac.be

or

Benoit Socias
11 rue des agaces
B-1430 Quenast
BELGIUM
(EUROPE)

Tel:+32 67 637915


Updates will be sent to AmiNet in the text/util directory.

Shorter updates will be available at :

 http://is2e.ulb.ac.be/~bsocias/kezaco.html

"Spread both word and disk !!" - not an Aegis moto

@EndNode

@Node "DISCLAIMER" 
@Next "SYSTEM REQUIREMENTS"
@Prev "COPYRIGHT NOTE"
@Toc "Main"

DISCLAIMER
¯¯¯¯¯¯¯¯¯¯

   No warranties of any kind are made as to the functionality of this
program. You are using it ENTIRE at your own risk.

(Cut/Copy/Paste things are useful to get that famous Disclaimer string...)
@EndNode

@Node "SYSTEM REQUIREMENTS" 
@Next "FEATURES"
@Prev "DISCLAIMER"
@Toc "Main"

SYSTEM REQUIREMENTS
¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯

   o an Amiga computer (or compatible) with any 680X0 processor

   o OS3.0 or higher (perhaps does it work with OS2.0, but I can't tell)

   o asl.library (because of Blitz's ASL requesters)

   o enough Chip RAM to open a window on the WorkBench screen

   o the JIS24 font which is in older KEZACO archives, or available from the KEZACO page
     (the ashiya24 font is working too)

   o enough RAM to load that JIS24 font in it

   o it'd be fine if you put KEZACO on a hard disk

   o if you want to use all Kanji dictionary search, put those files on your disk too :
      -edict    (available via ftp at the Monash university...
      -kanjidic  I can't find the adress for now, but it's something like #?.monash.edu.au)
      -edict.xjdx
      -kanjidic.xjdx

   o muFS if you want to be identified by KEZACO... but it is of no use...

  The smallest machine on which I tried KEZACO is a standard A1200HD, I tried disabling AGA, 
and it still worked, even without FastMem...

  It is developed on a Blizzard1230@50MHz A1200 with 1Gb muFS+AFS HD, Creative HexSpeed 
atapi CD-ROM, 2Mb ChipMem, 16Mb FastMem, KS39.106, WB40.35, 3 bitplanes WB.

@EndNode

@Node "FEATURES" 
@Next "GETTING STARTED"
@Prev "SYSTEM REQUIREMENTS"
@Toc "Main"

FEATURES
¯¯¯¯¯¯¯¯

   o It's a Commodity

   o it has AppWindow/AppIcon and AppMenuItem

   o it is useable from either WorkBench or CLI

   o its config is in the tooltypes

   o ASCII, Kana and Kanji input

   o dictionary lookup

   o it is able to open multiple JIS and EUC documents

   o it saves JIS documents

   o if you really need EUC, 'Copy' all your text, and look at Clips:Kezaco.clip

@EndNode

@Node "GETTING STARTED" 
@Next "INSTRUCTIONS"
@Prev "FEATURES"
@Toc "Main"

GETTING STARTED
¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯

You just lha-x-ed the Kezaco archive...

Hum...

To run KEZACO from WorkBench :

 1) starting with an empty document

      -Click twice on the KEZACO icon
      -Well done !

 2) starting with a jis/sjis file without default tool type "KEZACO" :

      -Click one on the KEZACO icon
      -Shift-double-click on the file

 3) starting with a jis/sjis file with the default tool type set as "KEZACO" (and its pathway) :

      -Double-click on the file's icon

To run KEZACO from a shell :

 1) with an empty document :

      -type 'KEZACO'
      -press return

 2) opening a jis/sjis file :

      -type 'KEZACO'
      -press space
      -type the file's name
      -press return

  Now read the chapter called INSTRUCTIONS !

@EndNode

@Node "INSTRUCTIONS" 
@Next "COMPATIBLITY"
@Prev "GETTING STARTED"
@Toc "Main"

INSTRUCTIONS
¯¯¯¯¯¯¯¯¯¯¯¯

  I won't explain you how to use everything, because it is quite trivial.

  I'll only explain the main priciples, and the things that aren't perfectly standard.


  1. Entering text

   When you enter text, it's following an 'input mode', here is how they each work

   1.1 ASCII
 
     Just type in your text normally, I mean : press the 'A' key, and a 'a' will appear.
     Use shift for upper case !!


   1.2 Kana

     Just type in your text as if it was written in rômaji.  What you type is displayed
     in the windows' title bar.
     Type in upper case to get katakanas, lower case for hiraganas.

     Example :
      
      'chi' will display the hiragana pronounced 'chi'
      'TA'  will display the katakana pronounced 'ta'
      'nya' will display the hiragana 'ni' and the small hiragana 'ya'
      'DI'  will display the katakana 'de' and the small katakana 'i'
      'ppa' will display the small hiragana 'tsu' and the hiragana 'pa'

      Understood ?

      Typing '+a' will give you the small hiragana 'a' alone, and so on... (even '+KA' works !)

     If you put a '$' before your string, and terminate it with another '$', KEZACO will try
     to find a kanji equivalent using edict and the verb inflection table.


   1.3 Kanji

     End your string with '$' (the same as with 'Kana' but without a '$' in first place)


   1.4 Meaning

     Type in the english word you want to match, then press '$'


   1.5 JIS

     Type in the two characters that are the jis code of the kanji


   1.6 Code (only if kjdic is available)

     Type in the wanted code and press return

     Codes are like said in the kjdic.doc file, if you've lost it, there are the usefulest ones

     'Sn' where n is number of strokes
     'Bn" where n is the bushu index code

     'Pa-b-c' where :
        a is the kanji type :
             1 : split left/right
             2 : split top/bottom
             3 : split inside/out
             4 : one part

        b is the number of strokes in the first part (whole kanji if a=4)

        c is the number of strokes in the second part (if a=1 2 3)

             a code if a=4 : 1 it has a horizontal line on the top
                             2                                 bottom
                             3          vertical line in the middle from top to bottom
                             4 none of above

     Using those P-codes is very useful when you don't know how to pronounce a kanji.


   1.7 LookUp

     It isn't really an input mode, it tries to find in the dictionary the next N characters
     (from the pointer position), N being the number you press.


   1.8 HexJIS

     Type in the 4 hex digits of the wanted kanji.

       Example : HexJIS:3021 is the same as JIS:0!   ^_^;


  2. Marking blocs

    Up to now, to mark a bloc, you have to press 'Amiga B' first, as in MultiView


  3. Find 'n' Replace

    First set the Find and/or the Replace string(s), then use Next to find next and replace
    to replace.


  4. The Preferences... hum...

    I hadn't enough time to make it very user-friendly... I know its the more important part...
    but as long as nobody else uses it, it's of no use for me, because it is already configured
    for me !
    Use the mennues to set the values.
    Warning, setting random numbers may stop KEZACO from working properly !
    If you save, KEZACO will create a KEZACO2 icon, because then you'll have to copy the icon
    from outside, and you'll perhaps think of making a backup of the original Icon, so that
    you can get it back if you destroyed important datas !

    Always quit KEZACO after modifying !!!
    (because it modifies things that haven't been initialised that way first !)


  5. Looking for kanjis

    The JIS Table allows you to browse through the font.  Everything is in the menu, but
    the keys are : cursors, escape to exit, 'g' for goto

    The Bitmap Matching system is very slow and stops KEZACO from doing anything else for
    a long time... you should always use the Code input mode instead of this !
    Commands are in the menu, you may still try to use the cursors+escape+return


  6. Special things...

    Most is documented in the history part...  I hope you'll find everything, because
    I don't want to read this guide again, looking after what's missing...

    A bitmap cursor can be obtained with the tooltype : "BitmapCursor=1"
    The dollar and star keys (for dictionary search) can be changed with "Dollar" and
    "Star" tooltypes.
    More improvements to come... but I've got a test next Monday ^_^;;

@EndNode

@Node "COMPATIBLITY" 
@Next "TO DO"
@Prev "INSTRUCTIONS"
@Toc "Main"

COMPATIBLITY
¯¯¯¯¯¯¯¯¯¯¯¯

  KEZACO can only read JIS and EUC files.

  Trying to load JWP files might be fun... never tried, but KEZACO might be going nuts after
  that... I guess all control characters from JWP will be understood as ASCII strings...

  The Save options allow you to save Old JIS files

  But... if you Select All and Copy, there will be an EUC copy of your file called
  Clips:Kezaco.clip.  I'll add a switch later, so that Kezaco will be able to save EUC files.

@EndNode

@Node "TO DO" 
@Next "HOW TO SUPPORT KEZACO"
@Prev "COMPATIBLITY"
@Toc "Main"

TO DO
¯¯¯¯¯

   o In-Line help

   o AREXX port

   o Tiny Furigana display

   o Vertical text handling

   o PRINT !!!

   o A GUI based Kanji lookup system, using code index in KJDic file

   o nice GUI preferences, with plenties of gadgets to click onto !!!

   o give the choice of WB/Own Screen + ScreenMode, bitplanes and so on...

Well... it seems KEZACO will next become something like a "PageStream", but without
that many options, and specially for Japanese text.

The user will have to switch between the text editor, and the page editor which will
use the active texts which you'll put in various boxes.
There will be some control characters in the text editor to tell : jis font size,
ascii font to be used, bold, italic, and so on... (bubble for japanese ?)

There will be parameters for boxes, such as character spacing and so on...
Perhaps will it be possible to import pictures to... who knows ?  Nothing is
impossible !   (Will I be able to import KISS files ? ^_^;;)
It'd be a way to allow KEZACO to grow up from its current state, and not redoing it
from scratch.

There will be a standard file format for those pages, to be exchanged with 'Bren10'
which is some kind of KEZACO for MS-Windows based machines.  This will allow you
to transfer files from home to work.  Don't look after this program yet, it isn't
yet distributed, but my friend was seduced by KEZACO and said he could do it on his
PC... we shall see.

@EndNode

@Node "HOW TO SUPPORT KEZACO" 
@Next "THANKS"
@Prev "TO DO"
@Toc "Main"

HOW TO SUPPORT KEZACO
¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯

   o send me a word once you'll have tried it (my address is in Copyrights)

   o tell me you really need it, so I'll continue rewriting most important routines

   o tell me in what purpose you use it (reading news on from usenet, archiving your
     japanese CD collection (as I), or anything else...)

   o tell me what is your configuration (Amiga model/Clone, memory, processor, OS,...)
     so that I know if it works everywhere. (I wonder if people with graphic cards
     are getting a correct output)

@EndNode

@Node "THANKS" 
@Next "HISTORY"
@Prev "HOW TO SUPPORT KEZACO"
@Toc "Main"

THANKS
¯¯¯¯¯¯

  To friends interrested in Japanese who made me think such a program was needed :

    -Thierry 'T-chan' Vermeylen (hw42290@vub.ac.be)
           (an active manga-otaku who first showed me JWP, now that he knows KEZACO,
            he's writing Bren10, some kind of japanese editor for MS-Windows...
            we shall see.)

    -Laurent 'Akane' Merckx     (lmerckx@ulb.ac.be)
           (a bad cooking friend who likes japanese songs, he's responsible for
            'Gtalk' a kind of chatter for Unix machines, next version should have
            a japanese support if he wants me to help him)

    -Arthur 'Crighton' Roose   (aroose@ulb.ac.be)
           (an Arimi-san fan, who just began to learn japanese after I showed
            him ALL of 'Marmalade Boy', he only writes bots for 'Gtalk')

    -Stéphane 'Cocker' Michel  (smichel@ulb.ac.be)
           (an Arimi-san fan too, he isn't interrested in the language... but we
            had much fun listening to the 'AKIRA' soundtrack...)

    -Philippe 'UltraFamicom' Socias
           (my brother who payed my Blizzard, my hard disk, my Blitz2 and lot of memory)

  To people who made it possible :

    -Jim Breen for the edict and kanjidic project

    -Roger Ang for the AmiKanji package from which I learned many things

    -somebody else... but I don't know the name of the person who made the JIS24 font

    -all users who already sent comments

@EndNode

@Node "HISTORY" 
@Prev "THANKS"
@Toc "Main"

HISTORY
¯¯¯¯¯¯¯
June'96

  I put a first version of KEZACO on AmiNet... it didn't much thing...
  the only thing that really worked was the Kana input mode, and the file loading.


July'96

  That version nearly worked... but there was an horrible bug :

  I was scanning through the index files with the Blitz2 'Edit$()' command... so
  it gave me something weird each time a character Line Feed appeared !!

  When I understood the bug, I thought it was time for me to read the instructions.


August'96

  This version is very safe !!!

  I still don't know why it crashed yesterday... so, just save often enough, and if
  it crashes, mail me the circumstances.  I hope I'll be able to fix this later.

  There now are Find/Replace, Cut/Copy/Paste, many LookUps...

  The file 'Madrigal.jis' is still included, those are the lyrics of the track 4 of
  a CD called 'MADRIGAL', sung by Hiroko Kasahara, and which I listened a lot since
  the beginning of coding KEZACO.


  First users reported bugs and needed improvements.

  ...so is the menu font problem fixed ! (but not the palette problem... and I still
  can't find what's going wrong !!)

  There is a new HexJIS input mode.

  KEZACO was saving one line too much... oops... it has now been corrected

  Facultative ToolTypes Dollar=$ and Star=* to select other keys, it was thought in the
  idea that $ was the nearest key to 'return' on the second row, and * was shift-$.
  If you don't use those tooltypes, old $ and * will be used instead.

  You may force old-jis format in load, thanks to the new "special" menu.  But then,
  the characters with ascii codes over 127 won't be printed... this is because I'm
  using built-in Blitz2 strings, and their Print command, and that only supports
  ascii-7 characters...  I'll have to rewrite a big part of the program before that it
  works properly with latin-1...  v_v;


September'96

  Kyaaaa !  I was looking in the OS3.0 autodocs to find how to create a slider which
  is in the window border... and I didn't find that... I only found that I forgot to
  put the 'NewLookMenu' flag when opening the window...  so, I corrected the menu
  appearance...

  Another thing, if the filename is '#?.html#?' it will be saved in EUC.  It isn't
  very great, but it was for an easy immediate use.

  Anyway... I still don't know how to create sliders (in window borders)...
  By now, I could put one, but it'll be inside the window, as any gadget.  This looks
  ugly.


October'96

  It's 28 october today... and I just began to work again on Kezaco... I'm really sorry.
  I've got many problems which made me unable to continue working earlier...  First,
  I tried the new fMSX... and I played Konami's "Parodius" a little too much, but I
  couldn't get through the first level, and to 'continue' after game over, you have
  to 'hit' the 'F5' key... but after retrying agin and again, I got angry and hit the
  'F5' key very hard... the only problem is that I own a A1200... this caused some
  harddisk problems, and I'm working with AFS (patched with muFS !!) and there's no tool
  yet to get anything back after that kind of crash, but I managed to get nearly all
  my damaged files back... then there has been another problem, I've bought Team17's
  'Killing Grounds' ^_^;; and I had to complete it before doing anything else...  (I
  did it with the cheats, else would it last one more year...)  So, now, I'm ready to
  return to work !!  That's what I did today with the new Kana function !  (You won't
  see any difference, but it's going a lot faster than before : before it parsed
  nearly 300 entries twice each time you pressed a key, but now is it put in a far
  faster structure which makes it much faster.)
  Another thing is the 'PiCross'-menu entry... it won't do a thing, except if you look
  at the file t:PiCross which will contain a PiCross description of a kanji : line per
  line first, then column by column...  I forgot to remove it from the distributed
  version... but it's only 1Kb long.
  Next month, I hope I'll be able to add some kanji-bitmap buffering, and dictionnary
  search buffering too.  (I've got some courses about optimisation, and it is of much
  help.)

  Two days later...
  A user told me earlier version didn't even start !!  Well, I think it's corrected now.
  It was because of trying to load a font whose name was in the Env:sys/font.prefs file,
  but it seems that this file hasn't always the same format...  anyway, I only loaded
  it to give the menues the good font... but now, trying to load a default topaz 8 if
  wanted by the user, I remarked that my menues had got the correct font !!!
  So now, it only 'reads' the standard topaz 8, even if it doesn't use it ! (no problem,
  it's a romfont)
  As problem often appear only with some people, if your menues now are back with topaz,
  then, I think you should warn me, and I'd have to finally add that 'ForceTopaz'
  tooltype !


November 1996

  Some users didn't find the 'mouse-cursor' idea very good... so, there now is a bitmap
  cursor possibility...  It doesn't look very pretty, but it may be of some use, I guess
  that moving the mouse pointer didn't work well on some graphic cards... sorry...
  I should have done it nicely with a mask, and so on... but it would have slowed the
  display down...  this way, the speeds stays correct.
  To activate this option, add the tooltype : "BitmapCursor=1".

January 1997

  Oops... I completely forgot to edit the guide on that time... so I don't remember
  what has been improved since previous version.  But anyway, it doesn't make things
  worse than before...  I think I tried to fix an awful bug : it crashed when you
  asked to insert too long dictionary lines...  but I hadn't been able to fix it...
  Just say your lines are maximum 125 characters (or something like this...) it should
  be working almost all the time...
  The crash happens when there are too many pronounciations available.
  Never forget the one big rule : save as often as possible.

February 1997

  Nothing new... but I'll finally put version 1.54 on AmiNet tomorrow.  It will be
  released with the ashiya24 font this time.  That's all.

  If there are some example files... they'll sure be lyrics of songs from
  Hisakawa Aya's "for you for me" album.

March 1997

  ...I finally decided to "abort" Kezaco, just to start writing Kezaco II, which will
  use the aminet://text/misc/Japanese.lha !
  So, I re-read all Kezaco's sources... and I found the REAL... the ONLY... the HUGEST
  the STUPIDEST bug of the whole world bug-kind...

  I did do this :
    -one variable gets one character from keyboard
    -put another character from keyboard in the buffer
    -put the variable in the buffer too !!!!

  ... now... you can imagine why you had to type so s..l..o..w..l..y..

  So, I removed the second line, I removed all "FlushEvents" too (because, they were
  just trying to avoid that bug in a wrong way...)

  And now : Kezaco is... (you won't believe me...) : F A S T  !!
  Sugoi ne ?

  I guess this is the  LAST  update to our dear Kezaco, because I already nearly
  completed Kezaco II, using Marcus Lundblad's "Japanese" commodity...

    New features already done :
      -a nearly correct cursor      (in truth, that's a " | " character put inside the text ^_^;)
      -a slider on the side of the document window
      -JisTable is on a 'palette-like' window, and interacts with the document without blocking its
          edition
      -same thing for the dictionary, which has a slide bar too...
      -accepts different size of font (but japanese text will only be displayed in 8 or 16 dots,
          due to actual "Japanese" font patch, but if really needed, I think I could add a
          custom 24/32/48 dot display.
      -file format selection  (only EUC and Old-JIS... but it is done in a correct way this time)

    What to be (re-)done next :
      -now that I've understood how do gadget work : add the Kanji Seek window.
      -try to use the REAL Clipboard.device for Cut/Copy/Paste things
      -tiny characters above normal text for pronounciation
      -find and replace properly
      -working Preferences... v_v...

----

  KEZACO is still a program, but it will sure one day become a 'she', (you know, the
  same way Pinocchio became a boy)... then we'll call her 'Kezako-chan' ^_^;;

@EndNode

