From c986684beb94ce4cf7c6d8aa744f18fd490b7e1b Mon Sep 17 00:00:00 2001 From: dchandler Date: Sun, 13 Jul 2003 22:51:35 +0000 Subject: [PATCH] Updated help to talk about new features. --- source/org/thdl/tib/input/jskad_doc.html | 265 ++++++++++++++++++----- 1 file changed, 213 insertions(+), 52 deletions(-) diff --git a/source/org/thdl/tib/input/jskad_doc.html b/source/org/thdl/tib/input/jskad_doc.html index 2ae51f3..b570df3 100644 --- a/source/org/thdl/tib/input/jskad_doc.html +++ b/source/org/thdl/tib/input/jskad_doc.html @@ -17,6 +17,9 @@
  • Copying and Pasting
  • Converting Wylie to Tibetan
  • Converting Tibetan to Wylie
    • +
  • Converting Tibetan to Tibetan
    • +
  • GUI Converter
    • +
  • External Viewers
  • Changing Keyboards
  • Preferences
  • Thanks
    • @@ -48,7 +51,8 @@ Jskad is launched via Java Web Start.  Java Web Start is a technology from Sun which allows users to launch Java applications directly from a web browser.  Java Web Start is supported by Windows, Linux, Solaris, and Mac OS X 10.1, and so Jskad should work -on all of these platforms. +on all of these platforms.  (You don't need Java Web Start, but +it does make upgrades much easier.)

    @@ -65,8 +69,10 @@ computer. Note that to run Jskad you no longer need to have the Tibetan Machine Web family of fonts installed; they are now embedded in -Jskad itself.  But if you wish to copy and paste into another -application, then you do need the Tibetan +Machine family of fonts.  But if you wish to copy and paste +into another application, then you do need the Tibetan Machine Web family of fonts installed.

    @@ -89,9 +95,7 @@ Runtime v. 1.4.

    When you fire up Jskad, a glitz-free window will pop up in the center -of your screen.  Start typing and you'll get Tibetan.  If -you get garbage instead, that probably means that you haven't installed the TibetanMachineWeb fonts. +of your screen.  Start typing and you'll get Tibetan.

    @@ -105,30 +109,36 @@ Edit, Tools, and Help. 'File' provides basic options for opening, closing, saving, and printing Rich Text Format (RTF) documents.  To start a new document, choose 'New'.  To open an already existing document, -choose 'Open'.  In either case, if there is any text in the -current Jskad window, a new window will be opened up.  To close a -Jskad window, choose 'Close' or press the 'X' button.  To close -all Jskad windows, choose 'Exit'.  You will be prompted to save -if you haven't already done so. +choose 'Open' or select from the list of recently opened +documents.  In any case, if there is any text in the current +Jskad window, a new window will be opened up.  To close a Jskad +window, choose 'Close' or press the 'X' button.  To close all +Jskad windows, choose 'Exit'.  You will be prompted to save if +you haven't already done so.

    -To save, choose 'Save' or 'Save As'.  Like other applications, -'Save' saves under the current name, while 'Save As' lets you save -under a new name. +To save in Rich Text Format, choose 'Save' or 'Save As'.  Like +other applications, 'Save' saves under the current name, while 'Save +As' lets you save under a new name.

    The 'Edit' menu lets you cut, copy, and paste Tibetan text and set document preferences.  These topics are covered elsewhere, in Copying and Pasting, Typing -Tibetan, and Typing English. +Tibetan, Typing English, and Preferences.

    -The 'Tools' menu provides options to help users who are Converting Wylie to Tibetan and Converting Tibetan to Wylie. +href="#tmwtowylie">Converting Tibetan to Wylie. -->

    @@ -177,10 +187,10 @@ default point size for Tibetan text is 36.  To change this go to With Jskad you are not restricted to just typing Tibetan.  You can also type English or other European languages.  If you are in Tibetan-entry mode, you can switch to Roman entry-mode by selection -"Roman" from the "Input mode:" drop-down box.  If this doesn't -get you into Roman-entry mode, then Roman entry-mode has been -programmatically disabled by your alterations to your -my_thdl_preferences.txt file. +"Roman" from the "Input mode:" drop-down box.  (If this doesn't +get you into Roman-entry mode, then Roman entry-mode has been disabled +by your alterations to your my_thdl_preferences.txt file and +you should use 'Edit->Clear Preferences'.)

    @@ -196,11 +206,11 @@ selecting 'Preferences' from the 'Edit' menu.

    Copying and Pasting

    -Jskad supports RTF copy and paste.  That means that you can copy -Tibetan back and forth between Microsoft Word and Jskad.  To do -so, you can use standard keyboard shortcuts (Ctrl-A for select all, -Ctrl-X for cut, Ctrl-C for copy, and Ctrl-V for paste).  Note -that you must have the Tibetan Machine Web family of fonts installed on your computer for applications besides Jskad to be aware of them. @@ -222,18 +232,34 @@ snippet of Tibetan again, copy again, and then paste into Excel.

    One of the most useful features of Jskad is its ability to convert -from Extended Wylie to Tibetan.  There are three ways to do this: +from Extended Wylie to Tibetan.  Note that there are several +known bugs with this conversion, so study your output.  +There are three ways to do this:

    1. Copy and Paste from Another Application -
      Copy a block of Wylie text from Microsoft Word, and then paste it in Jskad. + +
      Copy a block of Wylie text from Microsoft Word, and then paste it +in Jskad.

    2. Select Text and Convert to Tibetan -
      Select the block of text you want to convert, and then choose 'Tools - Convert Wylie to Tibetan' from the menu bar.  Note that if you try to convert a chunk of text in which Tibetan text is surrounded by Wylie, the Wylie will convert, and the Tibetan will remain unchanged. + +
      Select the block of text you want to convert, and then choose +'Tools - Convert Selection - Convert Wylie to Tibetan' from the menu +bar.  Note that if you try to convert a chunk of text in which +Tibetan text is surrounded by Wylie, the Wylie will convert, and the +Tibetan will remain unchanged.

    3. Import Wylie and Save as RTF -
      Choose 'Tools - Import Wylie as Tibetan' from the menu bar.  You will be prompted to 'Import Wylie'.  Use the file chooser to select a .txt (text) file which contains nothing but Extended Wylie.  Then you'll be prompted to 'Save as Tibetan'.  Type a new name for your document.  If the Wylie is valid, it will be converted and saved as RTF.  This document can then be opened in Jskad. + +
      Choose 'Tools - Import Wylie as Tibetan' from the menu bar.  +You will be prompted to 'Import Wylie'.  Use the file chooser to +select a .txt (text) file which contains nothing but Extended +Wylie.  Then you'll be prompted to 'Save as Tibetan'.  Type +a new name for your document.  If the Wylie is valid, it will be +converted and saved as RTF.  This document can then be opened in +Jskad.

    @@ -265,20 +291,142 @@ computer knows that it is!

    Another useful feature of Jskad is its ability to convert from Tibetan to Extended Wylie.  Simply select the Tibetan you want to -convert, and then choose 'Tools - Convert Tibetan to Wylie' from the -menu bar.  The text will be converted, and will appear as Wylie -in the default Roman font and point size (see Typing English).  Jskad is fairly smart about -determining which Tibetan letter is the root letter when there is -ambiguity. +convert, and then choose 'Tools - Convert Selection - Convert Tibetan +to Wylie' from the menu bar.  The text will be converted, and +will appear (if you are using 'Tools - Convert Selection - Convert +Tibetan to Wylie') as Wylie in the default Roman font and point size +(see Typing English).  Alternatively, launch the Converter and use it to convert whole +documents with ease.

    -Remember that Jskad only works with the TibetanMachineWeb family of -fonts.  Therefore, it will only recognize TibetanMachineWeb as -Tibetan.  Any other Tibetan fonts will be assumed to be -non-Tibetan.  Note that you can convert TibetanMachine to -TibetanMachineWeb and then convert that to Wylie if need be. +Jskad is very smart about determining which Tibetan letter is the root +letter when there is ambiguity.  (It compares against a +hard-coded list of words for the ambiguous three-consonant cases, such +as '-g-s).  Jskad always produces 100% unambiguous Wylie, which +you can feel certain will be read back in later as the very same +Tibetan you started with.  (Although, at this time, the +Wylie-to-Tibetan side of the equation is not nearly as well tested, +and in fact has known bugs.) +

    + +

    +Remember that Jskad only works fully with the TibetanMachineWeb family +of fonts.  (It can open TibetanMachine documents for viewing and +for converting to TibetanMachineWeb, but you cannot type in new +TibetanMachine.)  Therefore, it will only recognize +TibetanMachineWeb as Tibetan.  Any other Tibetan fonts will be +assumed to be non-Tibetan.  Note that you can convert +TibetanMachine to TibetanMachineWeb and then convert that to Wylie if +need be. +

    + +

    +

    Back to top
    +

    + + +

    Converting Tibetan to Tibetan

    + +

    + Jskad also has the ability to convert from one digital form of + Tibetan to another, with perfect results (as far as we know).  + You can convert Tibetan Machine Web to Tibetan Machine (use 'Tools - + Convert All - Convert Tibetan to TM') and vice versa (use 'Tools - + Convert All - Convert TM to Tibetan').  You can also convert + Tibetan Machine Web to Unicode (using 'Tools - Convert All - Convert + Tibetan to Unicode').  To convert Tibetan Machine to Unicode, + simply convert from Tibetan Machine to Tibetan Machine Web and then + convert from Tibetan Machine Web to Unicode. +

    + +

    + To convert whole documents the easy way, just launch the converter. +

    + +

    +

    Back to top
    +

    + + +

    GUI Converter

    + +

    + Jskad features a built-in converter with a user-friendly graphical + user interface.  This converter does not show you the documents + as it is converting, though it allows you to view documents in an external RTF file viewer using the 'Open With...' + button. +

    + +

    + The converter handles all exceptional cases well.  Thus, if the + converter says that it succeeded, it really did succeed + perfectly.  You can rest assured that at least one character + was converted (it being a common error to open a Tibetan Machine + file and select a TMW->Wylie conversion), and that each character + in the original document was correctly converted to a character in + the new document.  Even uncommon errors like running out of + memory are skillfully handled. +

    + +

    + The TM->TMW and TMW->TM conversions have been hand-verified + using a document that lists each TMW glyph and its TM equivalent, + and two bugs in Java's RTF support have been worked around.  + Moreover, the TM<->TMW tables were input by two separate teams + and results compared.  JUnit tests are used to verify that bugs + do not sneak into future revisions.  Ask David Chandler to + elaborate on the verification and validation for the conversions, + but the bottom line is that there are no known bugs in the + TM->TMW, TMW->TM, TMW->Wylie, or TMW->Unicode + conversions. +

    + +

    + The user interface is fairly straightforward, except for the 'Find + Some/All' options, which are used to create a list of the characters + that are not in the desired font.  These options are for those + who want to be sure that they are converting a document that really + is wholly in Tibetan Machine or Tibetan Machine Web. +

    + +

    + At present, the TMW->Unicode conversion converts to the Ximalaya + font.  If users ask for it, the converter can easily be + extended to convert to the font of the user's choice. +

    + + + +

    +

    Back to top
    +

    + + +

    External Viewers

    + +

    + Jskad allows you to view an RTF document with an external viewer, + such as Microsoft Word.  To use this feature, just select the + menu item 'Tools - Open With External Viewer...'.  The first + time you use this command, it will ask you to locate a program to + view RTF files. Navigate to the program of your choice, such as + "C:\Program Files\Microsoft Office\Office10\WINWORD.EXE".  This + program must be set up to accept the path of the RTF file as the + sole command-line argument. +

    + +

    + On subsequent invocations of the 'Tools - Open With External + Viewer...' menu item, you will not be asked to choose the program + again.  If you wish to change programs, you must either + manually edit your my_thdl_preferences.txt file or use + 'Edit - Clear Preferences'.

    @@ -308,8 +456,6 @@ target="_blank">Tibetan Computer Company Keyboard #2

  • Sambhota Keymap One
    • - -
  • Pre-alpha ACIP keyboard.

    • @@ -367,11 +513,17 @@ The following are some common problems: