<chapter id="fundamentals">
<chapterinfo>
<authorgroup>
<author><personname><firstname></firstname></personname></author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>The Fundamentals</title>

<para>
If you have ever used a text editor, you will have no problem using
&kate;. In the next two sections, <link linkend="starting-kate">Starting
&kate; </link> and in <link linkend="working-with-kate">Working with
&kate;</link>, we'll show you everything you need to get up and running
quickly.
</para>

<sect1 id="starting-kate">
<title>Starting &kate;</title>

<para>
You can start &kate; from the <guimenu>K menu</guimenu> or from the
command line.
</para>

<sect2 id="starting-from-the-menu">
<title>From the Menu</title>
<para>
Open the &kde; program menu by clicking on the
<guiicon>big K</guiicon> icon on the toolbar at the bottom left of your
screen. This will raise the <guimenu>program menu</guimenu>. Move your
cursor up the menu to the <guimenu>Editors</guimenu> menu item. A list
of available editors will appear. Choose
<guimenuitem>&kate;</guimenuitem>.
</para>

<para>
Unless you configure &kate; not to, it will load the last files you
edited. See <link linkend="configure">Configuring &kate;</link> to learn
how to toggle this feature on and off.
</para>

</sect2>

<sect2 id="starting-from-the-command-line">
<title>From the Command Line</title>

<para>
You can start &kate; by typing its name on the command line. If you give
it a file name, as in the example below, it will open or create that
file.
</para>

<informalexample>
<screen>
<prompt>%</prompt><userinput><command>kate</command> <option><replaceable>myfile.txt</replaceable></option></userinput>
</screen>
</informalexample>

<para>
If you have an active connection, and permission, you can take advantage
of &kde;'s network transparency to open files on the internet.
</para>

<informalexample>
<screen>
<prompt>%</prompt><userinput><command>kate</command> <option><replaceable>ftp://ftp.kde.org/pub/kde/README_FIRST</replaceable></option></userinput>
</screen>
</informalexample>

<sect3 id="command-line-options">
<title>Command Line Options</title>
<para>&kate; accepts following command line options:</para>

<variablelist>
<varlistentry>
<term><userinput><command>kate</command> <option>--help</option></userinput></term>
<listitem>
<para>
This lists the most basic options available at the command line.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>kate</command>
<option>--help-qt</option></userinput></term>
<listitem>
<para>
This lists the options available for changing the way &kate; interacts
with &Qt;.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>kate</command> <option>--help-kde</option></userinput></term>
<listitem>
<para>
This lists the options available for changing the way &kate; interacts
with &kde;.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>kate</command>
<option>--help-all</option></userinput></term>
<listitem>
<para>
This lists all of the command line options.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>kate</command>
<option>--author</option></userinput></term>
<listitem>
<para>
Lists &kate;'s authors in the terminal window.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>kate</command>
<option>--version</option></userinput></term>
<listitem>
<para>
Lists version information for &Qt;, &kde;, and &kate;.  Also available
through <userinput><command>kate</command>
<option>-V</option></userinput>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><userinput><command>kate</command>
<option>--license</option></userinput></term>
<listitem>
<para>
Shows license information.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>

<sect2 id="drag-and-drop">
<title>Drag and Drop</title>
<para>
&kate; uses the &kde; Drag and Drop protocol. Files may be dragged and
dropped onto &kate; from the Desktop, &konqueror; or some remote ftp
site opened in one of &konqueror;'s windows.
</para>
</sect2>
</sect1>

<sect1 id="working-with-kate">
<title>Working with &kate;</title>
<para>
<link linkend="quick-start">Quick Start</link> will show you how to
toggle four simple options that will let you configure some of &kate;'s
more powerful features right away. <link linkend="keystroke-commands">
Keystroke Commands</link> lays out some of the default keystroke
shortcuts for those who can't or don't want to use a mouse.
</para>

<sect2 id="quick-start">
<title>Quick Start</title>

<para>
This section will describe some of the items on the
<guimenu>Settings</guimenu> menu so that you can quickly configure
&kate; to work the way you want it.
</para>

<para> When you start &kate; for the first time you'll see two windows
with white backgrounds. Above the two windows is a toolbar with the
usual labeled icons. And above that, a menu bar.
</para>

<para>
The left-hand window is a dockable side bar. It combines the Filelist
and Fileselector windows. Switch between the two by clicking on the tabs
at the top of the window. </para>

<para>
If you've started &kate; with a file, the right-hand window will show
the file you are editing and the Filelist on the side bar will show the
name of the file. Use the Fileselector window to open files.
</para>

<para>
You can toggle the Filelist and Fileselector window on and off in
<guimenu>Settings</guimenu> menu. This menu offers you your first
glimpse into &kate;'s power and flexibility.  In this section we'll look
at four items:
</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenuitem>Show
Toolbar</guimenuitem></menuchoice></term>
<listitem>
<para>
Toggles the toolbar on and off.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenuitem>Show Filelist</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Toggles the Filelist on and off. If the Filelist/Fileselector window is
not open, &kate; launches the side bar as a separate, undocked,
window. To dock the window grab the two thin parallel lines above the
tabs by clicking on them with your &LMB; and holding the button
down. Drag the the window into &kate;'s editing window and release the
&LMB; when you have positioned the Filelist/Fileselector window as you
prefer.
</para>

<tip>
<para>
If you have grabbed the two parallel lines successfully your mouse
pointer will turn into two crossed arrows as you drag.
</para>
</tip>

</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><guimenuitem>Show
Fileselector</guimenuitem></menuchoice></term>
<listitem>
<para>
Toggles the Fileselector on and off. This menu item is the same as
<guimenuitem>Show Filelist</guimenuitem> with one difference.  Toggling
it on launches the window with the Fileselector on top.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenuitem>Show
Console</guimenuitem></menuchoice></term>
<listitem>
<para>
Toggles a console emulator on and off at the bottom of &kate;'s
window. In other words, it gives you a command line within the
application.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>

<sect2 id="keystroke-commands">
<title>Keystroke Commands</title>

<para>
Many of &kate;'s keystroke commands (shortcuts) are configurable by
way of the <link linkend="settings">Settings</link> menu.  By default
&kate; honors the following key bindings.
</para>

<informaltable>
<tgroup cols="2">
<tbody>

<row><entry><para><keycap>Insert</keycap></para></entry>
<entry><para>
Toggle between Insert and Overwrite mode. When in insert mode the editor
will add any typed characters to the text and push any previously typed
data to the right of the text cursor. Overwrite mode causes the entry of
each character to eliminate the character immediately to the right of
the text cursor.</para></entry>
</row>
<row>
<entry><para><keycombo><keycap>Left Arrow</keycap></keycombo></para></entry>
<entry><para>Move the cursor one character to the left </para></entry>
</row>
<row>
<entry><para><keycombo><keycap>Right Arrow</keycap></keycombo></para></entry>
<entry><para> Move the cursor one character to the right </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Up Arrow</keycap></keycombo></para></entry>
<entry><para> Move the cursor up one line  </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Down Arrow</keycap></keycombo></para></entry>
<entry><para> Move the cursor down one line </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Page Up</keycap></keycombo></para></entry>
<entry><para> Move the cursor up one page  </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Page Down</keycap></keycombo></para></entry>
<entry><para>Move the cursor down one page  </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Backspace</keycap></keycombo></para></entry>
<entry><para> Delete the character to the left of the cursor </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Home</keycap></keycombo></para></entry>
<entry><para> Move the cursor to the beginning of the line </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>End</keycap></keycombo></para></entry>
<entry><para> Move the cursor to the end of the line </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Delete</keycap></keycombo></para></entry>
<entry><para>Delete the character to the right of the cursor (or any selected
text)</para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Shift;<keycap>Left Arrow</keycap></keycombo></para></entry>
<entry><para> Mark text one character to the left </para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Shift;<keycap>Right Arrow</keycap></keycombo></para></entry>
<entry><para> Mark text one character to the right </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>F1</keycap></keycombo></para></entry>
<entry><para> Help</para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></para></entry>
<entry><para><link linkend="whats-this">What's this?</link></para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></para></entry>
<entry><para><link linkend="find"> Find</link></para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>F3</keycap></keycombo></para></entry>
<entry><para><link linkend="find-again"> Find again</link></para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></para></entry>
<entry><para>Set a Bookmark</para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></para></entry>
<entry><para> Copy the marked text to the clipboard. </para></entry>
</row>

<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></para></entry>
<entry><para> <link linkend="new">New</link> document</para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></para></entry>
<entry><para><link linkend="print">Print</link> </para></entry>
</row>
<row>

<entry><para><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></para></entry>
<entry><para>Quit - close active copy of editor </para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></para></entry>
<entry><para><link linkend="replace"> Replace</link></para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></para></entry>
<entry><para>Save your file.</para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo></para></entry>
<entry><para> Paste.</para></entry>
</row>

<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo></para></entry>
<entry><para>Delete the marked text and copy it to the clipboard. </para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></para></entry>
<entry><para><link linkend="undo">Undo</link></para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></para></entry>
<entry><para><link linkend="redo">Redo</link></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>

</sect1>

<sect1 id="fundamentals-getting-help">

<title>Getting Help</title>

<sect2>

<title>With &kate;</title>
<variablelist>

<varlistentry>
<term>This manual</term> 

<listitem>
<para>Offers detailed documentation on all menu commands,
configuration options, tools, dialogs, plugins &etc; as well as
descriptions of of the &kate; window, the editor and various concepts
used in the application.</para>

<para>Press <keycap>F1</keycap> or use the
<menuchoice><guimenu>Help</guimenu></menuchoice>
<guisubmenu>Contents</guisubmenu> menu topic to view this
manual.</para></listitem>

</varlistentry>

<varlistentry id="whats-this">
<term>What's This Help</term> 
<listitem>
<para>What's This help offers immediate help with single elements of
graphical windows, such as buttons or other window areas.</para>

<para>We strive to provide What's This help for any elements for which
it makes sense. It is available throughout the configuration dialog,
and in many other dialogs as well.</para>

<para>To employ What's This help, press
<keycombo>&Shift;<keycap>F1</keycap></keycombo> or use the
<menuchoice><guimenu>Help</guimenu><guimenuitem>What's
This</guimenuitem></menuchoice> menu item to enable What's This
mode. The cursor will turn into an arrow with a question mark, and you
can now click any element in the window to read the What's This help
for that element, if it is available.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>Help Buttons in Dialogs</term>
<listitem>
<para>Some dialogs have a <guibutton>Help</guibutton> Button. Pressing
it will start the &khelpcenter; and open the relevant
documentation.</para>
</listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2>
<title>With Your Text Files</title>

<para>&kate; does not (yet!) provide any means for reading document
related documentation. Depending on the file you are editing, you may
find the <link linkend="kate-mdi-tools-konsole">Built in
&konsole;</link> helpful for viewing related &UNIX; manual pages or
info documentation, or you can use &konqueror;.</para>

</sect2>

</sect1>

</chapter>
