[krusader] doc: Add some documentation on the JobMan

Yuri Chornoivan yurchor at ukr.net
Sun Dec 4 15:05:07 UTC 2016


Git commit a71bf6159d2be1c97ed28145053a9e97acf4434f by Yuri Chornoivan.
Committed on 04/12/2016 at 15:04.
Pushed by yurchor into branch 'master'.

Add some documentation on the JobMan

M  +13   -0    doc/basic-functions.docbook
A  +-    --    doc/copyjob.png
M  +18   -0    doc/features.docbook
M  +13   -0    doc/menu-commands.docbook
M  +-    --    doc/toolbar.png
M  +11   -23   doc/user-interface.docbook

https://commits.kde.org/krusader/a71bf6159d2be1c97ed28145053a9e97acf4434f

diff --git a/doc/basic-functions.docbook b/doc/basic-functions.docbook
index 1d00830..3f2c812 100644
--- a/doc/basic-functions.docbook
+++ b/doc/basic-functions.docbook
@@ -357,6 +357,17 @@
       The default destination is the other-panel browsed directory. If you enter
       a partial &URL;, &krusader; will use the current
       panel directory as the &URL; base.</para>
+      <figure id="screenshot-copyjob" float="1">
+        <title>Copy dialog</title>
+        <mediaobject>
+          <imageobject>
+            <imagedata fileref="copyjob.png"></imagedata>
+          </imageobject>
+          <textobject>
+            <phrase>Copy dialog</phrase>
+          </textobject>
+        </mediaobject>
+      </figure>
     </sect2>
     <sect2 id="queue">
       <title>Queue manager</title> 
@@ -373,6 +384,8 @@
       If you pack/unpack 40 files in parallel, you overload your computer,
       but adding them to a queue, is much more useful.
       </para>
+      <para>It is possible to switch the <link linkend="job-queue-mode">Queue Manager mode</link> by the <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Job Queue Mode</guimenuitem></menuchoice> menu item.
+      </para>
     </sect2>
     <sect2 id="deleting">
       <title>Deleting - move to &kde;'s Trash</title>
diff --git a/doc/copyjob.png b/doc/copyjob.png
new file mode 100644
index 0000000..a07f842
Binary files /dev/null and b/doc/copyjob.png differ
diff --git a/doc/features.docbook b/doc/features.docbook
index 83f2d53..17cf4e7 100644
--- a/doc/features.docbook
+++ b/doc/features.docbook
@@ -449,6 +449,24 @@
   </itemizedlist>
 </para>
 
+<para>
+  <itemizedlist>
+    <title>New features in the &krusader;-2.5.x "Clear Skies"
+    release</title>
+    <listitem>
+      <para>Ported to &kf5-full;.
+      </para>
+    </listitem>
+    <listitem>
+        <para>The new <link linkend="quickfilter">Quickfilter</link> bar with three different modes to operate: select, search and filter.
+      </para>
+    </listitem>
+    <listitem>
+        <para>Reworked Queue Manager (JobMan) and the new <link linkend="job_toolbar">Job Toolbar</link>.
+      </para>
+    </listitem>
+  </itemizedlist>
+</para>
 
 
 <para><note><para>
diff --git a/doc/menu-commands.docbook b/doc/menu-commands.docbook
index caebed5..96b9977 100644
--- a/doc/menu-commands.docbook
+++ b/doc/menu-commands.docbook
@@ -1779,6 +1779,19 @@
 	  </itemizedlist>
 	</listitem>
       </varlistentry>
+      <varlistentry id="job-queue-mode">
+        <term>
+          <menuchoice>
+            <guimenu>Settings</guimenu>
+            <guimenuitem>Job Queue Mode</guimenuitem>
+          </menuchoice>
+        </term>
+        <listitem>
+          <para>
+              Toggles the <link linkend="queue">Queue Manager</link> mode. If checked then pressing <keycap>F2</keycap> or the corresponding button in the copy/move dialog immediately starts the job even if there are running jobs in queue. If unchecked then the job will be put into the queue if the queue is not empty. Otherwise the job will be started immediately.
+          </para>
+        </listitem>
+      </varlistentry>
       <varlistentry id="configure-shortcuts">
         <term>
           <menuchoice>
diff --git a/doc/toolbar.png b/doc/toolbar.png
index 71f7cf1..c74e374 100644
Binary files a/doc/toolbar.png and b/doc/toolbar.png differ
diff --git a/doc/user-interface.docbook b/doc/user-interface.docbook
index 02f23f4..3205a52 100644
--- a/doc/user-interface.docbook
+++ b/doc/user-interface.docbook
@@ -25,17 +25,6 @@
   </sect1>
   <sect1 id="mainwindow">
     <title>&krusader; Main Window</title>
-    <!-- OLD
-<screenshot>
-   <screeninfo>&krusader; Main Window</screeninfo>
-    <mediaobject>
-     <imageobject><imagedata fileref="mainwindow.png" format="PNG"/></imageobject>
-     <imageobject><imagedata fileref="mainwindow.png" format="EPS"/></imageobject>
-     <textobject><phrase>&krusader; Main Window</phrase></textobject>
-     <caption><para>&krusader; is main window with all the different parts named on the screen.</para></caption>
-    </mediaobject>
-</screenshot>
--->
     <figure id="screenshot-mainwindow" float="1">
       <title>&krusader; Main Window</title>
       <mediaobject>
@@ -80,16 +69,6 @@
         <primary>Toolbar</primary>
         <secondary>Main Toolbar</secondary>
       </indexterm>
-<!-- OLD
-<screenshot>
-    <screeninfo>Main Toolbar</screeninfo>
-    <mediaobject>
-     <imageobject><imagedata fileref="toolbar.png" format="PNG"/></imageobject>
-     <imageobject><imagedata fileref="toolbar.png" format="EPS"/></imageobject>
-     <textobject><phrase>Main Toolbar</phrase></textobject>
-    </mediaobject>
-</screenshot>
--->
       <figure id="screenshot-maintoolbar" float="1">
         <title>Main Toolbar</title>
         <mediaobject>
@@ -101,9 +80,11 @@
           </textobject>
         </mediaobject>
       </figure>
-      <para>The &krusader; Main Toolbar, is a standard
+      <para>The &krusader; Main Toolbar is a standard
       &kde; toolbar that can be dragged around the
-      application or configured via a
+      application (please unlock it first by unchecking the <guimenuitem>Lock
+      Toolbar Positions</guimenuitem> item in the right-click menu)
+      or configured via a
       <keycap>Right-Click</keycap> menu. You can decide whether or
       not you want to display it each time you start
       &krusader; in the <link linkend="konfigurator">Konfigurator Startup page</link>,
@@ -119,6 +100,13 @@
       can be placed into the Main Toolbar and the Actions Toolbar
       with the mouse using "drag and drop".</para>
     </sect2>
+    <sect2 id="job_toolbar">
+      <title>Job Toolbar</title>
+      <para>By default, the &krusader; Job Toolbar (<link linkend="queue">Queue
+      Manager</link> or simply the JobMan) is located at the right part of the
+      Main Toolbar. This toolbar allows you to view the job progress, to pause
+      and resume the job list execution and to undo the last executed job.</para>
+    </sect2>
     <sect2 id="actions_toolbar">
       <title>Actions Toolbar</title>
       <indexterm>


More information about the kde-doc-english mailing list