path: root/doc/kate/index.docbook

<?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>[email protected]</email></term>
<listitem><para>Core Developer</para></listitem>
</varlistentry>
<varlistentry>
<term>Phlip <email>[email protected]</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>[email protected]</email></term>
<listitem><para>Testing...</para></listitem>
</varlistentry>
<varlistentry>
<term>Michael McCallum <email>[email protected]</email></term>
<listitem><para>Core Developer</para></listitem>
</varlistentry>
<varlistentry>
<term>Jochen Wilhemly <email>[email protected]</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>[email protected]</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>[email protected]</email></term>
<listitem><para>KWrite Undo History, KSpell integration</para></listitem>
</varlistentry>
<varlistentry>
<term>Scott Manson <email>[email protected]</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>[email protected]</email></term>
<listitem><para>Highlighting for RPM Spec-Files, Diff and more</para></listitem>
</varlistentry>
<varlistentry>
<term>Rocky Scaletta <email>[email protected]</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:
-->