GNOME.org
 

[kupfer] help: Editing moreusage, managing plugins

commit 383e2d39bb991b919f5de3e22a82c3685d376d03
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Wed Mar 9 13:57:27 2011 +0100

    help: Editing moreusage, managing plugins

 help/C/keyboard.page            |    2 +-
 help/C/managing-plugins.page    |   59 +++++++++++++++------------
 help/C/moreusage.page           |   85 ++++++++++++++++++++------------------
 help/C/plugin-applications.page |    2 +-
 4 files changed, 80 insertions(+), 68 deletions(-)
---
diff --git a/help/C/keyboard.page b/help/C/keyboard.page
index e269155..e7ed362 100644
--- a/help/C/keyboard.page
+++ b/help/C/keyboard.page
@@ -83,7 +83,7 @@
   </section>
 
   <section>
-    <title>Kuper's Keyboard Shortcuts</title>
+    <title>Kupfer's Keyboard Shortcuts</title>
     <p>
       These keyboard shortcuts are used in <app>Kupfer</app>'s interface.
       They have the following meanings and default shortcuts:
diff --git a/help/C/managing-plugins.page b/help/C/managing-plugins.page
index a52f550..4f821c2 100644
--- a/help/C/managing-plugins.page
+++ b/help/C/managing-plugins.page
@@ -17,29 +17,34 @@
 
   <section>
     <title>Configuring Plugins</title>
-    <p>
-      You can enable, disable and configure plugins if you open Kupfer's
-      preferences window using one of these methods:
-    </p>
-    <list>
-      <item><p>Click the Kupfer icon in the notification area and select
-        the item Preferences</p>
-      </item>
-      <item><p>Search for the object <app>Kupfer Preferences</app> in Kupfer itself.
-            Press <key>Return</key> to open it.</p>
+    <steps>
+      <title>Open <app>Kupfer Preferences</app> to the Plugins tab</title>
+      <item>
+        <p> Use one of the following methods:</p>
+        <list>
+          <item><p>Click the Kupfer icon in the notification area and select
+              the item <em>Preferences</em></p>
+          </item>
+          <item>
+            <p>Search for the object <app>Kupfer Preferences</app> in Kupfer
+              itself.  Press <key>Return</key> to open it.
+            </p>
+          </item>
+          <item><p>Use the keyboard shortcut
+              <keyseq><key>Ctrl</key><key>;</key></keyseq></p>
+          </item>
+        </list>
       </item>
-      <item><p>Use the keyboard shortcut
-          <keyseq><key>Control</key><key>;</key></keyseq></p>
+      <item>
+        <p>
+          Select the tab <em>Plugins</em>
+        </p>
       </item>
-    </list>
-    <p>
-      Select the tab "Plugins" to reach the plugin list in the
-      preferences window.
-    </p>
+    </steps>
 
     <p>
       Select plugins in the list to read about them, and tick the box
-      next to its name to load the plugin.
+      next to its name to activate the plugin, or untick to deactivate.
     </p>
     <p>
       If the plugin has any configurable parameters, they will be
@@ -51,16 +56,16 @@
     </p>
   </section>
   <section>
-    <title>If a Plugin can not be Loaded</title>
+    <title>If a Plugin can not be Activated</title>
       <p>
-        If the plugin fails to
-        load because it requires a software module that is not available,
-        the plugin information will display a message like this:
+        If a plugin fails to activate because it requires a software
+        module that is not available, its plugin information will display a
+        message like this:
       </p>
       <p><em>Plugin could not be read due to an error:</em>
       </p><p><em>Python module 'gdata' is needed</em></p>
       <p>
-        This means that you need to install the needed python module
+        This means that you need to install a needed python module
         from your distributionâ??and possibly the plugin documentation can
         tell you how. 
       </p>
@@ -89,11 +94,13 @@
   <section>
     <title>Creating Plugins</title>
     <p>
-      Adding to <app>Kupfer</app>'s object knowledge can be surprisingly
-      easy, just look at the default plugins if you want to create new.
       Documentation for plugin creators is available in the file
-      Documentation/Manual.rst in the source distribution on the webpage at
+      <code>Documentation/Manual.rst</code> in the source distribution on
+      the webpage at
       <link href="http://kaizer.se/wiki/kupfer/Manual/";>Kupfer Manual</link>.
+
+      An easy way to start is to copy an existing plugin and experimenting
+      with it.
     </p>
   </section>
   <section>
diff --git a/help/C/moreusage.page b/help/C/moreusage.page
index a3b8c3a..41ea73c 100644
--- a/help/C/moreusage.page
+++ b/help/C/moreusage.page
@@ -12,67 +12,70 @@
  <section>
   <title>Open Terminal Here</title>
   <p>
-   Open terminal first calls <cmd>xdg-terminal</cmd>, then <cmd>gnome-terminal</cmd>. 
-   xdg-terminal is a script to find the user's configured terminal program for 
-   his/her Desktop Environment. Install <cmd>xdg-terminal</cmd> if you need this 
-   (or install a symlink <em>called</em> xdg-terminal). 
+   Open terminal first calls <cmd>xdg-terminal</cmd>, then
+   <cmd>gnome-terminal</cmd>.  xdg-terminal is a script to find the user's
+   configured terminal program for their Desktop Environment. Install
+   <cmd>xdg-terminal</cmd> if you need this (or install a symlink
+   <em>called</em> xdg-terminal). 
   </p>
  </section>
   
  <section>
-  <title>Grab current selection</title>
+  <title>Grab Current Selection</title>
   <p> To use the current selected text, from any application, with
     <app>Kupfer</app>, you can configure a global keyboard shortcut for the
-    action Show with Selection in the preferences window.
+    action <em>Show with Selection</em> in <app>Kupfer Preferences</app>.
   </p>
   <p>
    If configured, pressing the global keyboard shortcut
    will summon <app>Kupfer</app> with the current selection as the focused
    object.
   </p>
+  <p>See <link xref="keyboard"/></p>
  </section>
   
  <section>
-  <title>Adding your actions and scripts</title>
+  <title>Adding Applications and Scripts</title>
   <p>
-   If you want to add a custom application, or an application called with 
-   special options, you can create a new launcher for it and place it in 
-   one of the standard places for applications, for example 
-   <file>~/.local/share/applications</file>, where <app>Kupfer</app> will find it. 
+   <app>Kupfer</app> will show all applications that are configured visible
+   in your menu editor.
+ </p>
+ <p>
+   If you want to add an application manually, you can create a new
+   <code>.desktop</code> file and place it in one of the standard directories
+   for applications, for example <file>~/.local/share/applications</file>,
+   where <app>Kupfer</app> will find it. 
   </p>
   <p>
-   If you have a collection of scripts that you want to call from <app>Kupfer</app>, 
-   you can add the scripts folder as a catalog directory to <app>Kupfer</app> in the 
-   preferences. Scripts that you add to <app>Kupfer</app>'s catalog this way can be 
-   run directly or in the terminal as long as they are executable.
+   If you have a collection of scripts that you want to call from
+   <app>Kupfer</app>, you can add the scripts folder as a catalog directory
+   to <app>Kupfer</app> in the preferences. Scripts that you add to
+   <app>Kupfer</app>'s catalog this way can be run directly or in the
+   terminal as long as they are executable.
   </p>
   <p>
-   An example useful script is <link href="http://kaizer.se/wiki/code/rhrating.py/";>
-   here</link> which changes the rating of <app>Rhythmbox</app>'s currently playing 
-   song; I have added five scriptlets calling <file>rhrating.py</file> with numbers 
-   from 0 to 5 to my catalog to quickly rate tracks. (This is something that might 
-   be integrated into <app>Kupfer</app> later)
+    You can also save command-lines by using the action <em>Add to
+      Favorites</em>.
   </p>
  </section>
   
  <section>
-  <title>Command line connection</title>
+  <title>Command-line Connection</title>
   <p>
-    <app>Kupfer</app> is its own remote control. When <app>Kupfer</app> is 
-    already running, <app>Kupfer</app> on the command-line will focus its window, 
-    but there is more you can do: If you invoke <cmd><app>kupfer</app> 
-    <var>QUERY</var></cmd> where <var>QUERY</var> is a text string or a filename, 
-    <app>Kupfer</app> will focus, and select this item. This way, you can quickly 
-    invoke <app>Kupfer</app> actions even on objects from a shell-based context.
+    The command <cmd>kupfer</cmd> on the command-line will focus
+    <app>Kupfer</app> if it's already running, otherwise it will start it.
   </p>
   <p>
+    The command <cmd>kupfer</cmd> can be used to send files or text from
+    the command-line to <app>Kupfer</app>.
+
     For example, if you are using the shell in a directory where you have 
     a file called "report.pdf", you can focus this file in <app>Kupfer</app> by 
     running <cmd>kupfer report.pdf</cmd>. 
   </p>
   <p>
-    You can also pipe the output of a command into <app>Kupfer</app> to send text to 
-    the already running instance of <app>Kupfer</app>. 
+    You can also send text if you pipe the output of a command into
+    <cmd>kupfer</cmd>.
   </p>
  </section>
   
@@ -109,8 +112,8 @@
  </section>
 
  <section>
-   <title>The "Comma Trick"</title>
-    <p> The "comma trick" allows the user to use actions on many objects at
+   <title>The <em>Comma Trick</em></title>
+    <p> The comma trick allows the user to use actions on many objects at
        the same time.
     </p>
 
@@ -133,20 +136,22 @@
           You can even bind a trigger to this command(!) 
       </p></item>
     </list>
-    <p>The "comma trick" is 
+    <p>The comma trick is 
       <link href="http://www.43folders.com/2005/06/13/quicksilver-the-comma-trick";>
         directly taken from Quicksilver</link>
-      (the example given in the external article should work identically in Kupfer).
+      (the example given in the external article should work identically in
+      Kupfer).
     </p>
   </section>
   <section>
-    <title>Save Commands as Files</title>
-    <p>You can use keyboard shortcut for "Compose Command" (by default it is
-      <keyseq><key>Control</key><key>Return</key></keyseq>) to create a
-      command object out of the currently focused command in Kupfer.
-      This object can be saved as a runnable file if you use the "Save As.." action.
-      The resulting file will can be executed when opened from the file manager
-      (to run it requires that Kupfer is already running).
+    <title>Saving Commands as Files</title>
+    <p>You can use keyboard shortcut for <em>Compose Command</em> (by
+      default it is <keyseq><key>Ctrl</key><key>Return</key></keyseq>) to
+      create a command object out of the currently focused command in
+      Kupfer.  This object can be saved as a runnable file if you use the
+      <em>Save As...</em> action.  The resulting file will can be executed
+      when opened from the file manager (it requires that Kupfer is already
+      running).
     </p>
   </section>
 
diff --git a/help/C/plugin-applications.page b/help/C/plugin-applications.page
index 15e52ea..f0e4475 100644
--- a/help/C/plugin-applications.page
+++ b/help/C/plugin-applications.page
@@ -56,7 +56,7 @@
       The configuration option <em>Applications for Desktop Environment</em>
       in the plugin's information pane in <app>Kupfer Preferences</app>
       determines how <app>Kupfer</app> should act with regard to the desktop
-      environment configuration -- certain applications request not to be
+      environment configurationâ??certain applications request not to be
       shown depending on which desktop environment is used. By default, it
       behaves like GNOME.
     </p>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]