File:  [mozdev] / anykey / www / user-manual.html
Revision 1.1: download - view: text, annotated - select for diffs - revision graph
Fri Apr 28 18:20:17 2006 UTC (11 years, 5 months ago) by taye
Branches: MAIN
CVS tags: HEAD
*** empty log message ***

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<!-- MAIN CONTENT -->
</head>
<body>
<div style="max-width: 575px ! important;">
<h2>User Manual</h2>
<p>There is a settings dialog that allows changing shortcut keys and
setting the prefered script.<br>
<br>
F2 toggles edit mode.<br>
<br>
Ctrl+Shift+M - transforms Translit to a specific (the user choosen one)
.
</p>
<p>The key sequence ctrl-shift-k acts as a shortcut to Any key
extension functionality.<br>
</p>
<h3><a name="TypingWithanykey">Choosing your language with Any key</a></h3>
<p>Once the extension is installed, a status bar button appears .Double
cliking on it open a window with the anykey settings title. The
"keymap" tabbed pane has a list box which propose a choice of scripts.<br>
</p>
<p>It is also possible to set the choosen script in the FF preferences
by setting the "anykey.keyMapName" to a new script name.It must be
already defined in the supported list of scripts wich can be viewed in
the anykey.keyboardList string in the preferences.<br>
</p>
<h3><a name="TypingWithanykey">&nbsp;Typing with Any key</a></h3>
Once the extension is installed "Any key" menu-item is added to the
context menu.
To type in the choosen script, simply right-click on the input field
(either Text or TextArea) and select "Any key".
Alternatively if the text cursor is already in the text box in
question, you can click on the 'Any key' button on the statusbar.
You will notice that due to the implementation of the extension, the
keyboard will sometimes change
back to the default keyboard (English.) This means that you have to
right click and select "Any key" again.
If you are interested to find out why that is, you can visit the <a
 href="design.html">design</a> page.
<br>
<br>
Interesting side-effect of having the status bar button is that if you
put the text cursor on the address text bar
(where the URL is typed) or on the search text bar, you can then click
on the status bar 'Any key' button to turn the translator on and
type in those input text fields in you script as well.
<br>
<br>
&nbsp;Any key can be used in ThunderBird to type in any input field
including the text editor in the
compose window. The scrolling and focusing behaviour in this window is
not well controlled so don't get too mad when the
window will lose focus as you type.&nbsp;<br>
<p></p>
<p>
</p>
<h3><a name="TransformingTranslit">Transforming Translit Into Cyrillic</a></h3>
It is now possible to transform text typed in Latin (English) letters
into your sscript.
To do so, simply select text that needs to be transformed (text can
either be inside a text input field or
simply static HTML text and select "Any key" menu-item from the context
menu or click on the 'Any key' button on the statusbar.
<br>
<br>
Be careful, current implementation of the translit-transformer does not
preserve the original HTML structure, so
when text is translated it may lose its HTML properties. This maybe
fixed in later releases.
<p></p>
<p>
</p>
<h3><a name="SwitchingKeyboardMap">Switching Keyboard Layout</a></h3>
It is&nbsp; possible to add a user defined keyboard layout.Currently it
is a manual process that must be followed precisely that maybe made
more user-friendly in the future.
<ol>
  <li>Design a new mapping that must respect these rules:</li>
  <ul>
    <li>a&nbsp; mapping where there only a one to one keymap is easy to
design : just prepare a String&nbsp; beginining&nbsp; with a { end
ending with } with : as separator between a char and it equivalent in
the script and , as a separator between two couples:exemple:
{"a":"&#1072;","b":"&#1073;","v":"&#1074;"}.</li>
    <li>to design a multiple key to one mapping the we have somethink
like that: {"c":"&#1094;","&#1094;h":"&#1095;"} where the we express that typing ch gives
&#1095;.It means that c--&gt;&#1094; and<span style="font-weight: bold;"> once we
get &#1094; </span>adding h gives &#1095;.</li>
  </ul>
  <li>In the URL text area of the browser type <i>about:config</i> and
press Enter.</li>
  <li>Find a key-value pair named anykey.keyboardList, and a key value
pair inside the value part the key by which the script will be refered
to and a value that will be displayed on the settings
windows:example:{"translit_ru":"translit.ru", "ethiopic-sera":"ethiopic
sera","ukrainian":"ukrainian","arabic-qualam":"arabic qualam",
"gost":"gost","devangari":"hindi devangari","myScript":"my keyboard"} <br>
  </li>
  <li>If you want to make it default, put the about key in the value of
the anykey.keyMapName preference here myScript. </li>
  <li>Restart the browser.</li>
</ol>
<p></p>
<p>
</p>
<h3><a name="SwitchingTransliterationMaps">Switching Transliteration
Mapping</a></h3>
The transliteration is based on the same keyboard choosen for the
typing.<br>
<ol>
</ol>
<p></p>
</div>
</body>
</html>


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>