thdltools/Jskad
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Added jskad_doc.html (a revision of which is up at

Browse source 
http://iris.lib.virginia.edu/tibet/tools/jskad_doc.html) to the repository.  The
build puts this into Jskad's JARs, but Jskad itself does not allow for viewing
it.  In Java, that's a ten-minute job, but I haven't done it.
This commit is contained in:
dchandler 2002-12-07 17:53:24 +00:00
parent 9eedfcd909
commit 53aa2e2309
2 changed files with 459 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
build.xml
View file

@ -228,12 +228,23 @@
<antcall target="copy-license-etc-to-bin-dir-for-jarring">
<param name="mybin" value="${jskadbin}"/>
</antcall>
<copy todir="${jskadbin}">
<fileset dir="${source}">
<include name="org/thdl/tib/input/jskad_doc.html"/>
</fileset>
</copy>
<copy todir="${jskadbin}/org/thdl/tib/input">
<fileset dir="${source}">
<include name="Sambhota_keymap_one.rtf"/>
<include name="TCC_keyboard_1.rtf"/>
<include name="TCC_keyboard_2.rtf"/>
<include name="Wylie_keyboard.rtf"/>
<!-- We don't have ACIP_keyboard.rtf yet, but creating such a
thing manually is just one option. We could easily
generate all the keyboard descriptions
programmatically. -->
</fileset>
</copy>
</target>

448
source/org/thdl/tib/input/jskad_doc.html Normal file
View file

@ -0,0 +1,448 @@
<html>
<head>
<!--
==============
INSERT KEYWORDS AND DESCRIPTION HERE
==============
-->
<meta name="keywords" content="tibetan literature, tibetan genres, tibetan religious texts">
<meta name="description" content="This presents analyses, catalogs, and digital representations of all genres of Tibetan literature.">
<!--
==============
INSERT PAGE TITLE HERE
==============
In order to facilitate the use of the unicode character set the charset declaration will be set equal to utf-8
Always incorporate Tibetan and Himalayan
-->
<title>Tibetan & Himalayan Tools Collections</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-utf-8">
<!--
==============
THIS IS THE STYLE FOR THE BODY; IT'S WHAT CALLS ON THE BANNER AS A BACKGROUND IMAGE AND SETS UP THE BACKGROUND COLOR. MAKE SURE TO LINK TO THE BANNER HERE.
==============
-->
<style type="text/css">
<!--
body {background-attachment: scroll; background-image: url(/tibet/images/bannerTools.gif); background-repeat: no-repeat; background-position: left top; backgroud-color: white}
-->
</style>
<!--
==============
THE STYLE FOR THE TEXT, ETC. IT GOES TO THE TOP-LEVEL STYLE PAGE. IS THERE A NEED FOR EACH COLLECTION TO HAVE INDIVIDUAL STYLE PAGES?
==============
-->
<link rel="stylesheet" href="/tibet/style/tools.css">
<!--
==============
MAKES NETSCAPE RELOAD IF THE WINDOW IS RESIZED
==============
-->
<script language="JavaScript">
<!--
function MM_reloadPage(init) { //reloads the window if Nav4 resized
if (init==true) with (navigator) {if ((appName=="Netscape")&&(parseInt(appVersion)==4)) {
document.MM_pgW=innerWidth; document.MM_pgH=innerHeight; onresize=MM_reloadPage; }}
else if (innerWidth!=document.MM_pgW || innerHeight!=document.MM_pgH) location.reload();
}
MM_reloadPage(true);
// -->
</script>
</head>
<!--
==============
SETS THE PAGE MARGINS TO "0" SO THE MENU DOESN'T GET SCREWED UP
==============
-->
<body topmargin="0" leftmargin="0" marginwidth="0" marginheight="0">
<!--
==============
THE JAVASCRIPT MENUS
==============
-->
<script type='text/javascript'>
//HV Menu v5- by Ger Versluis (http://www.burmees.nl/)
//Submitted to Dynamic Drive (http://www.dynamicdrive.com)
//Visit http://www.dynamicdrive.com for this script and more
function Go(){return}
//==============
// --CALL UP THE MENU. THE 1ST OF THE CHOICES HAS THE VARIABLES
// AND NEEDS TO BE UPDATED FOR EACH SECTION.
// MENU_LOADER.JS WILL ALWAYS BE THE SAME.
//==============
</script>
<script type='text/javascript' src='/tibet/scripts/menu_tools.js'></script>
<script type='text/javascript' src='/tibet/scripts/menu_loader.js'></script>
<script type="text/javascript" src="/tibet/scripts/thdl_scripts.js"></script>
<noscript> Your browser does not support Javascript menus. Please utilize the
Site Map for navigation.</noscript>
<div align="left" style="position:absolute; left:0px; top:0px; width:100px; height:50px; z-index:7">
<a href="/tibet/index.html">
<img src="/tibet/images/spacer.gif" style="border-width:0" width="100" height="50">
</a>
</div>
<div id="Layer1" style="position:absolute; left:100px; top:28px; width:708px; height:20px; z-index:1">
<!--
==============
INSERT THE BREADCRUMBS
==============
A HREF tags should not be applied to current page, e.g. THDL and Collections get link, Literature and Home do not. If you were on a subpage of Literature, then Literature would link to the Literature home page.
-->
<div align="right"><font color="#000000"><A HREF="/tibet/index.html">THDL</A> : <A HREF="/tibet/tools/index.html">Tools</A> :
<a href="/tibet/tools/software.html">Software</a> : <a href="/tibet/tools/input.html">Tibetan Input</a> :
<a href="/tibet/tools/jskad.html">Jskad</a> : Documentation</font>
</div>
</div>
<!--
==============
INSERT THE MENU
==============
-->
<div id='MenuPos' style="text-size:9px; layer-background-color:#CCCCCC; background-color: #CCCCCC; position:absolute; left:0px; top:50px; width:808px"><table width="808" cellpadding="0" cellspacing="0" height=19"><tr><td><p style="font-size:9px">Menu loading...</p></td></tr></table></div>
<!--
==============
MAKE THE LAYER THAT WILL HOLD THE CONTENT OF THE PAGE - THE TEXT, IMAGES, WHATEVER. THIS LAYER WILL BE CLOSED AT THE END OF THIS HTML DOCUMENT
==============
Maximum table width not to exceed 750
All images must have borders of 1 pixel
No image will exceed 325 X 325 height and width measurements
Position attribute on layer3 may need to be changed to absolute to accomodate Netscape
-->
<div id="Layer3" style="position:relative; left:7px; top:80px; width:801px; height:396px; z-index:1; overflow: visible; background-color: #FFFFFF; layer-background-color: #FFFFFF; border: 1px none #000000" >
<table width="750" border="0" cellspacing="0" cellpadding="10">
<tr>
<td valign="top" align="left">
<!--
=============
FOR EVERY "ADMINISTRATIVELY DISTINCT" PROJECT, THERE SHOULD BE A CREDIT FOR THE PROVIDER OF THE INFO
=============
-->
<script langauge="JavaScript">
function openWin(url, name) { popupWin = window.open(url, name,"resizable=1,scrollbars=1,toolbar=0,width=400 ,height=450")
}
</script>
<!--
<p class="credits">
Hosting Institution: University of Virginia<br>
</p>
<!--
============
THIS LINK WILL OPEN A SEPARATE WINDOW THAT WILL PROVIDE INFORMATION REGARDING THE ADVISORY BOARD MEMBERS. ALSO PROVIDED IN THE PAGE WILL BE PARTICIPATION AND DONATION INFORMATION.
============
-->
<!--
==============
SETS THE BODY TEXT TO JUSTIFIED
==============
-->
<div align=justify>
<!--
==============
INSERT UPPER RIGHT IMAGE HERE -- MAKE SURE TO ADD AN ALT TAG!
REMEMBER...
All images must have borders of 1 pixel
No image will exceed 325 X 325 height and width measurements
==============
-->
<!--
<table align=right border="0" cellpadding="5" cellspacing="1" width="0">
<tr>
<td>
<p align="justify"><img src="/tibet/images/tools/worker.gif" width="200" height="250" border="1" align="middle" /></p>
</td>
</tr>
<tr>
<td>
<!--
==============
INSERT CAPTION HERE
==============
-->
<!--
<p class="caption">Tibetan construction worker (Derge).</p>
<!--
=============
INSERT LINK TO GUIDED TOUR HERE -uncomment when ready.
=============
-->
<!--
<p class="caption">click here for <a href="blank.html">Guided Tour</a></p>
//-->
<!--
</td>
</tr>
</table>
<!--
==============
INSERT BODY TEXT HERE
The first section of text is the short "introduction" about the Theme and the various discplines that have a vested interest in them.
Design principle: Bold the first few words of this text section.
I guess David wants the name of the author of this section and date created (revised). I suppose it lives above the bolded first words???
==============
-->
<h2>Jskad Documentation</h2>
<ul>
<li><a href="#install">Running Jskad</a></li>
<li><a href="#start">Getting Started</a></li>
<li><a href="#tibetan">Typing Tibetan</a></li>
<li><a href="#english">Typing English</a></li>
<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="#keyboards">Changing Keyboards</a></li>
<li><a href="#advancedkeyboards">More on Keyboards</a></li>
<li><a href="#trouble">Troubleshooting</a></li>
<li><a href="/tibet/tools/jskad.html">Jskad Home Page</a></li>
</ul>
<a name="install"></a>
<h3>Running Jskad</h3>
<p>
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.
<p>
Note that after you've run Jskad twice, it will ask you whether or not you want to create a shortcut to Jskad on your desktop. If you say yes, then you can launch Jskad from your desktop in future, without having to visit our web site. Every time Jskad runs, it will automatically check our site for updates - unless you're offline, in which case Jskad will just run the version which is cached on your computer.
<p>
Note that to run Jskad you must have the <a href="/tibet/tools/tmw.html">Tibetan Machine Web</a> family of fonts installed.
<p>
Note also that due to a bug in earlier versions of Java, you should run Jskad under Java Runtime v. 1.4. If you are running Windows, Linux, or Solaris and you have an earlier version installed, please uninstall it, and then install <a href="http://java.sun.com/j2se/1.4/download.html" target="_blank">Java Runtime v. 1.4</a>.
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="#start"></a>
<h3>Getting Started</h3>
<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>.
<p>
A menu bar appears at the top of the window. If you are running Jskad as an application, you'll see four menus: File, Edit, Tools, and Info. If you're running Jskad as an applet, you'll only see Edit, Tools, and Info.
<p>
'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. You will be prompted to save if you haven't already done so.
<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.
<p>
When you choose 'Print', a print preview window will pop up. If you don't like the look of the preview, you may want to press the 'Page Setup' button to change the margins or paper orientation. Then press the 'Print' button. Note: Do not use the 'Page Setup' options that are made available after you press the 'Print' button - they may not work.
<p>
The 'Edit' menu lets you cut, copy, and paste Tibetan text, switch back and forth between Tibetan and English, 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>.
<p>
The 'Tools' menu provides options to help users who are <a href="#wylietotmw">Converting Wylie to Tibetan</a>, <a href="#tmwtowylie">Converting Tibetan to Wylie</a>, and <a href="#keyboards">Changing Keyboards</a>.
</p>
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="tibetan"></a>
<h2>Typing Tibetan</h2>
<p>
Jskad lets you input Tibetan text according to several popular keyboard input methods. The default keyboard is the <a href="/tibet/tools/jskad_docs/Wylie_keyboard.rtf" target="_blank">Extended Wylie</a> keyboard. Other supported keyboards include <a href="/tibet/tools/jskad_docs/TCC_keyboard_1.rtf" target="_blank">Tibetan Computer Company Keyboard #1</a>,
<a href="/tibet/tools/jskad_docs/TCC_keyboard_2.rtf" target="_blank">Tibetan Computer Company Keyboard #2</a>
, and Nitharta's <a href="/tibet/tools/jskad_docs/Sambhota_keymap_one.rtf" target="_blank">Sambhota Keymap One</a>.
<p>
Jskad automatically opens up in Tibetan-entry mode, so all you have to do to get Tibetan is start typing. If you are in Roman-entry mode, then you will need to first switch to Tibetan-entry mode. Do this by pressing Escape, or by choosing 'Toggle Tibetan/Roman' from the 'Edit' menu. The default point size for Tibetan text is 36. To change this go to 'Preferences' in the 'Edit' menu.
<p>
Due to a bug in Jskad, the keyboard may freeze and do nothing if you type something which is not a Tibetan character in the currently installed keyboard. To regain control press the spacebar or a number key.
<p>
Note also that there is currently no syllable-wrapping in Jskad. Lines are wrapped at whitespace, but not at tshegs. We are actively seeking a solution to this problem.
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="english"></a>
<h2>Typing English</h2>
<p>
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 pressing Escape, or by selecting 'Toggle Tibetan/Roman' from the 'Edit' menu. If this doesn't get you into Roman-entry mode, then Roman entry-mode has been programmatically disabled.
<p>
You can change the font and/or point size of Roman-based text entry by selecting 'Preferences' from the 'Edit' menu.
</p>
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="copypaste"></a>
<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).
<p>
Note that not all applications support RTF copy and paste. Therefore, you cannot, for example, copy from Jskad and paste into Microsoft Excel.
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="wylietotmw"></a>
<h3>Converting Wylie to Tibetan</h3>
<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:
<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.
<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.
<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.
</ol>
<p>
All three of these options are suitable for most situations. However, if you are converting a lengthy document, you are advised to use the 'Import' option.
<p>
In all cases, Wylie can only be converted to Tibetan if it is valid Extended Wylie. If there is any invalidity, the entire conversion will halt. An informational message will appear, with a guess as to what the problem is. Take special note of the fact that Microsoft Word's 'smart quotes' cannot be converted. If you are copying from Microsoft Word, please turn off smart quotes (see <a href="#trouble">Troubleshooting</a>). Remember also that Jskad does not know the difference between Wylie and English. Just because you can see that a string of text is Wylie doesn't mean that a computer knows that it is!
</p>
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="tmwtowylie"></a>
<h3>Converting Tibetan to Wylie</h3>
<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>).
<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.
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="keyboards"></a>
<h3>Changing Keyboards</h3>
<p>
As already mentioned, Jskad supports four different keyboard input methods:
<ol>
<li><a href="/tibet/tools/jskad_docs/Wylie_keyboard.rtf" target="_blank">Extended Wylie</a>
<li><a href="/tibet/tools/jskad_docs/TCC_keyboard_1.rtf" target="_blank">Tibetan Computer Company Keyboard #1</a>
<li><a href="/tibet/tools/jskad_docs/TCC_keyboard_2.rtf" target="_blank">Tibetan Computer Company Keyboard #2</a>
<li><a href="/tibet/tools/jskad_docs/Sambhota_keymap_one.rtf" target="_blank">Sambhota Keymap One</a>
</ol>
<p>
The default keyboard is Extended Wylie. To change to another keyboard, choose 'Tools - Keyboards' and then select the keyboard you want to use.
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="advancedkeyboards"></a>
<h3>More on Keyboards</h3>
<p>
When Jskad loads up, it unjars 'jskad.jar' and looks in the directory 'org/thdl/tib/text/' for a file called 'default_keyboard.ini'. If it finds no such file, then the keyboard defaults to Extended Wylie. Therefore, if you want Jskad to default to another keyboard, you must (a) unjar 'jskad.jar', (b) create a 'default_keyboard.ini' file, (c) put it in the above-named directory, and (d) rejar 'jskad.jar'. If you want one of the already existing non-default keyboards to be the default keyboard, then make a copy of its corresponding .ini file, and rename it as 'default_keyboard.ini'.
<p>
You can also create your own keyboards. A keyboard file has five parts:
<ol type=a>
<li>Comments
<li>A list of parameters
<li>A list of characters
<li>A list of vowels
<li>A list of punctuation
</ol>
<p>
Sections (c)-(e) are structured in exactly the same way. A line consists of a value, an equals sign, and another value, for example "k=K". This means that to get the Tibetan character associated with Wylie 'k', you must press 'K'. If there is no right part of the equation, then there is no way in this keyboard to get the relevant character. For example, if you see "k=", that means that there is no way in this keyboard to get the Tibetan character associated with Wylie 'k'. Be careful with whitespace, which is not ignored: for example, " = " means [space bar] = [space bar].
<p>
Although the three additional keyboards included in this installation always define only one keystroke per character/vowel, it is possible to define a keyboard in which multiple keystrokes correspond to single characters/vowels, as in the Extended Wylie keyboard. However, punctuation is only ever allowed to correspond to a single keystroke.
Below is a sample (partial) keyboard, with key parts explained, and much omitted:
<p>
Sambhota keyboard //Everything before &lt?parameters?> is taken to be a comment.
<p>
&lt?parameters?> //describes the logic of the keyboard
<br>has sanskrit stacking=true //is there a stack key for sanskrit stacks?
<br>has tibetan stacking=true //is there a stack key for tibetan stacks?
<br>is stacking medial=false //is the stack key medial, ie like '+' in g+y, or not, as in +gy
<br>stack key=f //what is the stack key? must be single character
<br>has disambiguating key=false //is there a key to distinguish between Wylie gy and g.y?
<br>disambiguating key= //if so, what is it?
<br>needs a chen before vowels=true //for a-chen plus vowel, must you type a-chen first?
<br>has 'a' vowel=false //is there a dummy 'a' vowel?
<br>is achung consonant=true //can achung take part in consonantal stacks?
<p>
&lt?characters?> //characters include consonants and numerals
<br>k=k
<br>kh=K //left value is Extended Wylie & right is equivalent in Sambhota
<br>g=g
<br>ng=G
<br>f= //no equivalent of 'f' in Sambhota
<p>
&lt?vowels?>
<br>a=a
<br>i=i
<br>u=u
<br>e=e
<br>o=o
<p>
&lt?punctuation?>
<br> = //read as [Space] = [Space]
<br>/=,
</p>
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
<a name="trouble"></a>
<h3>Troubleshooting</h3>
<p>
Some common problems:
<p>
<ul>
<li><b>I get garbage when I type Tibetan.</b>
<br>Make sure the TibetanMachineWeb fonts are installed. See <a href="#install">Running Jskad</a>.
<p><li><b>The vowels don't look right.</b>
<br>Due to <a 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.
<p><li><b>I can't convert from Wylie to Tibetan.</b>
<br>Make sure the Wylie you are using is <a href="/tibet/tools/jskad_docs/Wylie_keyboard.rtf" target="_blank">valid Extended Wylie</a>. Also, check to make 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.
<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.
<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.
</ul>
<p>
If all else fails, remove Java and Jskad from your computer, and then reinstall both.
</p>
<p>
<center><font size="-1"><a href="#top">Back to top</a></font></center>
</p>
</div>
</td>
</tr>
</table>
</div>
</body>
</html>