]> cloud.milkyroute.net Git - dolphin.git/blobdiff - doc/index.docbook
Add new option to close the inactive split view to the docs
[dolphin.git] / doc / index.docbook
index fe3357c2f566bc9b9715606d9f0950cbbc4c7e59..eecd2e1f05cac9b90d80d0c666995c10a434b4c3 100644 (file)
@@ -1,8 +1,5 @@
 <?xml version="1.0" ?>
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
-  <!ENTITY dolphin "<application>Dolphin</application>">
-  <!ENTITY kappname "&dolphin;">
-  <!ENTITY package "kde-baseapps">
   <!ENTITY % addindex "IGNORE">
   <!ENTITY % English "INCLUDE"><!-- change language only here -->
 ]>
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2013-06-28</date>
-<releaseinfo>4.11 (&kde; 4.11)</releaseinfo>
+<date>2019-02-17</date>
+<releaseinfo>Applications 19.04</releaseinfo>
 
 <abstract>
 <para>
-&dolphin; is the default file manager for &kde;, designed with usability as a primary focus.
+&dolphin; is the default file manager by &kde;, designed with usability as a primary focus.
 </para>
 </abstract>
 
@@ -96,7 +93,7 @@
 <title>Introduction</title>
 
 <para>
-&dolphin; is &kde;'s default file manager. It aims to improve usability at the
+&dolphin; is &plasma;'s default file manager. It aims to improve usability at the
 user interface level. &dolphin; focuses only on being a file manager whereas
 &konqueror;, which was &kde;'s default file manager in &kde; 3 and can still be
 used for file management, is a universal viewer for many file types.
@@ -242,8 +239,8 @@ can be accessed or manipulated in different ways:
 <listitem><para>
 A file or folder can be opened by clicking it with the &LMB; (or
 double-clicking, if <guilabel>Double-click to open files and folders</guilabel>
-is enabled in the <link linkend="preferences-dialog-navigation"><quote>Navigation</quote>
-section of the settings</link>).
+is enabled in the &systemsettings; in the <menuchoice><guimenu>Input Devices</guimenu>
+<guimenuitem>Mouse</guimenuitem></menuchoice> module.
 </para></listitem>
 
 <listitem><para>
@@ -284,6 +281,9 @@ the toolbar can be used to navigate in the history.
 </mediaobject>
 </screenshot>
 
+<para>If you click with the &MMB; the item in the history is opened in a new tab
+thus keeping the current tab with its content.
+</para>
 </sect2>
 
 <sect2 id="dolphin-view-appearance">
@@ -358,11 +358,11 @@ the extension is replaced by <quote>...</quote>
 the <guilabel>Name</guilabel> header, which is always the first column in this view.
 </para>
 <para>
-The details view allows you to view the current directory
+The details view allows you to view the current folder
 in a tree-like fashion if <link linkend="preferences-dialog-viewmodes-details">
-<guilabel>Expandable folders</guilabel></link> are enabled: 
+<guilabel>Expandable folders</guilabel></link> are enabled:
 Each subfolder of the current folder can be
-<quote>expanded</quote> or <quote>collapsed</quote> by clicking on the <guiicon>&gt;</guiicon>
+<quote>expanded</quote> or <quote>collapsed</quote> by clicking on the <guiicon>></guiicon>
 or <guiicon>v</guiicon> icon next to it.</para></listitem>
 </itemizedlist>
 </para>
@@ -387,7 +387,7 @@ in <menuchoice><guimenu>View</guimenu><guisubmenu>Sort by</guisubmenu></menuchoi
 <sect3 id="dolphin-view-information">
 <title>Information in the View</title>
 <para>
-In all view modes &kappname; shows at least an icon and a name for each item. 
+In all view modes &dolphin; shows at least an icon and a name for each item. 
 Using <guisubmenu>Additional Information</guisubmenu> in the <guimenu>View</guimenu> 
 menu or the context menu of the header in <guilabel>Details</guilabel> mode, you can select
 more information for each item to be shown:
@@ -726,7 +726,7 @@ over with the mouse, including size, type, and date of last modification. It als
 features a large preview of the selected item and allows you to assign a rating,
 tags, and comments to it.
 </para>
-
+<!--FIXME panel context menu-->
 </sect2>
 
 <sect2 id="folders-panel">
@@ -736,9 +736,10 @@ tags, and comments to it.
 The <guilabel>Folders</guilabel> panel shows a tree view structure of the file
 system. It only shows folders. Clicking a folder with the &LMB; opens this folder
 in the &dolphin; view.
-
 </para>
-
+<para>Use <guilabel>Limit to Home Directory</guilabel> to hide all folders from
+the tree view except your <guilabel>Home</guilabel>.
+</para>
 </sect2>
 
 <sect2 id="terminal-panel">
@@ -777,6 +778,7 @@ current folder, &RMB; click in the work space and click
 <sect2 id="finding-searching-in-file">
 <title>Finding Files and Searching in Files</title>
 <!-- FIXME search in hidden files + folders View -> Show Hidden Files has to be enabled ? -->
+<!-- https://bugs.kde.org/show_bug.cgi?id=361557 No clear way to open configuration dialog for Baloo search engine -->
 <para>
 &dolphin; is capable of searching for files and for content in files. If <keycombo action="simul">
 &Ctrl;<keycap>F</keycap></keycombo> is pressed or <menuchoice> <guimenu>Edit</guimenu> 
@@ -805,7 +807,6 @@ a KIOSlave is launched to provide the search results.</para>
 <para>The option from <guilabel>Everywhere</guilabel> with activated Baloo 
 services searches in all indexed folders, without Baloo this option  
 starts the search from the user's <replaceable>Home</replaceable> folder.</para>
-
 <screenshot>
 <screeninfo>Search with More Options</screeninfo>
 <mediaobject>
@@ -831,6 +832,14 @@ the user to shrink the number of search results.</para>
 together with the <guilabel>Filter</guilabel> bar to find files using Baloo or limit 
 the search to files matching the filter expression.</para>
 
+<para>Use the Save icon to save a search to the <guilabel>Search For</guilabel>
+section in the <guilabel>Places</guilabel> panel to quickly access it again in the future.
+</para>
+<!--FIXME 16.12
+https://git.reviewboard.kde.org/r/123883/
+Add prototype of a "More search tools..." button
+-->
+
 </sect2>
 
 <sect2 id="mounting-storage-media">
@@ -855,7 +864,7 @@ in the menu, &eg; <guimenuitem>Undo: Rename</guimenuitem>.
 </para>
 
 </sect2>
-
+<!-- FIXME https://phabricator.kde.org/D10698-->
 <sect2 id="batch-rename">
 <title>Renaming A Batch Of Files</title>
 <para>
@@ -863,7 +872,7 @@ in the menu, &eg; <guimenuitem>Undo: Rename</guimenuitem>.
 will have the file name specified, including a number, &eg;, Image1.jpg,
 Image2.jpg, Image3.jpg. This can be useful, &eg;, for pictures taken with a digital camera.
 </para>
-
+<!--double click-->
 <para>
 If you wish to rename a batch of files, first select the files to be renamed.
 This can be done by pressing the &LMB; and drawing a rectangle around the files
@@ -968,6 +977,141 @@ be accessed by clicking the corresponding icon on the left of the dialog.
 tab on the <guilabel>General</guilabel> page are shared with &konqueror; in filemanager mode.
 </para>
 
+<sect2 id="preferences-dialog-general">
+<title>General</title>
+
+<para>
+This group contains settings which control the general behavior of &dolphin;.
+The group is divided further into four subgroups which can be accessed using the
+tab bar at the top.
+
+<screenshot>
+<screeninfo>Screenshot of the General settings in &dolphin;'s preferences dialog</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="preferences-general-behavior.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>General Settings.</phrase>
+</textobject>
+<caption><para>General Settings in &dolphin;'s Preferences Dialog.</para></caption>
+</mediaobject>
+</screenshot>
+
+</para>
+
+<sect3 id="preferences-dialog-general-behavior">
+<title>Behavior Tab</title>
+
+<para>
+
+<itemizedlist>
+
+<listitem><para>
+In the <guilabel>View</guilabel> section, you can configure whether the
+<link linkend="view-properties"> view properties</link> are stored for each
+folder or if common view properties are to be used for all folders.
+</para></listitem>
+
+<listitem><para>
+<guilabel>Sorting Mode</guilabel> controls how items are sorted in
+the view. If <guilabel>Natural sorting</guilabel> is enabled, the sort order of three example files
+will be
+<orderedlist>
+<listitem><para>File1,</para></listitem>
+<listitem><para>File2,</para></listitem>
+<listitem><para>File10.</para></listitem>
+</orderedlist>
+If this option is disabled, the normal alphabetical sorting case sensitive or case insensitive
+will be used, which leads to the sort order
+<orderedlist>
+<listitem><para>File1,</para></listitem>
+<listitem><para>File10,</para></listitem>
+<listitem><para>File2.</para></listitem>
+</orderedlist>
+</para></listitem>
+
+<listitem><para>
+When hovering over a file or folder with the mouse, a small window with relevant
+information is shown if <guilabel>Show tooltips</guilabel> is enabled.
+</para></listitem>
+
+<listitem><para>
+<guilabel>Show selection marker</guilabel> shows a small <guibutton>+</guibutton>
+or <guibutton>-</guibutton> button above an item's icon if the item is hovered over
+with the mouse. These can be used to select or deselect the item.
+</para></listitem>
+
+<listitem><para>
+Enable <guilabel>Rename inline</guilabel> to use this mode if only one item is currently selected.
+If this option is disabled or several items are selected, a dialog will be displayed for renaming.
+</para></listitem>
+
+<listitem><para>Enabling <guilabel>Switch between split views with tab key</guilabel>
+allows to switch split views with the &Tab; key.
+</para></listitem>
+
+<listitem><para>Disable <guilabel>Turning off split view closes active pane</guilabel>
+to close the inactive pane when you are turning off the split view mode, &eg; pressing <keycap>F3</keycap>.
+</para></listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect3>
+
+<sect3 id="preferences-dialog-general-previews">
+<title>Previews Tab</title>
+
+<para>
+In this tab, you can configure for which file types previews are shown.
+Moreover, the maximum size of remote files for which previews are generated can be chosen.
+</para>
+<para>
+If previews are enabled for folders, previews of some files in the folder will
+be shown inside a folder's icon.
+</para>
+</sect3>
+
+<sect3 id="preferences-dialog-general-confirmations">
+<title>Confirmations Tab</title>
+<para>
+In the ask for confirmation section, you can enable warning dialogs that
+are shown before potentially harmful actions .
+</para>
+<warning><para>The confirmation settings for <guilabel>Moving files or folders to trash</guilabel> and
+<guilabel>Deleting files or folders</guilabel> affect file operations in &dolphin;, &konqueror;, 
+<application>Gwenview</application> and all &kde; applications using the default &kde; file dialog, 
+whereas <guilabel>Closing Dolphin windows
+with multiple tabs</guilabel> is a &dolphin; specific setting.</para></warning>
+</sect3>
+
+<sect3 id="preferences-dialog-general-statusbar">
+<title>Status Bar Tab</title>
+
+<para>
+In this tab, some additional items can be enabled for the status bar, provided
+the status bar is wide enough:
+
+<itemizedlist>
+
+<listitem><para>
+A <guilabel>zoom slider</guilabel> which can be used to change the icon size quickly.
+</para></listitem>
+
+<listitem><para>
+A bar that shows how much space is free on the current drive.
+</para></listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect3>
+
+</sect2>
+
 <sect2 id="preferences-dialog-startup">
 <title>Startup</title>
 
@@ -1023,6 +1167,10 @@ startup or not. See the <link linkend="filter-files">section on the filter bar</
 for details.
 </para></listitem>
 
+<listitem><para>
+<guilabel>Show full path in title bar</guilabel> makes it easy to distinguish
+between files or folders with the same name in different folders.
+</para></listitem>
 </itemizedlist>
 
 </para>
@@ -1147,16 +1295,9 @@ structure and in archives works.
 <itemizedlist>
 
 <listitem><para>
-&dolphin; can be configured to open items with a single mouse click
-(<guilabel>Single-click to open files and folders</guilabel>) or a double mouse
-click (<guilabel>Double-click to open files and folders</guilabel>). In the
-latter case, a single mouse click will select the file or folder.
-</para>
-<note>
-<para>This is a system wide setting and can be changed in the &systemsettings; in the
-<menuchoice><guimenu>Input Devices</guimenu> <guimenuitem>Mouse</guimenuitem></menuchoice> 
-module as well.</para>
-</note>
+The option to open items with a single or double mouse click is a system wide setting and can be
+changed in the &systemsettings; in the <menuchoice><guimenu>Input Devices</guimenu>
+<guimenuitem>Mouse</guimenuitem></menuchoice> module.</para>
 </listitem>
 
 <listitem><para>
@@ -1261,137 +1402,6 @@ largest files can be deleted automatically.
 
 </sect2>
 
-<sect2 id="preferences-dialog-general">
-<title>General</title>
-
-<para>
-This group contains settings which control the general behavior of &dolphin;.
-The group is divided further into four subgroups which can be accessed using the
-tab bar at the top.
-
-<screenshot>
-<screeninfo>Screenshot of the General settings in &dolphin;'s preferences dialog</screeninfo>
-<mediaobject>
-<imageobject>
-<imagedata fileref="preferences-general-behavior.png" format="PNG"/>
-</imageobject>
-<textobject>
-<phrase>General Settings.</phrase>
-</textobject>
-<caption><para>General Settings in &dolphin;'s Preferences Dialog.</para></caption>
-</mediaobject>
-</screenshot>
-
-</para>
-
-<sect3 id="preferences-dialog-general-behavior">
-<title>Behavior Tab</title>
-
-<para>
-
-<itemizedlist>
-
-<listitem><para>
-In the <guilabel>View</guilabel> section, you can configure whether the
-<link linkend="view-properties"> view properties</link> are stored for each
-folder or if common view properties are to be used for all folders.
-</para></listitem>
-<listitem><para>
-When hovering over a file or folder with the mouse, a small window with relevant
-information is shown if <guilabel>Show tooltips</guilabel> is enabled.
-</para></listitem>
-
-<listitem><para>
-<guilabel>Show selection marker</guilabel> shows a small <guibutton>+</guibutton>
-or <guibutton>-</guibutton> button above an item's icon if the item is hovered over
-with the mouse. These can be used to select or deselect the item.
-</para></listitem>
-
-<listitem><para>
-<guilabel>Natural sorting of items</guilabel> controls how items are sorted in
-the view. If this option is enabled, the sort order of three example files
-will be
-<orderedlist>
-<listitem><para>File1,</para></listitem>
-<listitem><para>File2,</para></listitem>
-<listitem><para>File10.</para></listitem>
-</orderedlist>
-If this option is disabled, the normal alphabetical sorting will be used, which
-leads to the sort order
-<orderedlist>
-<listitem><para>File1,</para></listitem>
-<listitem><para>File10,</para></listitem>
-<listitem><para>File2.</para></listitem>
-</orderedlist>
-</para></listitem>
-
-<listitem><para>
-Enable <guilabel>Rename inline</guilabel> to use this mode if only one item is currently selected. 
-If this option is disabled or several items are selected, a dialog will be displayed for renaming.
-</para></listitem>
-
-</itemizedlist>
-
-</para>
-
-</sect3>
-
-<sect3 id="preferences-dialog-general-previews">
-<title>Previews Tab</title>
-
-<para>
-In this tab, you can configure for which file types previews are shown.
-Moreover, the maximum size of remote files for which previews are generated can be chosen.
-</para>
-<para>
-If previews are enabled for folders, previews of some files in the folder will
-be shown inside a folder's icon.
-</para>
-</sect3>
-
-<sect3 id="preferences-dialog-general-confirmations">
-<title>Confirmations Tab</title>
-<para>
-In the ask for confirmation section, you can enable warning dialogs that
-are shown before potentially harmful actions .
-</para>
-<warning><para>The confirmation settings for <guilabel>Moving files or folders to trash</guilabel> and
-<guilabel>Deleting files or folders</guilabel> affect file operations in &dolphin;, &konqueror;, 
-<application>Gwenview</application> and all &kde; applications using the default &kde; file dialog, 
-whereas <guilabel>Closing Dolphin windows 
-  with multiple tabs</guilabel> is a &dolphin; <!--and &konqueror;--> specific setting.</para></warning>
-</sect3>
-
-<sect3 id="preferences-dialog-general-statusbar">
-<title>Status Bar Tab</title>
-
-<para>
-In this tab, some additional items can be enabled for the status bar, provided
-the status bar is wide enough:
-
-<itemizedlist>
-
-<listitem><para>
-A <guilabel>zoom slider</guilabel> which can be used to change the icon size quickly.
-</para></listitem>
-
-<listitem><para>
-A bar that shows how much space is free on the current drive.
-</para></listitem>
-
-</itemizedlist>
-
-</para>
-<note><para>
-Since &dolphin; 4.9 the <guimenuitem>Delete</guimenuitem>,
-<guimenuitem>Copy To</guimenuitem>, and <guimenuitem>Move To</guimenuitem>
-commands of the context menu have to be enabled on the Services page.
-</para></note>
-
-</sect3>
-
-</sect2>
-
 </sect1>
 <!-- begin copy to konqueror filemanager.docbook -->
 <sect1 id="view-properties">
@@ -1399,7 +1409,7 @@ commands of the context menu have to be enabled on the Services page.
 
 <para>
 The following settings control how the contents of a folder are displayed in the
-&kappname; view, and are stored on a per-folder basis by default:
+&dolphin; view, and are stored on a per-folder basis by default:
 </para>
 <itemizedlist>
 
@@ -1420,7 +1430,7 @@ Sorting of folders and files &ndash; are folders shown first or not?
 <listitem><para>
 Previews &ndash; are they shown instead of icons (based on the settings made in
 <link linkend="preferences-dialog-general-previews"><guilabel>Previews</guilabel>
-tab of &kappname;'s General settings</link>) or not?
+tab of &dolphin;'s General settings</link>) or not?
 </para></listitem>
 
 <listitem><para>
@@ -1537,6 +1547,17 @@ folder.</action></para>
 <listitem><para><action>Closes the current tab.</action></para></listitem>
 </varlistentry>
 
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo>
+</shortcut>
+<guimenu>File</guimenu>
+<guimenuitem>Undo close tab</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Reopens the last closed tab.</action></para></listitem>
+</varlistentry>
+
 <varlistentry>
 <term><menuchoice>
 <shortcut>
@@ -1574,6 +1595,15 @@ trash.</action></para></listitem>
 to the trash and cannot be restored.</action></para></listitem>
 </varlistentry>
 
+<varlistentry>
+<term><menuchoice>
+<guimenu>File</guimenu>
+<guimenuitem>Show Target</guimenuitem>
+</menuchoice></term>
+<listitem><para>This action highlights a link target in a new &dolphin; window.
+</para></listitem>
+</varlistentry>
+
 <varlistentry>
 <term><menuchoice>
 <shortcut>
@@ -1585,7 +1615,7 @@ to the trash and cannot be restored.</action></para></listitem>
 <listitem><para><action>Shows the properties dialog for the currently selected
 item(s).</action></para></listitem>
 </varlistentry>
-
+<!--FIXME http://www.aelog.org/checksums-made-easy in fundamentals? -->
 <varlistentry>
 <term><menuchoice>
 <shortcut>
@@ -1645,7 +1675,10 @@ item(s).</action></para></listitem>
 <keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
 </shortcut>
 <guimenu>Edit</guimenu>
-<guimenuitem>Paste Clipboard Contents...</guimenuitem>
+<guimenuitem>Paste Clipboard Contents...</guimenuitem></menuchoice> or
+<menuchoice><guimenu>Edit</guimenu><guimenuitem>Paste one File</guimenuitem></menuchoice> or
+<menuchoice><guimenu>Edit</guimenu><guimenuitem>Paste one Folder</guimenuitem></menuchoice> or
+<menuchoice><guimenu>Edit</guimenu><guimenuitem>Paste x Items</guimenuitem>
 </menuchoice></term>
 <listitem><para><action>Pastes the currently copied/cut items to the current
 folder. If the clipboard does not contain files or folders, the clipboard
@@ -1779,10 +1812,11 @@ current folder grouped by the option selected in <guimenuitem>Sort By</guimenuit
 <keycombo action="simul">&Alt;<keycap>.</keycap></keycombo>
 </shortcut>
 <guimenu>View</guimenu>
-<guimenuitem>Show Hidden Files</guimenuitem>
+<guimenuitem>Hidden Files</guimenuitem>
 </menuchoice></term>
 <listitem><para><action>Shows all the hidden files and sub-folders within the current
-folder.</action></para></listitem>
+folder.</action>There is an alternate shortcut <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
+for this action.</para></listitem>
 </varlistentry>
 
 <varlistentry>
@@ -1950,7 +1984,9 @@ be reopened.</action></para></listitem>
 <guimenu>Tools</guimenu>
 <guimenuitem>Show Filter Bar</guimenuitem>
 </menuchoice></term>
-<listitem><para><action>Enables and disables the <link linkend="filter-files">filter bar</link>.</action></para></listitem>
+<listitem><para><action>Enables and disables the <link linkend="filter-files">filter bar</link>.</action>
+You can also use the alternate shortcut <keycombo action="simul">&Shift;<keycap>/</keycap></keycombo>
+for this action.</para></listitem>
 </varlistentry>
 
 <varlistentry>
@@ -2070,8 +2106,9 @@ tracking system. The &kde; bug tracker can be found at
 &dolphin;
 </para>
 <para>
-Program copyright 2006&ndash;2013 Peter Penz <email>peter.penz@gmx.at</email> and 
-Frank Reininghaus <email>frank78ac@googlemail.com</email></para>
+Program copyright 2006&ndash;2014 Peter Penz <email>peter.penz@gmx.at</email>, 
+Frank Reininghaus <email>frank78ac@googlemail.com</email> and Emmanuel Pescosta 
+<email>emmanuelpescosta099@gmail.com</email> </para>
 <para>
 Contributors:
 <itemizedlist>
@@ -2102,22 +2139,6 @@ Documentation copyright 2009 Frank Reininghaus <email>frank78ac@googlemail.com</
 
 </chapter>
 
-<appendix id="installation">
-<title>How to get &dolphin;</title>
-<para>&dolphin; is part of the &package; package which is an essential part of
-&kde;.</para>
-
-<para>For instructions on acquiring &kde; please see <ulink
-url="http://www.kde.org">http://www.kde.org</ulink> or read the chapter 
-<ulink url="help:/fundamentals/install.html">Installing &kde;</ulink> 
-in the &kde; Fundamentals.</para>
-
-<para>For further information about &dolphin; you might want to visit
-<ulink url="http://dolphin.kde.org">http://dolphin.kde.org</ulink> or
-<ulink url="http://userbase.kde.org/Dolphin">http://userbase.kde.org/Dolphin</ulink>.</para>
-
-</appendix>
-
 &documentation.index;
 </book>