1Yudit Unicode Editor FAQ
2========================
3Version: 3.0.7
4Author:  Gaspar Sinai <gaspar@yudit.org>
5Date:    Tokyo 2020-06-07
6
7Q1: How can I display this FAQ again?
8A1: Type `help' in the command area. Similarly you can get a testpage
9 if you type `test' in the command area. Type 'howto japanese',
10 'howto configure' to get the howto pages.
11
12Q2: Where can I get updates?
13A2: Download them from http://www.yudit.org/
14
15Q3: I pressed Save Button and nothing happens. Why?
16A3: Yudit has a command line.
17  Most probably you just need to hit Enter Key.
18
19Q4: What is that [Line Break] on the right hand side that is mostly
20 showing "Unix"?
21A4: The line end marks are:
22 UNIX='\n'   - Unix line break
23 DOS='\r\n'  - DOS line break
24 MAC='\r'    - MAC line break
25 LS = U+2028 - Unicode line separator
26 PS = U+2029 - Unicode paragraph separator
27 In Yudit you can mix these - you can create a file that has DOS
28 and Unix lines for instance. But you should avoid mixing them if
29 possible.
30
31Q5: How can I get the list of encodings (-e options)?
32A5: Type `man uniconv' or `uniconv -h' in a shell window.
33
34Q6: How can I add my keyboard input file?
35A6: The file may already exist in
36    @YUDIT_DATA@/data
37 in this case you just need to add this to
38    @YUDIT_DATA@/config/yudit.properties
39 If not, you need to convert the source kmap file into binary format:
40    mytool -type kmap -kmap My.kmap -rkmap My.kmap  -write My.my
41 Then you need to copy My.my to ~/.yudit/data
42    cp My.my ~/.yudit/data
43 Please send me your kmap file (source) to include it in the next
44 distribution. For more info on kmap files, look at
45      @YUDIT_DATA@/doc/keymap-format.txt
46 The source code of the kmaps came with yudit are in
47      @YUDIT_DATA@/src/
48 Note that kmap files can be used as text converters and font maps too.
49
50Q7: How can I see messages in my own language?
51A7: Download the source code and read the README.TXT. It tells you
52 how to do it. Please send me the translations so that I can include
53 them in future versions.
54
55Q8: How can I add a TrueType font?
56A8: Put font-file.ttf and some-other-font-file.ttf into
57    @YUDIT_DATA@/fonts or ~/.yudit/fonts
58 after that modify
59    @YUDIT_DATA@/config/yudit.properties
60 adding a new virtual font MyFont
61    yudit.font.MyFont=font-file.ttf,some-other-fontfile.ttf,..
62 Now you can use this font in the editor window if you add it to
63    yudit.editor.fonts=...,MyFont,...
64 or the gui if you add it to:
65    yudit.fonts=...,MyFont,...
66
67Q9: Will there be a Windows version?
68A9: Yudit has an abstract windowing toolkit. This makes it possible to
69 port Yudit to, like svgalib for instance, very quickly.
70 I ported it for my wife Yuko in 2001 December. This was the first and
71 last time I touched Windows.
72
73Q10: How good of a Unicode editor is Yudit?
74A10: I tried to implement the Unicode standard wherever it made sense.
75 There are some quirks, please read the
76   @YUDIT_DATA@/doc/HOWTO-bidi.txt
77 for bidirectional compliance information.
78
79Q11: I specified 3 files on the command line and I can see only one now.
80A11: They are in the history buffer. If you go to the command input area
81 and hit Arrow-Up (or Ctrl-k) or Arrow-Down (or Ctrl-j) you can walk
82 through the file history.
83
84Q12: What are the hot-key bindings?
85A12: You can see most of them - the yellow tooltip shows them
86 underlined. Most of them should work with Ctrl as well as Alt keys.
87 The pluggable editor currently has the following keybindings:
88
89 Escape - switch between command mode and editing mode
90 Home - go to beginning of line
91 End - go to end of line
92 b - Page Up
93 f - Page Down
94 k - Up
95 n,j - Down
96 h - Left
97 l - Right
98 m - Delete Whole Line
99 x - Delete Selection
100 v - Paste Last Selection
101 If Meta is kept down while moving the caret, the text will be selected.
102 Mouse double click selects a word triple click selects a full line.
103
104Q13: How can I read the contents of a binary keymap file?
105A13: You can make a source dump like this:
106 mytool -my @YUDIT_DATA@/data/GreekBible.my \
107      -convert mys -write GreekBible.mys
108
109Q14: How can I quickly enter a unicode character?
110A14: Change input to [unicode], enter uxxxx or Uxxxxxxxx where x is
111 a hexadecimal number.
112
113Q15: Can Yudit do replace functions?
114A15: In The command area you need to type
115  replace old-text new-text
116 and hit an enter for each find/replace.
117
118Q16: When can I find the handwriting input method?
119A16: Click on the blue arrow (input method). Assign
120  freehand to one of the F keys.
121
122Q17: How can I turn off syntax highlighting?
123A17: From the command area by typing: 'syntax none'.
124  The available options are printed in error label
125  if you just type 'syntax'.  You can set this in
126  the config file too. If you type "howto syntax"
127  in the editor command area a help file is displayed,
128  which describes spell checker support too.
129
130Q18: How can I turn off word wrapping?
131A18: From the command area by typing: 'wordwrap false'.
132  Typing 'wordwrap true' turns on word wrapping.
133  You can set this in the config file too.
134
135Appendix
136========
1371.1. Keymap Examples
138
139 The following examples are for some kmaps that came with Yudit.
140 Russian
141  It maps phonetic Russian letters. The not so obvious ones are:
142     yo yields ё , c  yields ь,  q yields ъ
143     x yields ы ee yields э
144 Hungarian
145  It maps Hungarian and German characters. The  accented characters
146  can be input with the  English character followed by the accent.
147    Examples:
148      a' becomes á , o: becomes ö ,  o" becomes ő
149      SS produces the German ß , Ss  gives the paragraph sign §.
150  Kana
151   It maps Romaji into Hiragana and Katakana. Small letters are
152   used for Hiragana and capitals  are used for Katakana. The not
153   so obvious  ones are:
154      PP - 〒   <> - ◇  <>> - ◆     [] - □
155      []] - ■  OO - ●  <ESC>* - ☆  <ESC>** - ★
156       ~ - ・    Oo - ◎  o+ - ♀      o- - ♂
157       oC - ℃   Y= - ￥
158  Mnemonic
159    With this map you can use RFC1345 mnemonics to enter
160    the characters. Some examples:
161       &0u - ☺  &0U - ☻ &tel - ☏  &PI - ¶
162       &SU - ☼  &cH-   -  ♥  &M2=♫ &sn - ش
163  SGML maps SGML to unicode.
164     Examples:
165       &female; - ♀ &spades; - ♠, &boxvR; - ╞
166       &block; - █ &blk14; - ░ &frac18; - ⅛
167  Hangul maps Roman transliteration into Hangul characters.
168   The ISO/TC46/SC2/WG4 transliteration is used. You
169    can find out about it more at
170      http://www.hansoft.com/hangul/faq.html
171    Some examples:
172      ulyanghan - 우량한  pyohyeon - 표현
173      cinseon - 친선,  jageug - 자극 hwang geum 황금
174