summaryrefslogtreecommitdiffstats
path: root/doc/kate/index.docbook
blob: fe409a83db256de1b46e208a2cad9df355c105fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
  <!ENTITY kappname "&kate;">
  <!ENTITY package "kdebase">
  <!ENTITY configuring-chapter SYSTEM "configuring.docbook">
  <!ENTITY highlighting-appendix SYSTEM "highlighting.docbook">
  <!ENTITY advanced-chapter SYSTEM "advanced.docbook">
  <!ENTITY fundamentals-chapter SYSTEM "fundamentals.docbook">
  <!ENTITY mdi-chapter SYSTEM "mdi.docbook">
  <!ENTITY menu-chapter SYSTEM "menus.docbook">
  <!ENTITY part-chapter SYSTEM "part.docbook">
  <!ENTITY plugins-chapter SYSTEM "plugins.docbook">
  <!ENTITY regexp-appendix SYSTEM "regular-expressions.docbook">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
]>

<book lang="&language;">
<title>The &kate; Handbook</title>

<bookinfo>
<authorgroup>
<author>&Anders.Lund; &Anders.Lund.mail;</author>
<author>&Seth.Rothberg; &Seth.Rothberg.mail;</author>
<author>&Dominik.Haumann; &Dominik.Haumann.mail;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2000</year>
<year>2001</year>
<holder>&Seth.Rothberg;</holder>
</copyright>
<copyright>
<year>2002</year><year>2003</year><year>2005</year>
<holder>&Anders.Lund;</holder>
</copyright>
<copyright>
<year>2005</year>
<holder>&Dominik.Haumann;</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2005-12-29</date>
<releaseinfo>2.5.0</releaseinfo>

<abstract>
<para>&kate; is a programmer's text editor for &kde; 2.2 and above.</para>

<para>This handbook documents &kate; Version 2.5.0</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdebase</keyword>
<keyword>Kate</keyword>
<keyword>text</keyword>
<keyword>editor</keyword>
<keyword>programmer</keyword>
<keyword>programming</keyword>
<keyword>projects</keyword>
<keyword>MDI</keyword>
<keyword>Multi</keyword>
<keyword>Document</keyword>
<keyword>Interface</keyword>
<keyword>terminal</keyword>
<keyword>console</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>
Welcome to &kate;, a programmer's text editor for &kde; version 2.2 and
above. Some of &kate;'s many features include configurable syntax
highlighting for languages ranging from C and C++ to
<acronym>HTML</acronym> to bash scripts, the ability to create and
maintain projects, a multiple document interface
(<acronym>MDI</acronym>), and a self-contained terminal emulator.
</para>

<para>
But &kate; is more than a programmer's editor. Its ability to open
several files at once makes it ideal for editing &UNIX;'s many
configuration files.  This document was written in &kate;.
</para>

<para>
<mediaobject>
<imageobject><imagedata format="PNG" fileref="kate.png"/></imageobject>
<caption><para>Editing this manual...</para></caption>
</mediaobject>
</para>

</chapter>

&fundamentals-chapter;

&mdi-chapter;

&part-chapter;

&plugins-chapter;

&advanced-chapter;

&menu-chapter;

&configuring-chapter;

<chapter id="credits">

<title>Credits and License</title>

<para>
&kate;. Program copyright 2000, 2001, 2002 - 2005 by the &kate; developer team.
</para>

<variablelist>
<title>The &kate; team:</title>
<varlistentry>
<term>&Christoph.Cullmann; &Christoph.Cullmann.mail;</term>
<listitem><para>Project Manager &amp; Core Developer</para></listitem>
</varlistentry>
<varlistentry>
<term>&Anders.Lund; &Anders.Lund.mail;</term>
<listitem><para>Core Developer, Perl syntax highlighting,
documentation</para></listitem>
</varlistentry>
<varlistentry>
<term>&Joseph.Wenninger; &Joseph.Wenninger.mail;</term>
<listitem><para>Core Developer, syntax highlighting</para></listitem>
</varlistentry>
<varlistentry>
<term>Michael Bartl <email>michael.bartl1@chello.at</email></term>
<listitem><para>Core Developer</para></listitem>
</varlistentry>
<varlistentry>
<term>Phlip <email>phlip_cpp@my-deja.com</email></term>
<listitem><para>The project compiler</para></listitem>
</varlistentry>
<varlistentry>
<term>&Waldo.Bastian; &Waldo.Bastian.mail;</term>
<listitem><para>The cool buffer system</para></listitem>
</varlistentry>
<varlistentry>
<term>Matt Newell <email>newellm@proaxis.com</email></term>
<listitem><para>Testing...</para></listitem>
</varlistentry>
<varlistentry>
<term>Michael McCallum <email>gholam@xtra.co.nz</email></term>
<listitem><para>Core Developer</para></listitem>
</varlistentry>
<varlistentry>
<term>Jochen Wilhemly <email>digisnap@cs.tu-berlin.de</email></term>
<listitem><para>KWrite Author</para></listitem>
</varlistentry>
<varlistentry>
<term>&Michael.Koch; &Michael.Koch.mail;</term>
<listitem><para>KWrite port to KParts</para></listitem>
</varlistentry>
<varlistentry>
<term>Christian Gebauer <email>gebauer@bigfoot.com</email></term>
<listitem><para>Unspecified</para></listitem>
</varlistentry>
<varlistentry>
<term>&Simon.Hausmann; &Simon.Hausmann.mail;</term>
<listitem><para>Unspecified</para></listitem>
</varlistentry>
<varlistentry>
<term>Glen Parker <email>glenebob@nwlink.com</email></term>
<listitem><para>KWrite Undo History, KSpell integration</para></listitem>
</varlistentry>
<varlistentry>
<term>Scott Manson <email>sdmanson@alltel.net</email></term>
<listitem><para>KWrite XML syntax highlighting support</para></listitem>
</varlistentry>
<varlistentry>
<term>&John.Firebaugh; &John.Firebaugh.mail;</term>
<listitem><para>Various Patches</para></listitem>
</varlistentry>
<varlistentry>
<term>&Dominik.Haumann; &Dominik.Haumann.mail;</term>
<listitem><para>Developer, Highlight wizard</para></listitem>
</varlistentry>
</variablelist>

<variablelist>
<title>Many other people have contributed:</title>
<varlistentry>
<term>Matteo Merli <email>merlim@libero.it</email></term>
<listitem><para>Highlighting for RPM Spec-Files, Diff and more</para></listitem>
</varlistentry>
<varlistentry>
<term>Rocky Scaletta <email>rocky@purdue.edu</email></term>
<listitem><para>Highlighting for VHDL</para></listitem>
</varlistentry>
<varlistentry>
<term>Yury Lebedev </term>
<listitem><para>Highlighting for SQL</para></listitem>
</varlistentry>
<varlistentry>
<term>Chris Ross</term>
<listitem><para>Highlighting for Ferite</para></listitem>
</varlistentry>
<varlistentry>
<term>Nick Roux</term>
<listitem><para>Highlighting for ILERPG</para></listitem>
</varlistentry>
<varlistentry>
<term>John Firebaugh</term>
<listitem><para>Highlighting for Java, and much more</para></listitem>
</varlistentry>
<varlistentry>
<term>Carsten Niehaus</term>
<listitem><para>Highlighting for LaTeX</para></listitem>
</varlistentry>
<varlistentry>
<term>Per Wigren</term>
<listitem><para>Highlighting for Makefiles, Python</para></listitem>
</varlistentry>
<varlistentry>
<term>Jan Fritz</term>
<listitem><para>Highlighting for Python</para></listitem>
</varlistentry>
<varlistentry>
<term>&Daniel.Naber;</term>
<listitem><para>Small bugfixes, XML plugin</para></listitem>
</varlistentry>
</variablelist>

<para>Documentation copyright 2000,2001 &Seth.Rothberg;
&Seth.Rothberg.mail;</para>

<para>Documentation copyright 2002, 2003, 2005 &Anders.Lund;
&Anders.Lund.mail;</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;               <!-- FDL: do not remove -->
&underGPL;               <!-- GPL License -->

</chapter>

&highlighting-appendix;

&regexp-appendix;

<appendix id="installation">
<title>Installation</title>

&install.intro.documentation;

&install.compile.documentation;

</appendix>

&documentation.index;

<!--
Index Word List:
menu - context - syntax - markup - shortcuts - highlighting
embedded terminal - editing - search - replace - regexp -> Regular Expression
split window - selection - insert overwrite - selection -
configure/customize/preferences - insert/overwrite - non-printing characters
font - unicode - wordwrap/linewrap - project - bookmarks - docks - plugins
block selection / rectangles - view - indenting - editor - word processor
copy - paste - find - spelling - language (both kinds) - encoding -
pretty printing - formatting - line numbers - icon border -
folding - insert time - sed

done
comment / uncomment
configure / settings / preferences

-->

</book>

<!--
Local Variables:
mode: sgml
sgml-namecase-general: t
sgml-namecase-entity: nil
sgml-general-insert-case: lower
sgml-minimize-attributes: nil
sgml-omittag: nil
End:
-->