Instalation

This chapter covers installation of JFC under a variety of situations. Also covered are issues related to compatibility between various versions of JFC, and between JFC and JWPce.

  • Windows 95
  • What if I already have JWPce?
  • Windows CE
  • Installation Instructions for HPCs (handleld machines)
  • Installation Instructions for PPCs (palm machines)
  • Installing Help
  • Compatability Issues
  • International Support
  • What Should be in the Distribution?
  • More About Installation
  • Removing JFC

  • INDEX: Contents
  • PREV: Introduction
  • NEXT: The JFC Interface

  • Windows 95

    Requirements

    JFC requires a PC computer system running Windows 95, 98, ME, NT, 2000, or XP. Windows 3.x is not supported (I suggest that you consider upgrading). The amount of memory required by the program depends primarily on the fonts and options installed. With minimum font and dictionary installation, JFC requires less than 350 kB of disk space. A full install using all of the standard bitmapped fonts, dictionaries, and the manuals, requires approximately 6 MB of disk space. If you already have JWPce, JFC requires between 150 kB and 1 MB of additional disk storage. If you install TrueType fonts, the space requirements depend on the fonts you install (TrueType fonts are not distributed with JFC, unless someone wants to donate a public-domain Japanese TrueType font).

    Installation Instructions

    JFC does not have a standard installation program that you run to perform the installation, but don't worry, the installation procedure is very simple, and contains only four steps.

    1. Obtain the distribution .zip files: One way or another obtain the distribution .zip files. Depending on where you obtained your distribution copy you may have different numbers of zip files.
    2. Generate a directory: Make a directory that will be your installation directory. If you are installing over a previous version of JFC or JWPce you can simply use your existing directory.
    3. Decompress the .zip files: Decompress the .zip files into your installation directory. If you are installing over an older version of JFC or over JWPce you can safely overwrite any files. At this point you can delete the .zip files, they are no longer necessary. NOTE: Currently it is a requirement that essentially all support files to be located in the same directory as the executable (jfc.exe).
    4. Run the Program: Run the executable program "jfc.exe". This will automatically complete the installation, and prompt you for any information needed.

    Related Topics


    What if I already have JWPce?

    If you already have JWPce, you can (and probably should) install JFC in the same directory, this will allow JFC to access your color-kanji files, dictionary files, kanji-information files, and fonts. JFC is specifically designed to work with JWPce and to coexist in the same directory.

    JFC uses the same Japanese-English dictionary as JWPce. This dictionary is used to automatically generate entries from just a single word (JFC supplies the kana and English meaning from just a kanji word). JFC will automatically use EDICT and your user dictionary from JWPce.

    JFC will also automatically use the kanji information database from JWPce. This is used to automatically supply readings (on-yomi and kun-yomi) and meanings for kanji.

    Related Topics


    Windows CE


    WARNING! This section deals with running the Windows CE version of JFC. If this does not fit your situation, or you just don't care about Windows CE simply skip this section.

    JFC can run on Windows CE platforms. This section deals with specific issues related to running JFC in such an environment.

    Implementation Decisions

    Generally Windows CE versions of JFC are almost identical to the Windows 95 version. However, some small visual changes were made to accommodate the smaller screens on Windows CE machines:

    Requirements

    Windows CE versions of JFC are designed to operate on HPCs (Handheld Personal Computers) and PPCs (Palm Personal Computers) running the Windows CE operating system. The program has been developed and tested under Window CE version 2.0. I have not specifically excluded Windows CE versions earlier than 2.0, but I have not tested the program under any of these versions, and would expect that it will NOT work correctly.

    My Windows CE machines are a Velo 500, Everex Freestyle, Jornada 690, and Casio E-700 (Japanese). All of these machines are MIPS based except the Jornada, which has an SH3 processor. I have extensively tested JFC using these systems without any problems. I do not have an ARM/StrongARM machine, so I cannot test JFC using such a machine, however other uses report no problems.

    The complete installation of JFC with dictionaries and lookup tables but no help files takes about 350 kB of storage (not counting the storage compression used by Windows CE). Various files can be deleted to save space, if that is necessary (see below). JFC will run on almost any Windows CE machine.

    Related Topics


    Installation Instructions for HPCs (handleld machines)

    Currently there is no installer for JFC under Windows CE. I will eventually generate one, but this is a low priority. Until then the following steps can be used to install JFC on a Windows CE machine:

    1. Obtain the distribution .zip files: One way or another obtain the distribution .zip files - the number of files will depend on where you obtain them.
    2. Make a temporary directory: Create a temporary directory on your desktop machine (such as c:\temp-wince).
    3. Decompress the .zip files: Decompress the .zip files into your temporary directory. Generally it is better first to decompress any general files and then to decompress files that are specific to your processor. At this point you can delete the .zip files as they are no longer necessary.
    4. Make an installation directory: Create a program directory on your Windows CE machine, e.g. \Program Files\JFC (or \Program Files\JWPce).
    5. Copy the files: Copy the desired files from the temporary directory on your desktop machine to the installation directory on your Windows CE machine. You can now delete the temporary directory (and its contents) on your desktop machine, as it is no longer necessary.
    6. Run the Program: Run the executable program "jfc.exe". Finding the executable file in File Explorer and double tapping on it can do this. The program will automatically complete the installation, and prompt you for any information needed, just like the Windows 95 version.


    Installation Instructions, PPCs (palm machines)

    Currently there is no installer for JFC under Windows CE. I will eventually generate one, but this is a low priority. Until then, the following steps can be used to install JFC on a Windows CE PPC machine. Due to the absence of any type of file manager on the PPC versions of Windows CE, you will have to attach JFC to the Start Menu by hand to run the program. Do not worry, the steps are very straightforward.

    1. Obtain the distribution .zip files: One way or another obtain the distribution .zip files - the number of files will depend on where you obtain them.
    2. Make a temporary directory: Create a temporary directory on your desktop machine (such as c:\temp-wince).
    3. Decompress the .zip files: Decompress the .zip files into your temporary directory. Generally it is better first to decompress any general files and then to decompress files that are specific to your processor. At this point you can delete the .zip files, as they are no longer necessary.
    4. Make an installation directory: Create a program directory on your Windows CE machine, e.g. \Program Files\JFC (or \Program Files\JWPce).
    5. Copy the files: Copy the desired files from the temporary directory on your desktop machine to the installation directory on your Windows CE machine. You can now delete the temporary directory (and its contents) on your desktop machine, as it is no longer necessary.

    The next steps depend on which version of the Windows CE you have!

    If you have Windows CE 3.0 or a PocketPC system:

    1. Run the Program: Run the executable program "jfc.exe". Finding the executable file in File Explorer and double tapping on it can do this. The program will automatically complete the installation, and prompt you for any information needed, just like the Windows 95 version (Section 2.5).

    If you have an older Windows CE device (from before the PocketPC), you probably don't have a file explorer, so you will need to link JFC into the Start Menu before you can run the program.

    1. Select the Program: Now you will need to generate a link in the start menu so you can execute the program. Find the file JFC.exe on the PPC device (since you just copied the files, I am assuming that you are exploring your PPC), and click on it once.
    2. Copy the Program: Select Copy from the Edit menu on Explorer.
    3. Change Directories: Change the Explorer directory to /Windows/Start Menu/Programs.
    4. Make the Shortcut: Choose Paste Shortcut from the Edit menu on Explorer. If you would like a shorter name in your start menu, you can edit the name from "shortcut to JFC.exe" to "JFC", or whatever you like
    5. Run the Program: On your PPC machine there should now be a link to JWPce in the programs menu. Activate this link. The program will automatically complete the installation, and prompt you for any necessary information, just like the Windows 95 version.


    Installing Help

    I do not like the idea of dumping a larger number of files into the Windows\System directory so JFC implements it's help using Pocket Internet Explorer. This has a number of advantages: First, this allows the full range of HTML to be used in the help system**. Second, this allows me to place the help files in any location. There are also a few disadvantages: Pocket Internet Explorer opens files slower than Pocket Help. Overall, I believe this is the best solution.

    I do not like the idea of dumping a larger number of files into the Windows\System directory so JFC implements it's help using Pocket Internet Explorer. This has a number of advantages: First, this allows the full range of HTML to be used in the help system**. Second, this allows me to locate the help files in any location. There are also a few disadvantages: Pocket Internet Explorer opens files slower than Pocket Help. Overall, I believe this is the best solution.

    The following steps can be used to install help on a Windows CE system:

    1. Obtain the distribution zip files: One way or another obtain the distribution .zip files - the number of files will depend on where you obtain them.
    2. Make a temporary directory: Create a temporary directory on your desktop machine (such as c:\temp-help).
    3. Decompress the .zip files: Decompress the .zip file(s) into your temporary directory. At this point you can delete the .zip files, as they are no longer necessary.
    4. Make an installation directory: Create a help directory on your Windows CE machine. The directory must be named help, and must be a sub-directory of wherever you installed JFC. For example, if you installed JFC in \Program Files\JFC (\Program Files\JWPce) you must install help in the directory \Program Files\JFC\jfc-help (\Program Files\JWPce\jfc-help).
    5. Copy the files: Copy the desired files from the temporary directory on your desktop machine to the help directory on your Windows CE machine. You can now delete the temporary directory (and its contents) on your desktop machine, as it is no longer necessary.

    * Because help must work on all system I cannot assume a Japanese display system is present.

    ** Excluding the HTML tags that are not correctly implemented in Pocket Internet Explorer.


    Compatibility Issues

    This section deals with compatibility issues between the Windows CE versions of JFC and the Windows 95 versions.

    Generally all files used by JFC are directly compatible between Windows CE and Windows 95 versions. The following files, however, cannot be directly moved from one system to the other:

    All other files can be freely moved between the systems without any translation.


    International Support

    The appearance of JFC's interface can be changed by the use of a language or localization file (JFC_LANG.DLL). These files can replace virtually all the text strings used by the program, as well as menus and dialog boxes. This system was designed to allow creation of alternative interface modules in different languages.

    If a language support file is available for a language you are interested in, you can simply copy the support file to the same location as JFC.EXE. During startup JFC will detect the language file and switch interfaces. There is an internal check to make sure the language support file matches the version of JFC you are using.

    Currently JFC supports only one interface language at a time. Further the language is set when JFC starts. At a later date, support for switching interface languages on the fly may be implemented, but this is not a high priority.

    If you are interested in translating JFC's interface to another language please contact me or obtain the translation kit (jfctrans.zip). This kit contains instructions, notes and tools used to generate a translation file. (Please don't underestimate the amount of effort that this will take, JFC contains over 100 message strings, 15 dialog boxes, and a menu containing around 30 items. Most of these will require translation. This is not even considering the manual, help, or adjustments necessary for Windows CE PPCs and HPCs.)


    What Should be in the Distribution?

    Windows 95

    Exactly what files you get with JFC depends on who packaged the files. I distribute the program in a specific way, but since it is freeware, the copy you get may not be packaged by me. The following section describes what files should be there, what files may be there, and what they are used for. Any other files, you can probably delete if you want to.


    If you distribute JFC please try to make sure that users have access to all files included in the full distribution, source code, and utilities. These do not have to be distributed together (most users will not want the source code or utilities), however, the user should have access to all parts of the distribution if they want it.

    JFC minimum installation includes the following files:

    gnugpl.txtGNU public license.
    jfc.exeJFC executable (this is the program).
    jfc-changes.txtChanges for this version.
    jfc-copyright.txtCopyright notice.
    jfc-readme.txtUpdated information and important changes.
    jfc-wince.txtWindows CE additional information file. If you are installing a Windows CE version of JWPce please read this file.
    k16x16.f0016x16 bitmapped kanji font.
    kanjinfo.datKanji information database.
    Sample-#.jfcSample flash card files

    JFC full installation files (Technically, these are all optional files.):

    edictJim Breen's Japanese-English dictionary
    edict.jdxIndex file for edict
    jfc.docDocumentation (in Word 97 format).
    jfc.hlpJFC help file (Windows 95 only).
    jfc.cntJFC help contents (Windows 95 only).
    k24x24.f0024x24 bitmapped kanji font (if you have a good printer you can delete this one).
    K48x48.f0048x48 bitmapped kanji font.

    The Windows CE help system contains a large number of files, all of which are HTML or gif files. The help distribution zip contains a full list of the files that should be there.

    Files that may be in your installation (These are files generated by JFC or JWPce, and thus may be included with the files you receive.):
    colkanji.lstKanji list used by the color-kanji feature (from JWPce).
    jfc.cfgJFC configuration file, generated when you run JFC.
    jfc.gidGenerated by Windows help to hold bookmarks, etc.
    jfc_lang.dllLocalization (language support) file, causes JFC to change the system interface to another language.
    user.dctUser dictionary file (from JWPce).

    Windows CE

    Because of the space limitations on Window CE machines, you may not want to install all of the JFC files. The following section describes all the files used by JFC, which files are optional, and the implications if a file is not installed.

    A minimum installation of JFC includes the following files:

    FiletypeDescription
    jfc.exeREQJFC executable (this is the program)
    jfc-changes.txtOPTChanges for this version.
    jfc-copyright.txtOPTCopyright notices.
    jfc-readme.txtOPTGeneral program information.
    jfc-wince.txtOPTAdditional Windows CE information.
    EdictOPTJapanese?English dictionary. If not installed, you will not have access to the dictionary.
    edict.jdxOPTIndex file for edict, REQuired if you include EDICT.
    gnugpl.txtOPTGNU public license.
    k16x16.f00REQ16x16 bitmapped kanji font.
    kanjinfo.datOPTKanji information database. If not installed the auto lookup of kanji readings and meanings will not function.
    Sample-#.jfcOPTSample flash card files.

    All other files (fonts, dictionaries, etc.) are optional.


    More About Installation


    WARNING! This section contains technical details about the installation process. If you are not interested, simply skip this section.

    JFC's installation program is built into the main program. Every time JFC starts, JFC checks if the current installation is valid. This system allows JFC to respond if the program is moved, or some other program interferes with JFC's configuration. If there is a problem with the installation JFC will display the following dialog box:

    If you simply click Yes, JWPce will perform a default installation. If you click No, JWPce will not do an install. If you click Advanced, you will get the Advanced Install dialog box (below).

    Advanced Install Options

    From the advanced install dialog box you can determine which extensions will be associated with JFC. If some of the checkboxes are grayed (as is the .jfc checkbox below), this indicates that the extensions is already associated with JFC or no other program is using that extension, so it can be associated with JFC without causing any problems.

    Additionally, from this dialog, you can have JFC place an icon on the desktop or a command in the Start/Programs menu. By default, JFC does not place an icon on the desktop, unless you ask it to. JFC does place the command JFC in the program group Japanese in the Start menu (or simply in the Programs menu on PPC devices).

    How to Disable or Enable the Auto-Install Check

    If you have a system configuration where you do not want JFC to take over the extensions (just .jfc), and you do not want to see the Install dialog box every time you start JFC, you can simply click the Do not check again box on the Install dialog.

    If you have disabled the install check and want to enable it you can do so as follows. First, select the menu item Utilities/Install, which will manually start the install process. You can then clear the Do not check again box.


    Tip: You can run the install any time you wish by selecting the menu item Utilities/Install....


    Removing JFC

    Currently, there is no uninstall program for JFC. One will probably be provided at a future date. If you wish to uninstall JFC, follow the following steps:

    1. Remove JFC files: Delete all files in the directory where JFC is installed. You should also be able to delete the directory. If you have installed JFC in the same location you installed JWPce be careful not to delete your JWPce files.
    2. Remove Desktop Icon: If you had JFC create a desktop icon, this can be deleted by selecting the icon and then pressing the Del key.
    3. Remove Start Menu Entry: The following procedure can be used to remove programs form the Start menu:
    4. Windows 95:
      • From the Start menu choose Settings then Taskbar....
      • Choose the Start Menu Programs tab.
      • Click the Advanced button. This will allow you to edit the Start menu.
      • Select Programs to see a list of program groups.
      • Find the group containing JFC and delete either the program, or the entire group.
    5. Windows CE:
      • From the desktop double-tap My Handheld PC.
      • Double-tap Windows.
      • Double-tap Programs.
      • Find the group containing JFC and delete either the program, or the entire group.
    6. Remove Registry Entries: See next section.

    Registry Entries


    WARNING! The next section deals with making changes to the system registry. Incorrectly changing the registry can have VERY bad effects on your system. If you are unfamiliar with the registry, just skip this!

    This section indicates the registry entries used by JFC. If you fully want to remove JFC you will need to remove the registry entries. Be warned, however, that fooling with the registry is not for the timid! Further, JFC uses less than 150 bytes of registry information, so if you want you can simply ignore the registry entries.

    All registry keys used by JFC are located in the root key HKEY_CLASSES_ROOT. The first group of keys associate the file extensions used by JFC with the actual program. These keys are summaries in the table below. All of these keys will have the value "JFC" if they are being used by JFC:

    keyfile type
    .jfcFlash card file (UTF-8 or EUC encoding)

    The final key is JFC. This key and subkeys contain icon information and the program location. The entire tree can be deleted if you are uninstalling JFC.


    Next Chapter: The JFC Interface