add more spacing

[personal-kdebase.git] / apps / doc / dolphin / index.docbook

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY dolphin "<application>Dolphin</application>">
  <!ENTITY kappname "&dolphin;">
  <!ENTITY package "kdebase">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
  
  
  <!-- Do not define any other entities; instead, use the entities
       from kde-genent.entities and $LANG/user.entities. -->
]>

<book lang="&language;">

<!-- This header contains all of the meta-information for the document such
as Authors, publish date, the abstract, and Keywords -->

<bookinfo>
<title>The &dolphin; Handbook</title>

<authorgroup>
<author>
<firstname>Peter</firstname>
<othername></othername>
<surname>Penz</surname>
<affiliation>
<address><email>peter.penz@gmx.at</email></address>
</affiliation>
</author>
<author>
<firstname>Orville</firstname>
<surname>Bennett</surname>
<affiliation>
<address>&Orville.Bennett.mail;</address>
</affiliation>
</author>
<author>
<firstname>Michael</firstname>
<surname>Austin</surname>
<affiliation>
<address><email>tuxedup@users.sourceforge.net</email></address>
</affiliation>
</author>

<author>
<firstname>David</firstname>
<surname>Edmundson</surname>
<affiliation>
<address><email>kde@davidedmundson.co.uk</email></address>
</affiliation>
</author>

<author>
<firstname>Alan</firstname>
<surname>Blanchflower</surname>
</author>



<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2006</year>
<holder>Peter Penz</holder>
</copyright>
<copyright>
<year>2006</year>
<holder>&Orville.Bennett;</holder>
<holder>Michael Austin</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->

<legalnotice>&FDLNotice;</legalnotice>

<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (YYYY-MM-DD) and of the version
(V.MM.LL), it could be used by automation scripts.
Do NOT change these in the translation. -->

<date>2008-03-05</date>
<releaseinfo>1.0.2</releaseinfo>


<abstract>
<para>
&dolphin; is a file manager for &kde; designed with usability as a primary focus.
</para>
</abstract>

<!-- This is a set of Keywords for indexing by search engines.
Please at least include KDE, the KDE package it is in, the name
 of your application, and a few relevant keywords. -->

<keywordset>
<keyword>KDE</keyword>
<keyword>Dolphin</keyword>
<keyword>Filemanager</keyword>
<keyword>file</keyword>
<keyword>management</keyword>
</keywordset>

</bookinfo>

<!-- The contents of the documentation begin here.  Label
each chapter so with the id attribute. This is necessary for two reasons: it
allows you to easily reference the chapter from other chapters of your
document, and if there is no ID, the name of the generated HTML files will vary
from time to time making it hard to manage for maintainers and for the CVS
system. Any chapter labelled (OPTIONAL) may be left out at the author's
discretion. Other chapters should not be left out in order to maintain a
consistent documentation style across all KDE apps. -->

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

<!-- The introduction chapter contains a brief introduction for the
application that explains what it does and where to report
problems. Basically a long version of the abstract.  Don't include a
revision history. (see installation appendix comment) -->

<para>
&dolphin; is a file manager for &kde; which aims to improve usability at the user interface level. 
&dolphin; is not intended to be a competitor to &konqueror;.
&dolphin; focuses only on being a file manager whereas &konqueror; is a universal viewer of many 
file types. This development approach allows for concentrating on optimizing the user interface 
for the specific task of file management.
</para>

<para>
Please report any problems or feature requests to the &dolphin; author via the bug report dialog.
This is accessible from the 
<menuchoice><guimenu>Help</guimenu><guimenuitem>Report Bug...</guimenuitem></menuchoice> 
menu of the application.
</para>
</chapter>

<chapter id="dolphin-interface">
<title>&dolphin; Interface</title>

<!-- Note that all graphics should be in .png format. Use no gifs because of
patent issues. 
<para>
The Squiggle Tool <guiicon><inlinemediaobject>
          <imageobject>
            <imagedata fileref="squiggle.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>Squiggle</phrase>
          </textobject>
</inlinemediaobject></guiicon> is used to draw squiggly lines all over
the &dolphin; main window. It's not a bug, it's a feature!
</para>-->

<sect1 id="dolphin-features">
<title>&dolphin; Features</title>
<para>
&dolphin; does not represent a wild departure from the &konqueror; file manager interface. There are certain paradigms in use however, which may require some readjustment on the user's part. An attempt is made below to explain these in an effort to provide a more enjoyable experience for our users.
</para>

<sect2 id="dolphin-user-interface">
<title>&dolphin; User Interface</title>

<para>
The default &dolphin; interface consists of a (1) menu bar, (2) toolbar, (3) location bar, (4) workspace, (6) Places Panel, (7) Information Panel and (8) status bar.
</para>

<!--TODO this screenshot needs labelling to match above-->
<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="dolphin.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Screenshot</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
The location bar displays the path to the current folder. The location bar has two versions. By default location is chosen through the 'bread crumb' display.  The bread crumb display makes each folder a link which can be used to immediately go to the entry. The <filename class="directory">/home/peter/Documents</filename> entry in the bread crumb view would become 'Home >  peter >  Documents' with Home, peter, and Documents being clickable links which are able go to there respective locations. This makes navigation to folders above the current folder easier and more intuitive. There is also the classic "location view" which is a text box in which you can type the full path of the folder you wish to view.
</para>

<para>To switch from breadcrumbs to location view, simply click to the right of the breadcrumb area. To change back, click the newly appeared yellow arrow to the right of the location bar.</para>
<para>To change the default &dolphin; view, please see the settings section.</para>
<!--TODO make that a link once written-->


<!-- TODO
(show picture here distinguishing the two views for clarification) -->

<para>
The workspace shows the contents of the current folder. The workspace can also be set to "Split" mode and show two folders simultaneously. 
</para>

<para>
The status bar shows a limited amount of data relating to the file hovered over and the current folder.  When a file is hovered over, the status bar shows the file name, the filesize and the file type &eg; JPEG.  When no file has been highlighted or hovered over, the status bar shows the amount of files and folders in the current folder.  At all times the status bar shows the amount of storage space that has currently been used on the current mount point, as well as the maximum space available on the mount point &eg; <filename class="directory">/home/</filename>.
</para>
</sect2>

<sect2 id="dolphin-workspace">
<title>&dolphin; Workspace</title>

<para>The &dolphin; workspace can display the contents of a folder in a variety of views. There are three viewing modes Icons, Details, and Columns. Each of these can have Preview enabled. This changes the icons into showing a preview of the file, rather than an simply icon.</para>


<para>
The <guibutton>Icons</guibutton> view shows the contents of the folder via the file icon type &eg; an <acronym>MP3</acronym> file will be represented with the icon for an <acronym>MP3</acronym>  file.  Sub-folders are represented in the form of a folder icon. The folder icon is defined by the &kde; icon theme currently in use, however individual folders can have their icon changed manually if the user wishes.  This can be done via the properties dialog. 
<!-- TODO (more? changing folder icons not really dolphin specific.) -->
</para>

<para>
The <guibutton>Details</guibutton> view lists the contents of a folder whilst also displaying additional properties about the file. The default &dolphin; configuration only displays the size of the file and the date it was last modified. The choice of additional information shown can be changed by right clicking on the column header and selecting the information you wish to view or in <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure &dolphin;...</guisubmenu></menuchoice>
</para>

<para>
The <guibutton>Columns</guibutton> view allows multiple levels of the folder structure to be viewed at once. Each time a folder is clicked a new pane appears to the right of the current listing showing the contents of that folder.
</para>


<para>
The <guibutton>Preview</guibutton> view is similar to the icons view. The difference is that wherever possible previews of the files are shown. This function works for a number of image types including; JPG, PNG, XCF, <acronym>SVG</acronym> and numerous others. The previews view is also capable of showing the first 14 lines from text documents. &dolphin; is also capable of displaying a preview of &HTML; and <acronym>PDF</acronym> files in the previews view. It is also possible to modify the size of the previews via the Configure &dolphin; dialog.
<!--  (link, and info on it) -->
</para>

<para>
Changing the view of the folder a user is working in is as simple as clicking the icon of the view they wish to use. This will cause the workspace view to change accordingly.
</para>



<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="workspacebuttons.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Workspace View Buttons</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
The workspace in &dolphin; is capable of showing two folders within the same window, known as split workspaces. In order to enable or disable the split workspace mode toggle the icon on the taskbar. Another way to enable or disable the split workspace mode is to use the <menuchoice><guimenu>View</guimenu><guimenuitem>Split</guimenuitem></menuchoice> menu option.
</para>

<para>
If this option is enabled then the workspace will split apart. Two separate workspace areas will be available for use, along with two separate location bars.  Clicking on either workspace will make it the active workspace.  If the user toggles the split workspace mode off, then the currently active workspace will remain, while the inactive workspace will close.
</para>



<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="split.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; In Split Workspace Mode </phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
&dolphin; is capable of remembering the workspace view on a per-folder basis.  For example, if while viewing <filename class="directory">/home/peter/Pictures/</filename> the user choses to use the preview view, then the next time the user enters that folder, the view will be changed to the preview view. This is especially useful for folders containing mainly images. The feature only works for local folders which the user has read/write permissions to. &dolphin; will also remember the viewing mode it was in when last running &eg; single workspace or split workspace.
</para>

<para>
&dolphin; can also display files and sub-folders that are hidden in the current folder &eg; files such as <filename>.dolphin</filename> and sub-folder such as <filename class="directory">.kde/</filename>.
</para>

<para>
Hidden files and sub-folders can be distinguished from non-hidden file and sub-folders by their colouring.  Hidden files/sub-folders are fainter than non-hidden files/sub-folders.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="hiddenfolder.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Showing Hidden Files/Sub-folders Enabled</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
To enable the showing of hidden files and sub-folders you can select <menuchoice><guimenu>View</guimenu><guimenuitem>Show Hidden Files</guimenuitem></menuchoice>.
</para>

<para>
&dolphin; is able to sort the contents of a folder in a number of ways.  These are; By Name, By Date, By Size and Descending order.  These only apply to the current folder the user is currently in and do not affect other folders.  As with the Views Modes the Sorting order is saved for this folder.
</para>

<para>
To change the way the folder is sorted, via the menu <menuchoice><guimenu>View</guimenu><guisubmenu>Sort By</guisubmenu></menuchoice> (&eg; By Date).
</para>
</sect2>

<sect2 id="dolphin-panels">
<title>&dolphin; Panels</title>
<para>
&dolphin; allows a number of Panels to be placed in the workspace. These can be enabled in <menuchoice><guimenu>View</guimenu><guisubmenu>Panels</guisubmenu></menuchoice>. Those chosen can then be dragged around the &dolphin; window by clicking and dragging the panel title. The panels available are described below.</para>

<sect3>
<title>Places</title>
<para>
The <guilabel>Places</guilabel> panel is found at the left of the window by default, The <guilabel>Places</guilabel> panel shows any locations you have bookmarked. It also shows any disk or media attached to the computer. This list corresponds with the list of places in the breadcrumbs menu.
</para>

</sect3>

<sect3>
<title>Information</title>
<para>
The <guilabel>Information</guilabel> panel shows extended information about the selected file(s), including size, type, and date of last modification. Information also features a large preview of the selected file.
</para>
</sect3>

<sect3>
<title>Folders</title>
<para>
The <guilabel>Folders</guilabel> panel shows a tree view structure of the file system. It only shows folders. By selecting a folder the main &dolphin; area changes to show the contents of the selected folder.
</para>
</sect3>

<sect3>
<title>Terminal</title>
<para>
This panel opens a terminal inside the &dolphin; workspace. The terminal will open at the folder currently shown in the &dolphin; view. Changing folder in the main &dolphin; view will change the working folder of the terminal to match.
Note: Changing folder in the terminal will not affect the &dolphin; view. The terminal only works with local media.
</para>


<!--TODO pictures of all these panels-->
</sect3>



</sect2>
</sect1>
</chapter>

<chapter id="using-dolphin">
<title>Using &dolphin;</title>

<sect1 id="dolphin-navigation">
<title>&dolphin; Navigation</title>

<para>
The main feature of &dolphin; that allows navigation of the file system is the work space.  Clicking on a sub-folder within the current folder changes to this folder.  Clicking on files within the workspace will open the file in the default application for that file type.
</para>

<para>
The toolbar is also used for navigating the file system.  The toolbar contains two buttons essential for navigating the file system quickly and easily, these are; <guiicon>Back</guiicon> and <guiicon>Forward</guiicon>.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="toolbarbuttons.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Toolbar Buttons</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
Other buttons can be added to the toolbar to further aid navigation or to provide shortcuts for functions within &dolphin; &eg; deleting a file.
</para>

<para>
&dolphin; continually shows the folder that it is currently viewing the contents of, via the location bar and the title bar.  The location bar has two views available.  The first is the folder path view.  This shows the path to the current folder &eg; <filename class="directory">/usr/share/apps/dolphin/</filename>.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="directorypath.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Displaying The Folder Path View</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
The second view is the breadcrumb view.  This allows the user to move to a folder a number of folders back from the current one.  This is achieved via a tab like interface where the name of each previous folder is displayed and can be clicked on to change into.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="breadcrumb.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Displaying The Breadcrumb View</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
To switch from breadcrumbs to location view, simply click in the right part of the breadcrumb area or use <menuchoice> <guimenu>View</guimenu> <guisubmenu>Navigation Bar</guisubmenu> <guimenuitem>Edit Location</guimenuitem> </menuchoice>. To change back, click the newly appeared yellow arrow to the right of the location bar or use <menuchoice> <guimenu>View</guimenu> <guisubmenu>Navigation Bar</guisubmenu> <guimenuitem>Show Full Location</guimenuitem> </menuchoice>.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="browsebutton.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Browse Button</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
With the folder path view the user is able to enter the whole path to the folder they wish to enter.  In order to do so, the user can toggle the browse button to the folder path view or alternatively via the menu <menuchoice> <guimenu>View</guimenu> <guisubmenu>Navigation Bar</guisubmenu> <guimenuitem>Edit Location</guimenuitem> </menuchoice> then enter the path to the folder they wish to enter.  The user will notice as they are entering the path, a box will open underneath the address bar showing the content of the folder they are currently heading to.  The content of this box will change as they continue to enter the path to the folder, showing the folders and the files beginning with the characters being entered &eg; <filename class="directory">/usr/share/apps/k</filename> would display everything within the folder beginning with the k character.
</para>

<para>
If the breadcrumb view is enabled then the user is unable to enter the path to the folder.  The user must manually navigate the file system by clicking the folders and sub-folders within the folders.
</para>

<para>
In order to aid the navigation of the file system, &dolphin; can use Places.  Places can be set for any location on the file system including virtual folders such as "trash:/". Selecting a Place will display that folder or virtual folder in the workspace.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="bookmarkbutton.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Bookmark Button Open</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
In order to select a Place, the location bar must be set to the breadcrumb view.  Clicking the image of the home button (as set by the icon theme currently in use) will drop down a list of all the available bookmarks.  The &dolphin; Places Panel also contains your Places list.  This can be accessed via switching the sidebar to bookmarks mode.  The user then clicks the desired Place to open that folder. 
</para>

<para>

</para>
</sect1>

<sect1 id="dolphin-configuration">
<title>&dolphin; Configuration</title>

<para>
In order to configure &dolphin; the user needs to access the &dolphin; Configuration dialog.  This can be accessed via the menu bar; <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &dolphin;...</guimenuitem> </menuchoice>.
</para>

<para>
The &dolphin; Configuration dialog consists of three sections; <guilabel>Startup</guilabel>, <guilabel>View Modes</guilabel>, and <guilabel>General</guilabel>.  Clicking one of these sections will make those options available accordingly.  The options available are displayed to the right of the dialog.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="configurationwindow.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Configuration Window Showing The General Options</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
The <guilabel>General</guilabel> option allows users to set a number of options for &dolphin;, these are; the default home location for the user &eg; /home/Peter, the default view mode (all folders will use this view unless they have already been changed) and wether or not split view is enabled by default.
</para>

<para>
<screenshot>
<screeninfo>Here's a screenshot of &dolphin;</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="configurationwindow2.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&dolphin; Configuration Window Showing The View Options</phrase>
          </textobject>
        </mediaobject>
</screenshot>
</para>

<para>
The <guilabel>View Modes</guilabel> option differs slightly from the <guilabel>General</guilabel> option in that it has four tabs in the options.  The <guilabel>Icons</guilabel> tab allows users to set options to do with the Icons View Mode &eg; icon size.  The <guilabel>Details</guilabel> tab allows users to set options relating to the Details View Mode &eg; what information about files are shown.  The Previews to allows users to set options relating to the Previews View Mode &eg; the size of the preview images.
<!-- <guilabel>Column</guilabel> -->
</para>
</sect1>

<sect1 id="quick-tips">
<title>Quick Tips</title>

<para>
The following are a number of tips to save time when using &dolphin;.
</para>

<sect2 id="quick-bookmarking">
<title>Quick Bookmarking</title>

<para>
To quickly create a bookmark of the folder currently being viewed, right click in the work space and via the menu select "Add to Places".  The Bookmarking dialog will open, enter a name for the bookmark along with an icon to represent the bookmark.
</para>

</sect2>

<sect2 id="finding-file">
<title>Finding Files</title>

<para>
&dolphin; is capable of searching for files in a filesystem.  If <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> is pressed or using <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Find File...</guimenuitem> </menuchoice>, &kfind; will open already set up to search within the current folder and any sub-folders contained within.
</para>
</sect2>


<sect2 id="mounting-storage-media">
<title>Mounting Storage Media</title>

<para>
A quick way to mount Storage Media is to click on the device.  This will mount and open the device in &dolphin;.
</para>
</sect2>

<sect2 id="undo-actions">
<title>Undo Actions</title>

<para>
&dolphin; is capable of undoing changes users have made to files.  For example if a user sent a file to the Trash, &dolphin; can undo this and move it back to the folder it previously belonged in.  To undo an action via the menu <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Undo: (action name)</guimenuitem> </menuchoice>, &eg; <guimenuitem>Undo: Rename</guimenuitem> or by pressing <keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>.
</para>
</sect2>

<sect2 id="batch-rename">
<title>Renaming A Batch Of Files</title>

<para>
&dolphin; is capable of renaming a number of files at the same time.  Each file will have the file name specified, followed by a number for how many files that have been chosen to rename &eg; Tester 1.png, Tester 2.png, Tester 3.png.  This is useful for when you have a number of audio files where you wish to number them via their track number, or for photographs taken from a digital camera.
</para>

<para>
If a user wishes to rename a batch of files they must first select the files to be renamed.  This can be done via dragging the mouse over the files to be renamed, or via holding &Ctrl; and clicking each file to be renamed.  The user must then open the batch-rename dialog, this, can be done via pressing <keycap>F2</keycap> or via the File menu; <menuchoice> <guimenu>File</guimenu> <guimenuitem>Rename...</guimenuitem> </menuchoice>.
</para>

<para>
The user must then enter the name they wish to give the files.  The # character must also be present within the name (failure to include the # key will result in an error as this indicates where the file number should be sequentially increased for each file.)   The files will then be renamed with a  number present within the file name.
</para>
</sect2>

<sect2 id="compare-files">
<title>Comparing A Selection Of Files</title>

<para>
&dolphin; is capable of comparing a selection of files to see the differences between them.  For a user to be able to compare files then the &kompare; application must be installed.  &dolphin; can only compare the files that &kompare; is capable on analyzing.
</para>

<para>
If a user wishes to compare a selection of files, then first they must select the files to be compared.  Then launch the &kompare; application via the Tools menu; <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Compare Files</guimenuitem> </menuchoice>.  &kompare; will then open showing the differences between the files.
</para>
</sect2>

<sect2 id="filet-files">
<title>Filter A Selection Of Files</title>

<para>
&dolphin; is capable of filtering a selection of files within the workspace via a text string.  For example if a user wish to filter all of the <acronym>MP3</acronym>  files within a folder, they could filter for .mp3.  This would then filter out all of the files that did not have .mp3 within their file name.
</para>

<para>
If a user wishes to filter a selection of files this can be done via the filter bar.  The user then enters the text they wish to filter for within that folder.  To enable the filter bar the user must press either the <keycombo 
action="simul">&Ctrl;<keycap>I</keycap></keycombo> key or via the Menu Bar; <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Show Filter Bar</guimenuitem> </menuchoice>.  To disable the filter bar the user must press either the &Esc; key, or via the <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Show Filter Bar</guimenuitem> </menuchoice>.
</para>
</sect2>

</sect1>
</chapter>

<chapter id="dolphin-commands">
<title>Command Reference</title>

<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
application windows and their menubar and toolbar commands for easy reference.
Also include any keys that have a special function but have no equivalent in the
menus or toolbars. This may not be necessary for small apps or apps with no tool
or menu bars. -->

<sect1 id="dolphin-mainwindow">
<title>The main &dolphin; window</title>

<sect2>
<title>The File Menu</title>
<para>
<variablelist>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Create New</guisubmenu>
</menuchoice></term>
<listitem><para><action>Creates a new object in the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New Window</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens a new window.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New Tab</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens a new tab.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F2</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Rename</guimenuitem>
</menuchoice></term>
<listitem><para><action>Renames the currently selected document(s).</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>Del</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Move to Trash</guimenuitem>
</menuchoice></term>
<listitem><para><action>Moves the currently selected file(s) to the trash.</action></para></listitem>
</varlistentry>
<!--</variablelist>-->

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Shift;<keycap>Del</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Delete</guimenuitem>
</menuchoice></term>
<listitem><para><action>Permanently deletes the currently selected file(s).  The files are not moved to the trash.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Return</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Properties</guimenuitem>
</menuchoice></term>
<listitem><para><action>Shows the properties dialog for the currently selected file(s).</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Exits &dolphin;.</action></para></listitem>
</varlistentry>
</variablelist>

</para>
</sect2>

<sect2>
<title>The Edit Menu</title>
<para>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Undo</guimenuitem>
</menuchoice></term>
<listitem><para><action>Undoes the last action performed by &dolphin;.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Cut</guimenuitem>
</menuchoice></term>
<listitem><para><action>Cuts the currently selected file(s).</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Copy</guimenuitem>
</menuchoice></term>
<listitem><para><action>Copies the currently selected file(s).</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Paste</guimenuitem>
</menuchoice></term>
<listitem><para><action>Pastes the currently copied/cut files to the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Select All</guimenuitem>
</menuchoice></term>
<listitem><para><action>Selects all files and folders in the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Invert Selection</guimenuitem>
</menuchoice></term>
<listitem><para><action>
Selects all unselected items and deselects all selected items in the current folder.
</action></para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>

<sect2>
<title>The View Menu</title>
<para>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Zoom In</guimenuitem>
</menuchoice></term>
<listitem><para><action>Increases the size of icons in the workspace.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Zoom Out</guimenuitem>
</menuchoice></term>
<listitem><para><action>Decreases the size of icons in the workspace.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>View Mode...</guisubmenu>
</menuchoice></term>
<listitem><para><action>Changes the workspace view to show <guimenuitem>Icons</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo>), <guimenuitem>Details</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo>) or <guimenuitem>Columns</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>3</keycap></keycombo>).</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Sort By</guisubmenu>
</menuchoice></term>
<listitem><para><action>Changes whether items are sorted by <guimenuitem>Name</guimenuitem>, <guimenuitem>Size</guimenuitem>, <guimenuitem>Date</guimenuitem>, <guimenuitem>Permissions</guimenuitem>, <guimenuitem>Owner</guimenuitem>, <guimenuitem>Group</guimenuitem> or <guimenuitem>Type</guimenuitem>. <guimenuitem>Descending</guimenuitem> reverses the sort order.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Additional Information</guisubmenu>
</menuchoice></term>
<listitem><para><action>Displays additional information</action> like <guimenuitem>Size</guimenuitem>, <guimenuitem>Date</guimenuitem>, <guimenuitem>Permissions</guimenuitem>, <guimenuitem>Owner</guimenuitem>, <guimenuitem>Group</guimenuitem> or <guimenuitem>Type</guimenuitem> in the different views.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Preview</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays a symbolic preview of the file contents </action> in the different view modes.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Show in Groups</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays</action> the content of the current folder grouped by file type.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>.</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Show Hidden Files</guimenuitem>
</menuchoice></term>
<listitem><para><action>Shows all the hidden files and sub-folders within the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F3</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Split</guimenuitem>
</menuchoice></term>
<listitem><para><action>Enables and disables the split view workspace mode.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F5</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Reload</guimenuitem>
</menuchoice></term>
<listitem><para><action>Reloads the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Stop</guimenuitem>
</menuchoice></term>
<listitem><para><action>Stops loading/reading the contents of the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Panels</guisubmenu>
</menuchoice></term>
<listitem><para><action>Enables and disables</action> the different panels, &eg; <guimenuitem>Places</guimenuitem> (<keycap>F9</keycap>), <guimenuitem>Information</guimenuitem> (<keycap>F11</keycap>), <guimenuitem>Folders</guimenuitem> (<keycap>F7</keycap>) and <guimenuitem>Terminal</guimenuitem> (<keycap>F4</keycap>).</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guisubmenu>Navigation Bar</guisubmenu>
</menuchoice></term>
<listitem><para><action>Changes the address bar between the two modes; the line input mode <guimenuitem>Show Full Location</guimenuitem> and the breadcrumb mode <guimenuitem>Edit Location</guimenuitem>.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Adjust View Properties...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens the view properties dialog.</action></para></listitem>
</varlistentry>
</variablelist>

</para>
</sect2>

<sect2>
<title>The Go Menu</title>
<para>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Up</keycap></keycombo>
</shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Up</guimenuitem>
</menuchoice></term>
<listitem><para><action>Changes to the folder above the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Left</keycap></keycombo>
</shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Back</guimenuitem>
</menuchoice></term>
<listitem><para><action>Changes to the previously viewed folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Right</keycap></keycombo>
</shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Forward</guimenuitem>
</menuchoice></term>
<listitem><para><action>Changes to the most recently viewed folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Home</keycap></keycombo>
</shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Home</guimenuitem>
</menuchoice></term>
<listitem><para><action>Changes to the users home folder &eg; /home/Peter/.</action></para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>

<sect2>
<title>The Tools Menu</title>
<para>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Find File...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens &kfind; already within the current folder.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Show Filter Bar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Enables and disables the filter bar.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Compare Files</guimenuitem>
</menuchoice></term>
<listitem><para><action>Compare the currently selected files with &kompare;.</action></para></listitem>
</varlistentry>
</variablelist>

</para>
</sect2>

<sect2>
<title>The Settings Menu</title>
<para>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo>
</shortcut>
<guimenu>Settings</guimenu>
<guimenuitem>Show Menubar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Hides and shows the menubar.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Hides and shows the toolbar.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens the shortcut configuration dialog.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens the toolbar configuration dialog.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &dolphin;...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens the &dolphin; configuration dialog.</action></para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>

<sect2>
<title>The Help Menu</title>


<!-- Assuming you have a standard help menu (help, what's this, about -->
<!-- &dolphin;, about &kde;) then the documentation is already written. -->
<!-- The following entity is valid anywhere that a variablelist is -->
<!-- valid.  -->

&help.menu.documentation;

</sect2>

</sect1>
</chapter>



<chapter id="faq">
<title>Frequently asked Questions</title>

<!-- (OPTIONAL but recommended) This chapter should include all of the silly
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
should be reserved for BRIEF questions and answers! If one question uses more
than a page or so then it should probably be part of the
"Using this Application" chapter instead. You should use links to
cross-reference questions to the parts of your documentation that answer them.
This is also a great place to provide pointers to other FAQ's if your users
must do some complicated configuration on other programs in order for your
application work. -->

<qandaset id="faqlist">
<qandaentry>
<question>
<para>How do I add my own custom service menus to &dolphin;?</para>
</question>
<answer>
<para>
&dolphin; can use the majority of service menus created for &konqueror;, however &dolphin; does impose one limitation on the service menus: Service menu entries that add themselves to the top level of the context menu will automatically be placed below the Actions sub-menu. This prevents that the context menu will get crowded.
</para>

<para>
To add a custom service menu to &dolphin; save the service menu to the &dolphin; service menu folder, this can be found in /home/house/.kde/share/apps/dolphin/servicemenus/. If the servicemenus sub-folder does not exist in the &dolphin; folder, then create the sub-folder and save the service menu to that folder.  The next time the user launch &dolphin; the service menu will be available.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>How do I make &dolphin; my default file manager?</para>
</question>
<answer>
<para>
To make &dolphin; the default file manager for &kde; from the &kde; control center open the File Associations section via; &kde; Components>File Associations.  If the user adds &dolphin; to the list of applications for the folder mime type and make it the first choice, then &dolphin; will become the default application to open any folder with. The folder mime type can be found by expanding the inode section of Known Types.
</para>

<para>
To make &dolphin; the default file manager for the virtual folders created by &kde; &eg; system:/ then again in the File Associations section of the control center expand the inode section of Known Types.  Under the system_directory mime type, add &dolphin; to the list of applications, however instead of choosing &dolphin; from the kmenu, type the following in to the text box at the top;  dolphin %u. The virtual folders created by &kde; will then be opened by &dolphin; as default.
</para>
</answer>
</qandaentry>
</qandaset>
</chapter>



<chapter id="misc">
<title>Miscellaneous Questions</title>

<qandaset id="misclist">
<qandaentry>
<question>
<para>Does &dolphin; intended to replace &konqueror;?</para>
</question>
<answer>
<para>
&dolphin; is not intended to be a competitor to &konqueror;: &konqueror; acts as universal viewer being able to show &HTML; pages, text documents, folders and a lot more, whereas &dolphin; focuses on being only a file manager. This approach allows to optimize the user interface for the task of file management.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>How can I get involved with the development of &dolphin;?</para>
</question>
<answer>
<para>
The easiest way to get involved with &dolphin; is to drop the developers an email.  If you email Peter Penz (Lead Developer/Project Leader), what you can do, how much time you can devote &etc; and he will let you know what you can do in the project. If you wish to contribute to the documentation email Michael Austin (Documentation Leader).  He can then fill you in on the situation &eg; what needs to be added/finished, the procedure for submitting documentation.
</para>
<para>
The email addresses of Peter Penz and Michael Austin can be found on the main page of the documentation, or in the Credits section.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>Where do I submit bug reports to?</para>
</question>
<answer>
<para>
Bug reports should only be submitted for released versions of &dolphin;, please do not submit bug reports for the Subversion release of &dolphin; as this is expected to break due to its constant development.
</para>
<para>
The official channel for submitting bug reports is via the &kde; bug tracking system.  Alternatively bug reports can be emailed to Peter Penz (email address is found on the main page or the credits section).
</para> 
<para>
The &kde; bug tracker can be found at <ulink url="http://bugs.kde.org">http://bugs.kde.org</ulink>.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>Where do I submit feature requests to?</para>
</question>
<answer>
<para>
The official channel for submitting feature requests is via the &kde; bug tracking system.  Alternatively feature requests can be emailed to Peter Penz  (email address is found on the main page or the credits section).
</para>

</answer>

</qandaentry>
</qandaset>
</chapter>



<chapter id="credits">

<!-- Include credits for the programmers, documentation writers, and
contributors here. The license for your software should then be included below
the credits with a reference to the appropriate license file included in the &kde;
distribution. -->

<title>Credits and License</title>

<para>
&dolphin;
</para>
<para>
Program copyright 2005,2006 Peter Penz <email>peter.penz@gmx.at</email>
</para>
<para>
Contributors:
<itemizedlist>
<listitem><para>Cvetoslav Ludmiloff <email>ludmiloff@gmail.com</email></para></listitem>
<listitem><para>Stefan Monov <email>logixoul@gmail.com</email></para></listitem>
<listitem><para>Michael Austin <email>tuxedup@users.sourceforge.net</email></para></listitem>
<listitem><para>&Orville.Bennett; &Orville.Bennett.mail;</para></listitem>
</itemizedlist>
</para>

<para>
Documentation copyright 2005 Peter Penz <email>peter.penz@gmx.at</email>
</para>
<para>
Documentation copyright 2006 &Orville.Bennett; &Orville.Bennett.mail;
</para>
<para>
Documentation copyright 2006 Michael Austin <email>tuxedup@users.sourceforge.net</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;               <!-- FDL: do not remove 
     (NOTE:  All documentation are licensed under the FDL, 
     regardless of what license the application uses) -->

&underGPL;               <!-- GPL License -->

</chapter>

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

<sect1 id="getting-dolphin">
<title>How to obtain &dolphin;</title>

&install.intro.documentation;

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

<para>
In order to successfully use &dolphin; you need to at least have kdebase and kdelibs from &kde; 3.5 installed.  &dolphin; may work on older
versions of &kde;, however not all functions offered by &dolphin; may work.
</para>

<para>
In order to compile &dolphin; you will also require libqt2-mt-dev, libx11-dev, kdebase-dev, zlibg-dev and &gcc;.
</para>

<para>
Other &kde; libraries may also be required for some advanced features.
</para>
< But I don't know what these might be so I can't really specify :-) >
-->

</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

<!-- This entity contains the boilerplate text for standard -->
<!-- compilation instructions.  If your application requires any -->
<!-- special handling, remove it, and replace with your own text. -->

&install.compile.documentation;

</sect1>

</appendix>

&documentation.index;
</book>

<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

vim:tabstop=2:shiftwidth=2:expandtab 
-->