Updated help to talk about new features.
This commit is contained in:
dchandler
parent
f695b1a6c1
commit
c986684beb
1 changed files with 213 additions and 52 deletions
|
|
@ -17,6 +17,9 @@
|
|||
<li><a href="#copypaste">Copying and Pasting</a></li>
|
||||
<li><a href="#wylietotmw">Converting Wylie to Tibetan</a></li>
|
||||
<li><a href="#tmwtowylie">Converting Tibetan to Wylie</a></li>
|
||||
<li><a href="#ttot">Converting Tibetan to Tibetan</a></li>
|
||||
<li><a href="#converter">GUI Converter</a></li>
|
||||
<li><a href="#viewer">External Viewers</a></li>
|
||||
<li><a href="#keyboards">Changing Keyboards</a></li>
|
||||
<li><a href="#preferences">Preferences</a></li>
|
||||
<li><a href="#thanks">Thanks</a></li>
|
||||
|
|
@ -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.)
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -65,8 +69,10 @@ computer.
|
|||
Note that to run Jskad you no longer need to have the <a
|
||||
href="http://iris.lib.virginia.edu/tibet/tools/tmw.html">Tibetan
|
||||
Machine Web</a> 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 <a
|
||||
Jskad itself along with the <a
|
||||
href="http://iris.lib.virginia.edu/tibet/tools/tm.html">Tibetan
|
||||
Machine</a> family of fonts. But if you wish to copy and paste
|
||||
into another application, then you do need the <a
|
||||
href="http://iris.lib.virginia.edu/tibet/tools/tmw.html">Tibetan
|
||||
Machine Web</a> family of fonts installed.
|
||||
</p>
|
||||
|
|
@ -89,9 +95,7 @@ Runtime v. 1.4</a>.
|
|||
|
||||
<p>
|
||||
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 <a
|
||||
href="#install">installed the TibetanMachineWeb fonts</a>.
|
||||
of your screen. Start typing and you'll get Tibetan.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The 'Edit' menu lets you cut, copy, and paste Tibetan text and set
|
||||
document preferences. These topics are covered elsewhere, in <a
|
||||
href="#copypaste">Copying and Pasting</a>, <a href="#tibetan">Typing
|
||||
Tibetan</a>, and <a href="#english">Typing English</a>.
|
||||
Tibetan</a>, <a href="#english">Typing English</a>, and <a
|
||||
href="#preferences">Preferences</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The 'Tools' menu provides options to help users who are <a
|
||||
The 'Tools' menu provides options to help users who are converting
|
||||
Tibetan from one form to another and who wish to view the current
|
||||
document in an external viewer, such as Microsoft Word.
|
||||
|
||||
<!-- FIXME DLC <a
|
||||
href="#wylietotmw">Converting Wylie to Tibetan</a> and <a
|
||||
href="#tmwtowylie">Converting Tibetan to Wylie</a>.
|
||||
href="#tmwtowylie">Converting Tibetan to Wylie</a>. -->
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -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
|
||||
<tt>my_thdl_preferences.txt</tt> 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 <tt>my_thdl_preferences.txt</tt> file and
|
||||
you should use 'Edit->Clear Preferences'.)
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -196,11 +206,11 @@ selecting 'Preferences' from the 'Edit' menu.
|
|||
<h3>Copying and Pasting</h3>
|
||||
|
||||
<p>
|
||||
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 <a
|
||||
Jskad supports RTF copy and paste. That means, among other
|
||||
things, 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 <a
|
||||
href="http://iris.lib.virginia.edu/tibet/tools/tmw.html">Tibetan
|
||||
Machine Web</a> 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.
|
|||
|
||||
<p>
|
||||
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. <em>Note that there are several
|
||||
known bugs with this conversion, so study your output.</em>
|
||||
There are three ways to do this:
|
||||
</p>
|
||||
|
||||
<ol>
|
||||
<li><b>Copy and Paste from Another Application</b>
|
||||
<br>Copy a block of Wylie text from Microsoft Word, and then paste it in Jskad.
|
||||
|
||||
<br>Copy a block of Wylie text from Microsoft Word, and then paste it
|
||||
in Jskad.</li>
|
||||
|
||||
<p><li><b>Select Text and Convert to Tibetan</b>
|
||||
<br>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.
|
||||
|
||||
<br>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.</li>
|
||||
|
||||
<p><li><b>Import Wylie and Save as RTF</b>
|
||||
<br>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.
|
||||
|
||||
<br>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.</li>
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
|
|
@ -265,20 +291,142 @@ computer knows that it is!
|
|||
<p>
|
||||
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 <a
|
||||
href="#english">Typing English</a>). 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 <a href="#english">Typing English</a>). Alternatively, <a
|
||||
href="#converter">launch the Converter</a> and use it to convert whole
|
||||
documents with ease.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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.)
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<center><font size="-1"><a href="#top">Back to top</a></font></center>
|
||||
</p>
|
||||
|
||||
<a name="ttot"></a>
|
||||
<h3>Converting Tibetan to Tibetan</h3>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To convert whole documents the easy way, just launch the <a
|
||||
href="#converter">converter</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<center><font size="-1"><a href="#top">Back to top</a></font></center>
|
||||
</p>
|
||||
|
||||
<a name="converter"></a>
|
||||
<h3>GUI Converter</h3>
|
||||
|
||||
<p>
|
||||
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 <a
|
||||
href="#viewer">external RTF file viewer</a> using the 'Open With...'
|
||||
button.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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.<!-- FIXME:
|
||||
what about 0020, 2003, 54xx, etc.? Allow for specifying the fonts
|
||||
for those ranges separately. -->
|
||||
</p>
|
||||
|
||||
<!-- FIXME: expound! -->
|
||||
|
||||
<p>
|
||||
<center><font size="-1"><a href="#top">Back to top</a></font></center>
|
||||
</p>
|
||||
|
||||
<a name="viewer"></a>
|
||||
<h3>External Viewers</h3>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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 <tt>my_thdl_preferences.txt</tt> file or use
|
||||
'Edit - Clear Preferences'.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -308,8 +456,6 @@ target="_blank">Tibetan Computer Company Keyboard #2</a></li>
|
|||
<li><a
|
||||
href="http://iris.lib.virginia.edu/tibet/tools/jskad_docs/Sambhota_keymap_one.rtf"
|
||||
target="_blank">Sambhota Keymap One</a></li>
|
||||
|
||||
<li>Pre-alpha ACIP keyboard.</li>
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
|
|
@ -367,11 +513,17 @@ The following are some common problems:
|
|||
</p>
|
||||
|
||||
<ul>
|
||||
<li><b>I get garbage when I type Tibetan.</b>
|
||||
<li><b>I can't open a document I converted using Jskad. It opens
|
||||
fine in Microsoft Word, but not in Jskad itself.</b>
|
||||
|
||||
<br>This shouldn't happen now that the fonts are bundled inside
|
||||
Jskad's JAR. But if it does, make sure the TibetanMachineWeb fonts
|
||||
are installed. See <a href="#install">Running Jskad</a>.
|
||||
<br>Java's RTF support is poor, so when Jskad converts a document,
|
||||
e.g. from Tibetan Machine to Tibetan Machine Web, sometimes Jskad
|
||||
cannot open the Tibetan Machine Web output. Microsoft Word can
|
||||
open it, though. The solution is to do any further work on the
|
||||
hard-to-handle document from within Jskad's converter (i.e., the
|
||||
converter that comes up when you choose 'Tools - Launch
|
||||
Converter...'). You might have luck with opening the
|
||||
hard-to-handle document in MS Word and saving as RTF.</li>
|
||||
|
||||
<p><li><b>When I paste Tibetan into another application, it shows up
|
||||
as garbage like <tt>0C-<m=-0+{;-{</tt>.</b>
|
||||
|
|
@ -383,7 +535,7 @@ into doesn't support RTF copying and pasting. To work around
|
|||
this latter problem, try pasting into an application that does support
|
||||
RTF copy and paste (such as Microsoft Word), and then select the
|
||||
Tibetan from there, copy it again, and paste into the third
|
||||
application.
|
||||
application.</li>
|
||||
|
||||
<p><li><b>The vowels don't look right.</b>
|
||||
|
||||
|
|
@ -392,7 +544,7 @@ href="http://developer.java.sun.com/developer/bugParade/bugs/4498203.html"
|
|||
target="_blank">Java Bug Id 4498203</a>, Tibetan vowels do not display
|
||||
properly in some versions of Java. Problematic versions include
|
||||
1.3.0-02, 1.3.1, and the 1.4 beta 2. Uninstall Java, and
|
||||
reinstall Java 1.4. The vowels should look better.
|
||||
reinstall Java 1.4. The vowels should look better.</li>
|
||||
|
||||
<p><li><b>I can't convert from Wylie to Tibetan.</b>
|
||||
|
||||
|
|
@ -403,18 +555,27 @@ sure you aren't using any illegal characters such as Microsoft Word's
|
|||
'smart quotes'. If smart quotes occur in your Microsoft Word
|
||||
document, you can eliminate them by choosing the 'Save As Text Only'
|
||||
option under 'Save'. Be warned that 'Save As Text Only With Line
|
||||
Breaks' does not remove smart quotes.
|
||||
Breaks' does not remove smart quotes. Finally, be aware that
|
||||
there are known bugs with the Wylie-to-Tibetan conversions; you may
|
||||
have run into a bug.</li>
|
||||
|
||||
<p><li><b>I opened up an RTF document in Jskad and some of the formatting was lost.</b>
|
||||
|
||||
<br>Java's RTF support has some problems. Therefore not all
|
||||
formatting information will be retained when an RTF file is opened in
|
||||
Jskad.
|
||||
Jskad.</li>
|
||||
|
||||
<p><li><b>Jskad runs slow or is error-prone on my Mac.</b>
|
||||
|
||||
<br>We are aware of this problem, and hope that things will get better
|
||||
as both Jskad and Apple's implementation of Java improve.
|
||||
as both Jskad and Apple's implementation of Java improve.</li>
|
||||
|
||||
<p><li><b>I get garbage when I type Tibetan.</b>
|
||||
|
||||
<br>This shouldn't happen now that the fonts are bundled inside
|
||||
Jskad's JAR. But if it does, make sure the TibetanMachineWeb fonts
|
||||
are installed. See <a href="#install">Running Jskad</a>.</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
|
|
|
|||
Loading…
Reference in a new issue