<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
 <!ENTITY kwrite "<application>kwrite</application>">
]>

<book lang="en">
<bookinfo>
<title>The KWrite Handbook</title>
<authorgroup>
<author>
<firstname>Cristian</firstname>
<surname>Tibirna</surname>
<affiliation>
<address><email>tibirna@kde.org</email></address>
</affiliation>
</author>
</authorgroup>
<date>25/01/1999</date>
<releaseinfo>0.98.00</releaseinfo>
<abstract>
<para>This Handbook describes KWrite Version 0.98</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KWrite</keyword>
<keyword>text editor</keyword>
<keyword>editor</keyword>
</keywordset>
</bookinfo>

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

<para>KWrite is a text editor for the KDE Desktop. It could be a
programmer's editor best used in conjunction with kfm for source file
browsing for different languages. KWrite may also serve well for
composition of small plain text documents. It is meant to be a
programmers editor, and it could be considered as a partial
alternative to more powerful editors such as XEmacs or Emacs. KWrite's
main functionality feature is the colorized syntax assured for many
programming languages: C/C++, Java, Python, Perl, Bash, Modula 2,
HTML, Ada.</para>

<sect1 id="whatsnew">
<title>New</title>

<para><itemizedlist>
<listitem>
<para>Python and Perl support</para>
</listitem>
<listitem>
<para> many, many others</para>
</listitem>
</itemizedlist>
</para>

<para>I hope you will enjoy this editor,</para>

<para><literal remap="tt">Jochen Wilhelmy</literal></para>

<para><ulink url="mailto:digisnap@cs.tu-berlin.de">digisnap@cs.tu-berlin.de</ulink></para>
</sect1>
</chapter>

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

<sect1 id="howtoobtainkwrite">
<title>How to obtain KWrite</title>

<para>KWrite is a core application of the KDE project <ulink url="http://www.kde.org">http://www.kde.org</ulink>.
KWrite can be found on <ulink url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the main ftp site
of the KDE project.</para>
</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>In order to successfully compile KWrite, you need the latest versions of <literal remap="tt"> libkdecore</literal>
and <literal remap="tt"> libkfm</literal>. All required libraries as well as KWrite itself can be found
on <ulink url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>. </para>
</sect1>

<sect1 id="compilationandinstallation">
<title>Compilation and installation</title>

<para>In order to compile and install KWrite on your system, type the following in the base 
directory of the KWrite distribution:
<screen>% ./configure
% make
% make install
</screen>
</para>

<para>Since KWrite uses <literal remap="tt">autoconf</literal> you should have not trouble compiling it.
Should you run into problems please report them to the <emphasis remap="sf">KDE</emphasis> mailing lists.</para>
</sect1>
</chapter>

<chapter id="onscreenfundamentals">
<title>Onscreen Fundamentals</title>

<para>KWrite is very simply to use. I am sure that if you have ever used a text edit you 
will have no problems with KWrite. </para>

<sect1 id="draganddrop">
<title>Drag and Drop</title>

<para>KWrite makes use of the KDE Drag and Drop protocol. This means that you can darg
and drop files form the Desktop or kfm or some remote ftp site that you have
open in one of kfm's windows on to KWrite. </para>
</sect1>

<sect1 id="editingfilesontheinternet">
<title>Editing files on the internet</title>

<para>You can open and save files transparently on the internet. Try the the following at the
command-line prompt to see an example of this.</para>

<para><screen>% kwrite ftp://ftp.kde.org/pub/kde/Welcome.msg
</screen>
</para>
</sect1>

<sect1 id="printing">
<title>Printing</title>

<para>KWrite doesn't support printing yet.</para>
</sect1>

<sect1 id="keybindings">
<title>Key Bindings</title>

<para>KWrite honors the following key bindings.</para>

<para><itemizedlist>
<listitem>
<para><literal remap="tt">Insert</literal> Toggle between Insert and Overwrite mode</para>
</listitem>
<listitem>
<para><literal remap="tt">Left Arrow</literal> Move the cursor one character leftwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Right Arrow</literal> Move the cursor one character rightwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Up Arrow</literal> Move the cursor one line upwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Down Arrow</literal> Move the cursor one line downwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Page Up</literal> Move the cursor one page upwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Page Down</literal> Move the cursor one page downwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Backspace</literal> Delete the character to the left of the cursor </para>
</listitem>
<listitem>
<para><literal remap="tt">Home</literal> Move the cursor to the beginning of the line </para>
</listitem>
<listitem>
<para><literal remap="tt">End</literal> Move the cursor to the end of the line </para>
</listitem>
<listitem>
<para><literal remap="tt">Delete</literal> Delete the character to the right of the cursor </para>
</listitem>
<listitem>
<para><literal remap="tt">Shift - Left Arrow</literal> Mark text one character leftwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Shift - Right Arrow</literal> Mark text one character rightwards </para>
</listitem>
<listitem>
<para><literal remap="tt">Alternate-S</literal> Set bookmark</para>
</listitem>
<listitem>
<para><literal remap="tt">Alternate-C</literal> Clear bookmark</para>
</listitem>
<listitem>
<para><literal remap="tt">F1</literal> Help</para>
</listitem>
<listitem>
<para><literal remap="tt">F3</literal> Find again</para>
</listitem>
<listitem>
<para><literal remap="tt">F5</literal> Vertical selection</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-F</literal> Find</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-C</literal> Copy the marked text to the clipboard. </para>
</listitem>
<listitem>
<para><literal remap="tt">Control-F</literal> Find</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-G</literal> Go to a given line</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-I</literal> Indent</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-K</literal> Delete a line</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-N</literal> New document (the one already in editing will be saved) </para>
</listitem>
<listitem>
<para><literal remap="tt">Control-R</literal> Replace</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-U</literal> Unindent</para>
</listitem>
<listitem>
<para><literal remap="tt">Control-V</literal> Paste the clipboard text into line edit. </para>
</listitem>
<listitem>
<para><literal remap="tt">Control-X</literal> Cut the marked text, copy to clipboard. </para>
</listitem>
</itemizedlist>
</para>
</sect1>
</chapter>

<chapter id="themenuentries">
<title>The Menu Entries</title>

<sect1 id="file">
<title>File</title>

<sect2 id="new">
<title>New</title>

<para>Opens a new Document in the editor</para>
</sect2>

<sect2 id="open">
<title>Open</title>

<para>Allows the user to open a document</para>
</sect2>

<sect2 id="insert">
<title>Insert</title>

<para>Allows the user to insert a new document in the edited document</para>
</sect2>

<sect2 id="openrecent">
<title>Open Recent</title>

<para>A fast list of previously opened documents</para>
</sect2>

<sect2 id="save">
<title>Save</title>

<para>Saves the current Document</para>
</sect2>

<sect2 id="saveas">
<title>Save As</title>

<para>Allows the user to save the document in a new file.</para>
</sect2>

<sect2 id="close">
<title>Close</title>

<para>Closes the editor window. If the closed editor window was the last instance open,
KWrite will exit.</para>
</sect2>

<sect2 id="newwindow">
<title>New Window</title>

<para>Creates a new window</para>
</sect2>

<sect2 id="newview">
<title>New View</title>

<para>Creates a new view of the same document</para>
</sect2>
</sect1>

<sect1 id="edit">
<title>Edit</title>

<sect2 id="copy">
<title>Copy </title>

<para>Copies the current selection to the clip board.</para>
</sect2>

<sect2 id="cut">
<title>Cut</title>

<para>Deletes the current selection and places it into the clip board</para>
</sect2>

<sect2 id="paste">
<title>Paste</title>

<para>Inserts the content of the clip board at the current cursor position</para>
</sect2>

<sect2 id="find">
<title>Find</title>

<para>Opens the find dialog. </para>
</sect2>

<sect2 id="replace">
<title>Replace</title>

<para>Opens the replace dialog</para>
</sect2>

<sect2 id="findagain">
<title>Find Again </title>

<para>Repeats the last find operation , if a find operation has already taken place.</para>
</sect2>

<sect2 id="gotoline">
<title>Goto Line</title>

<para>Opens the goto line dialog</para>
</sect2>

<sect2 id="undo">
<title>Undo</title>

<para>Annulated the last operation</para>
</sect2>

<sect2 id="redo">
<title>Redo</title>

<para>Redoes the last annulated operation</para>
</sect2>

<sect2 id="indent">
<title>Indent</title>

<para>Increases the paragraph's indentation</para>
</sect2>

<sect2 id="unindent">
<title>Unindent</title>

<para>Reduces the paragraph's indentation</para>
</sect2>

<sect2 id="selectall">
<title>Select All</title>

<para>Selects all the buffer</para>
</sect2>

<sect2 id="unselectall">
<title>Unselect All</title>

<para>Annulates the selections</para>
</sect2>

<sect2 id="inverttheselection">
<title>Invert the selection</title>

<para>Selects the unselected text and annulates the previous selection</para>
</sect2>
</sect1>

<sect1 id="bookmarks">
<title>Bookmarks</title>

<para></para>

</sect1>

<sect1 id="options">
<title>Options</title>

<sect2 id="sethighlight">
<title>Set Highlight</title>

<para>Allows the user to choose the type of color highlighting which the editor uses to display the text.
The font/color information is not stored with the document. </para>
</sect2>

<sect2 id="defaults">
<title>Defaults</title>

<para>Allows the user to set and save a group of default settings: font, fg/bg color, for each type of highlight definition</para>
</sect2>

<sect2 id="highlight">
<title>Highlight</title>

<para>Allows the user to customize in detail the way highlight rules work for him (together with mime type association for each highlight definition). </para>
</sect2>

<sect2 id="colors">
<title>Colors</title>

<para>Allows the user to select fore and background color of KWrite's text display area.</para>
</sect2>

<sect2 id="verticalselection">
<title>Vertical Selection</title>

<para>Turns on/off the vertical selection feature</para>
</sect2>

<sect2 id="showtoolbar">
<title>Show toolbar</title>

<para></para>

</sect2>

<sect2 id="showstatusbar">
<title>Show statusbar</title>

<para></para>

</sect2>

<sect2 id="saveconfig">
<title>Save Config</title>

<para>Saves the modified configurations</para>
</sect2>
</sect1>

<sect1 id="help">
<title>Help</title>

<sect2 id="contents">
<title>Contents</title>

<para>Invokes the KDE help system with the KWrite help pages displayed.</para>
</sect2>

<sect2 id="aboutkwrite">
<title>About kwrite</title>

<para>Displays essential information about KWrite.</para>
</sect2>

<sect2 id="aboutkde">
<title>About KDE</title>

<para>Displays essential information about KDE</para>
</sect2>
</sect1>
</chapter>

<chapter id="questionsandanswers">
<title>Questions and answers</title>

<para></para>

</chapter>
</book>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->
