Yudit Unicode Editor FAQ
========================
Version: 2.9.2
Author:  Gaspar Sinai <gaspar@yudit.org>
Date:    Tokyo 2010-01-31

Q1: How can I display this FAQ again?
A1: Type `help' in the command area. Similarly you can get a testpage
 if you type `test' in the command area. Type 'howto japanese', 
 'howto configure' to get the howto pages.

Q2: Where can I get updates?
A2: Download them from http://www.yudit.org/

Q3: I pressed Save Button and nothing happens. Why?
A3: Yudit has a command line. 
  Most probably you just need to hit Enter Key.

Q4: What is that [Line Break] on the right hand side that is mostly 
 showing "Unix"?
A4: The line end marks are:
 UNIX='\n'   - Unix line break
 DOS='\r\n'  - DOS line break
 MAC='\r'    - MAC line break
 LS = U+2028 - Unicode line separator
 PS = U+2029 - Unicode paragraph separator
 In Yudit you can mix these - you can create a file that has DOS 
 and Unix lines for instance. But you should avoid mixing them if 
 possible.

Q5: How can I get the list of encodings (-e options)?
A5: Type `man uniconv' or `uniconv -h' in a shell window. 

Q6: How can I add my keyboard input file?
A6: The file may already exist in 
    /usr/pkg/share/yudit/data
 in this case you just need to add this to 
    /usr/pkg/share/yudit/config/yudit.properties
 If not, you need to convert the source kmap file into binary format:
    mytool -type kmap -kmap My.kmap -rkmap My.kmap  -write My.my
 Then you need to copy My.my to ~/.yudit/data
    cp My.my ~/.yudit/data
 Please send me your kmap file (source) to include it in the next
 distribution. For more info on kmap files, look at 
      /usr/pkg/share/yudit/doc/keymap-format.txt
 The source code of the kmaps came with yudit are in
      /usr/pkg/share/yudit/src/
 Note that kmap files can be used as text converters and font maps too.

Q7: How can I see messages in my own language?
A7: Download the source code and read the README.TXT. It tells you 
 how to do it. Please send me the translations so that I can include 
 them in future versions.

Q8: How can I add a TrueType font?
A8: Put font-file.ttf and some-other-font-file.ttf into 
    /usr/pkg/share/yudit/fonts or ~/.yudit/fonts
 after that modify 
    /usr/pkg/share/yudit/config/yudit.properties
 adding a new virtual font MyFont
    yudit.font.MyFont=font-file.ttf,some-other-fontfile.ttf,..
 Now you can use this font in the editor window if you add it to
    yudit.editor.fonts=...,MyFont,...
 or the gui if you add it to:
    yudit.fonts=...,MyFont,...

Q9: Will there be a Windows version?
A9: Yudit has an abstract windowing toolkit. This makes it possible to
 port Yudit to, like svgalib for instance, very quickly. 
 I ported it for my wife Yuko in 2001 December. This was the first and
 last time I touched Windows.

Q10: How good of a Unicode editor is Yudit?
A10: I tried to implement the Unicode standard wherever it made sense.
 There are some quirks, please read the 
   /usr/pkg/share/yudit/doc/HOWTO-bidi.txt
 for bidirectional compliance information. 

Q11: I specified 3 files on the command line and I can see only one now.
A11: They are in the history buffer. If you go to the command input area
 and hit Arrow-Up (or Ctrl-k) or Arrow-Down (or Ctrl-j) you can walk 
 through the file history.

Q12: What are the hot-key bindings?
A12: You can see most of them - the yellow tooltip shows them 
 underlined. Most of them should work with Ctrl as well as Alt keys.
 The pluggable editor currently has the following keybindings:

 Escape - switch between command mode and editing mode
 Home - go to beginning of line
 End - go to end of line
 b - Page Up
 f - Page Down
 k - Up
 n,j - Down
 h - Left
 l - Right
 m - Delete Whole Line
 x - Delete Selection
 v - Paste Last Selection
 If Meta is kept down while moving the caret, the text will be selected.
 Mouse double click selects a word triple click selects a full line.

Q13: How can I read the contents of a binary keymap file?
A13: You can make a source dump like this:
 mytool -my /usr/pkg/share/yudit/data/GreekBible.my \
      -convert mys -write GreekBible.mys

Q14: How can I quickly enter a unicode character?
A14: Change input to [unicode], enter uxxxx or Uxxxxxxxx where x is
 a hexadecimal number. 

Q15: Can Yudit do replace functions?
A15: In The command area you need to type
  replace old-text new-text
 and hit an enter for each find/replace.

Q16: When can I find the handwriting input method?
A16: Click on the blue arrow (input method). Assign
  freehand to one of the F keys.

Q17: How can I turn off syntax highlighting?
A17: From the command area by typing: 'syntax none'. 
  The available options are printed in error label 
  if you just type 'syntax'.  You can set this in 
  the config file too. If you type "howto syntax"
  in the editor command area a help file is displayed,
  which describes spell checker support too.

Q18: How can I turn off word wrapping?
A18: From the command area by typing: 'wordwrap false'. 
  Typing 'wordwrap true' turns on word wrapping.
  You can set this in the config file too.

Appendix
========
1.1. Keymap Examples

 The following examples are for some kmaps that came with Yudit.
 Russian
  It maps phonetic Russian letters. The not so obvious ones are:
     yo yields ё , c  yields ь,  q yields ъ
     x yields ы ee yields э
 Hungarian
  It maps Hungarian and German characters. The  accented characters 
  can be input with the  English character followed by the accent.
    Examples:
      a' becomes á , o: becomes ö ,  o" becomes ő 
      SS produces the German ß , Ss  gives the paragraph sign §.
  Kana 
   It maps Romaji into Hiragana and Katakana. Small letters are 
   used for Hiragana and capitals  are used for Katakana. The not 
   so obvious  ones are:
      PP - 〒   <> - ◇  <>> - ◆     [] - □
      []] - ■  OO - ●  <ESC>* - ☆  <ESC>** - ★  
       ~ - ・    Oo - ◎  o+ - ♀      o- - ♂
       oC - ℃   Y= - ￥
  Mnemonic
    With this map you can use RFC1345 mnemonics to enter
    the characters. Some examples:
       &0u - ☺  &0U - ☻ &tel - ☏  &PI - ¶
       &SU - ☼  &cH-   -  ♥  &M2=♫ &sn - ش
  SGML maps SGML to unicode.
     Examples:
       &female; - ♀ &spades; - ♠, &boxvR; - ╞
       &block; - █ &blk14; - ░ &frac18; - ⅛
  Hangul maps Roman transliteration into Hangul characters.
   The ISO/TC46/SC2/WG4 transliteration is used. You
    can find out about it more at
      http://www.hansoft.com/hangul/faq.html
    Some examples:
      ulyanghan - 우량한  pyohyeon - 표현
      cinseon - 친선,  jageug - 자극 hwang geum 황금
