~ubuntu-branches/ubuntu/quantal/kiten/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/index.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Harald Sitter
  • Date: 2011-07-10 11:23:47 UTC
  • Revision ID: james.westby@ubuntu.com-20110710112347-ykfhtvam3kgssspo
Tags: upstream-4.6.90+repack
ImportĀ upstreamĀ versionĀ 4.6.90+repack

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" ?>
 
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
 
3
  <!ENTITY kappname "&kiten;">
 
4
  <!ENTITY package "kdeedu">
 
5
  <!ENTITY % addindex "IGNORE">
 
6
  <!ENTITY % English "INCLUDE">
 
7
]>
 
8
 
 
9
<book lang="&language;">
 
10
 
 
11
<bookinfo>
 
12
<title>The &kiten; Handbook</title>
 
13
 
 
14
<authorgroup>
 
15
<author>
 
16
<firstname>Jason</firstname>
 
17
<surname>Katz-Brown</surname>
 
18
<affiliation>
 
19
<address>&Jason.Katz-Brown.mail;</address>
 
20
</affiliation>
 
21
</author>
 
22
<!-- TRANS:ROLES_OF_TRANSLATORS -->
 
23
</authorgroup>
 
24
 
 
25
<legalnotice>&FDLNotice;</legalnotice>
 
26
 
 
27
<date>2010-07-15</date>
 
28
<releaseinfo>1.2 (&kde; 4.5)</releaseinfo>
 
29
 
 
30
<!-- Abstract about this handbook -->
 
31
 
 
32
<abstract>
 
33
<para>&kiten; is a Japanese reference/study tool for &kde;. </para>
 
34
</abstract>
 
35
 
 
36
 
 
37
<keywordset>
 
38
<keyword>KDE</keyword>
 
39
<keyword>Japanese</keyword>
 
40
<keyword>Language</keyword>
 
41
</keywordset>
 
42
 
 
43
</bookinfo>
 
44
 
 
45
<chapter id="introduction"> 
 
46
<title>Introduction</title>
 
47
 
 
48
<para>&kiten; is an application with multiple functions.  Firstly, it
 
49
is a convenient English to Japanese and Japanese to English
 
50
dictionary; secondly, it is a Kanji dictionary, with multiple ways to
 
51
look up specific characters; thirdly, it is a tool to help you learn
 
52
Kanji.</para>
 
53
 
 
54
<para>Each of these modes is discussed in its own chapter.</para>
 
55
 
 
56
<screenshot>
 
57
<screeninfo>Here's a screenshot of &kiten;</screeninfo>
 
58
<mediaobject>
 
59
<imageobject><imagedata fileref="kiten1.png" format="PNG"/></imageobject>
 
60
<textobject><phrase>&kiten; screenshot</phrase></textobject>
 
61
</mediaobject>
 
62
</screenshot>
 
63
 
 
64
</chapter>
 
65
 
 
66
<chapter id="dictionary"> 
 
67
<title>Using the Dictionary</title>
 
68
 
 
69
<para>&kiten;'s most basic mode is as a dictionary for looking up both
 
70
English and Japanese words. You can also add other dictionaries to
 
71
&kiten;'s list.</para>
 
72
 
 
73
<para>&kiten; uses Jim Breen's Edict and Kanjidic as the default dictionaries. You can find more information at <ulink url="http://www.csse.monash.edu.au/~jwb/edict.html">the Edict web site</ulink> and <ulink url="http://www.csse.monash.edu.au/~jwb/kanjidic.html">the Kanjidic web site</ulink>.</para>
 
74
 
 
75
<sect1 id="looking-up-words"> 
 
76
<title>Looking Up Words</title>
 
77
 
 
78
<para>To look up words in either language, type them in to the
 
79
text-edit (much like &konqueror;'s location bar) and press either
 
80
&Enter; or the <guilabel>Search</guilabel> button on
 
81
the toolbar (again, much like &konqueror;). &kiten; will then look up
 
82
the word.</para>
 
83
 
 
84
<para>You can enter Kanji, Kana and English and get back results from
 
85
&kiten;.  These results of your search will appear in the large
 
86
results view which takes up the majority of the &kiten; window.</para>
 
87
 
 
88
<screenshot>
 
89
<screeninfo>searching for an English translation</screeninfo>
 
90
<mediaobject>
 
91
<imageobject><imagedata fileref="kiten2.png" format="PNG"/></imageobject>
 
92
<textobject><phrase>&kiten; search screenshot</phrase></textobject>
 
93
</mediaobject>
 
94
</screenshot>
 
95
 
 
96
<sect2> 
 
97
<title>Filtering</title>
 
98
 
 
99
<para>Often times you will want to filter rare words from your
 
100
search. &kiten; will do this for you if toggle
 
101
<menuchoice><guimenu>Search</guimenu><guimenuitem>Filter
 
102
Out Rare</guimenuitem></menuchoice>.</para>
 
103
 
 
104
<note><para>Not all dictionary files support filtering rare entries -
 
105
most dictionaries, excluding the two provided by default in &kiten; do
 
106
not.</para></note>
 
107
<!-- not in kde4
 
108
<para>If you have not enabled filtering rare entries, common entries
 
109
will be labeled <guilabel>Common</guilabel> in the result view.</para>
 
110
-->
 
111
</sect2>
 
112
 
 
113
</sect1>
 
114
 
 
115
<sect1 id="advanced-searches"> 
 
116
<title>Advanced Searches</title>
 
117
 
 
118
<para>&kiten; supports more advanced searches than plain normal word
 
119
searches.</para>
 
120
 
 
121
<sect2> 
 
122
<title>Beginning/Anywhere Searches</title>
 
123
<para>Beside a search with <guilabel>Exact Match</guilabel> &kiten; has
 
124
two additional search modes</para>
 
125
<para>To search for the beginning of a word, instead of pressing the
 
126
<guilabel>Search</guilabel> button on the toolbar or pressing
 
127
<keycap>Return</keycap> on the text-entry in the toolbar, choose
 
128
using the <menuchoice><guimenu>Search</guimenu><guisubmenu>Match Type
 
129
</guisubmenu><guimenuitem>Match Beginning</guimenuitem></menuchoice>. Similarly, choose
 
130
<menuchoice><guimenu>Search</guimenu><guisubmenu>Match
 
131
Type</guisubmenu><guimenuitem>Match Anywhere</guimenuitem></menuchoice> to search for your text anywhere
 
132
in a word. These search modes work for searches of both
 
133
languages.</para>
 
134
 
 
135
</sect2>
 
136
 
 
137
<sect2> 
 
138
<title>Searching in Results</title>
 
139
 
 
140
<para>&kiten; can also help you refine your searches by allowing you
 
141
to search for new text in the results generated by a previous
 
142
search. To do this, just choose
 
143
<menuchoice><guimenu>Search</guimenu><guimenuitem>Search in
 
144
Results</guimenuitem></menuchoice> to perform your search.</para>
 
145
 
 
146
</sect2>
 
147
 
 
148
</sect1>
 
149
 
 
150
<sect1 id="deinf"> 
 
151
<title>Verb Deinflection</title>
 
152
 
 
153
<para>&kiten; can deinflect verbs you search for. To enable this, make
 
154
sure you have enabled the "builtin" dictionary for verb deinflection. &kiten;
 
155
will then deinflect Japanese you search for that starts with a Kanji
 
156
and ends with a Kana.</para>
 
157
<para>
 
158
The "Deinflect" option tries to unconjugate Japanese verbs. Deinflect only supports the common verb conjugations. If you search a lot of Japanese text you might consider using this option until you get used to handling Japanese verb forms.
 
159
</para>
 
160
</sect1>
 
161
 
 
162
</chapter>
 
163
 
 
164
<chapter id="looking-up-kanji"> 
 
165
<title>Looking Up Kanji</title>
 
166
 
 
167
<para>&kiten; has features that makes finding the one kanji you want
 
168
easy from over 14,000 in the default dictionary.</para>
 
169
 
 
170
<note> <para>Clicking on any Kanji in the main result view will show
 
171
details on that particular Kanji. This can sometimes be the fastest
 
172
way to look up a kanji.</para></note>
 
173
 
 
174
<tip><para>Kanji searches are also filtered according to whether
 
175
<menuchoice><guimenu>Search</guimenu><guimenuitem>Filter
 
176
Out Rare</guimenuitem></menuchoice> is checked.</para></tip>
 
177
 
 
178
<sect1 id="regular-kanji-search"> 
 
179
<title>Regular Searching</title>
 
180
 
 
181
<para>You can search with English and Japanese search strings the
 
182
exact same way you can with the normal dictionary.</para>
 
183
 
 
184
<caution><para>When searching for Kana readings in the Kanji
 
185
dictionary, you will have to put a period before the okurigana (the
 
186
kana that are not part of the Kanji).</para></caution>
 
187
 
 
188
</sect1>
 
189
 
 
190
<sect1 id="radical-search"> 
 
191
<title>Radical Searching</title>
 
192
 
 
193
<para>You can use &kiten;'s radical search dialog to search for Kanji
 
194
with a combination of radicals and a certain stroke count. Choose
 
195
<menuchoice><guimenu>Search</guimenu><guimenuitem>Radical
 
196
Selector</guimenuitem></menuchoice> to open the radical search
 
197
dialog.</para>
 
198
 
 
199
<para>To choose the radicals you want to be in your Kanji, select one 
 
200
them from the buttons at the bottom of the window. To display possible radicals to select from
 
201
this buttons with a certain number of strokes, choose this number of
 
202
strokes from the spinboxes just above the buttons. The radicals you
 
203
choose will appear in the listbox at the top.</para>
 
204
 
 
205
<para>To choose how many strokes your Kanji should have, just enter the
 
206
values into the spin boxes below the results area.</para>
 
207
 
 
208
<para>To perform the lookup, press the button that matches the kanji you
 
209
wanted to look up.</para>
 
210
 
 
211
</sect1>
 
212
 
 
213
<sect1 id="grade-search"> 
 
214
<title>Grade Search</title>
 
215
 
 
216
<para>To get a list of all Kanji in a certain grade, enter that into the search
 
217
box as "G:4" (G: is the Kanjidic tag for grade).</para>
 
218
 
 
219
</sect1>
 
220
 
 
221
<sect1 id="stroke-search"> 
 
222
<title>Stroke Search</title>
 
223
 
 
224
<para>To get a list of all Kanji with a certain number of strokes,
 
225
enter that number in the text-entry in the toolbar as "S:4".</para>
 
226
 
 
227
</sect1>
 
228
 
 
229
</chapter>
 
230
 
 
231
<chapter id="misc"> 
 
232
<title>Miscellaneous</title>
 
233
 
 
234
<para>This chapter describes miscellaneous features that can be used
 
235
in both modes in &kiten;'s main window.</para>
 
236
 
 
237
<sect1 id="history"> 
 
238
<title>The History</title>
 
239
<!-- changed in kde4-->
 
240
<para>&kiten; keeps track of all of your queries in the input field. You can
 
241
see your last results by clicking on the check mark at the right of the input field.
 
242
To go forward one in the history, choose
 
243
<menuchoice><guimenu>Go</guimenu><guimenuitem>Forward</guimenuitem></menuchoice>. To
 
244
go backward one in the history, choose
 
245
<menuchoice><guimenu>Go</guimenu><guimenuitem>Back</guimenuitem></menuchoice>.</para>
 
246
 
 
247
</sect1>
 
248
<!-- how to do that in kde4 ?
 
249
<sect1 id="global-keys"> 
 
250
<title>Global Shortcuts</title>
 
251
 
 
252
<para>You can set global &kiten; shortcuts that work everywhere on
 
253
your desktop. Go to the &kiten; configuration dialog, which can be
 
254
opened by choosing
 
255
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
 
256
Kiten...</guimenuitem></menuchoice>. Select the <guilabel>Global
 
257
Keys</guilabel> section of the dialog. Here you can set the keys for a
 
258
global word search and a global Kanji search like in other &kde;
 
259
shortcut configuration panels.</para>
 
260
 
 
261
</sect1>
 
262
-->
 
263
<sect1 id="fonts"> 
 
264
<title>Fonts</title>
 
265
 
 
266
<para>You can choose the font that &kiten; uses in its result view. 
 
267
Go to the &kiten; configuration dialog, which can be
 
268
opened by choosing
 
269
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
 
270
Kiten...</guimenuitem></menuchoice>. Select the
 
271
<guilabel>Font</guilabel> page of the dialog and select the font in
 
272
the font-chooser.</para>
 
273
 
 
274
<note><para>&Qt; 's font-substitution system makes it so a
 
275
Japanese font will always be substituted for Japanese characters, even
 
276
if the font you specify doesn't include them. Thus, you can choose any
 
277
font in the chooser and everything should still display
 
278
fine.</para></note>
 
279
 
 
280
</sect1>
 
281
 
 
282
</chapter>
 
283
 
 
284
<chapter id="credits-and-license">
 
285
<title>Credits and Licenses</title>
 
286
 
 
287
<para>&kiten; copyright 2001, 2002 &Jason.Katz-Brown;</para>
 
288
 
 
289
<itemizedlist>
 
290
<title>Developers</title>
 
291
<listitem>
 
292
<para>&Jason.Katz-Brown; &Jason.Katz-Brown.mail;</para>
 
293
</listitem>
 
294
<listitem>
 
295
<para>&Neil.Stevens; &Neil.Stevens.mail;</para>
 
296
</listitem>
 
297
<listitem>
 
298
<para>Jim Breen <email>jwb@csse.monash.edu.au</email> - Wrote xjdic, of which &kiten; borrows code, and the xjdic index file generator. Also is main author of edict and kanjidic, which &kiten; essentially require.</para>
 
299
</listitem>
 
300
<listitem>
 
301
  <para>Paul Temple <email>paul.temple@gmx.net</email> - Port to KConfig XT and bug fixing.</para>
 
302
</listitem>
 
303
<listitem>
 
304
        <para>Joe Kerian <email>jkerian@gmail.com</email> - wrote kiten v4 </para>
 
305
</listitem>
 
306
</itemizedlist>
 
307
 
 
308
<para>Documentation copyright 2002, &Jason.Katz-Brown;</para>
 
309
 
 
310
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 
311
 
 
312
&underFDL;
 
313
&underGPL;
 
314
 
 
315
</chapter>
 
316
 
 
317
<!-- <appendix id="installation">
 
318
<title>Installation</title>
 
319
 
 
320
&install.intro.documentation;
 
321
&install.compile.documentation;
 
322
 
 
323
</appendix> -->
 
324
 
 
325
&documentation.index; 
 
326
</book>