[kupfer] help: Improve docs in general sections and proofreading tweaks
- From: Ulrik Sverdrup <usverdrup src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [kupfer] help: Improve docs in general sections and proofreading tweaks
- Date: Wed, 9 Mar 2011 01:12:41 +0000 (UTC)
commit b60d4d0603f6f3f780d0623d93c0c781995d60ea
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date: Wed Mar 9 01:16:46 2011 +0100
help: Improve docs in general sections and proofreading tweaks
help/C/generalusage.page | 2 +-
help/C/keyboard.page | 32 ++++++++++++++++++++++++++++++--
help/C/managing-plugins.page | 36 +++++++++++++++++++++++++++++-------
help/C/moreusage.page | 2 +-
help/C/plugin-favorites.page | 2 +-
help/C/plugin-triggers.page | 9 +++++----
6 files changed, 67 insertions(+), 16 deletions(-)
---
diff --git a/help/C/generalusage.page b/help/C/generalusage.page
index 0245bba..e3f4746 100644
--- a/help/C/generalusage.page
+++ b/help/C/generalusage.page
@@ -95,7 +95,7 @@
<p>
Objects in the catalog that have content, like folders, are marked
- with an arrow. Pressing <key>right-arrow</key> will enter these
+ with an arrow. Pressing <key>â??</key> will enter these
objects. Much of the catalog is composed of subcatalogs; plugin
subcatalogs do in general list objects that are also available
directly from the top level. Subcatalogs can be used for a
diff --git a/help/C/keyboard.page b/help/C/keyboard.page
index ca20d33..950db49 100644
--- a/help/C/keyboard.page
+++ b/help/C/keyboard.page
@@ -4,7 +4,7 @@
<info>
<link type="guide" xref="index#usage"/>
- <desc>Complete keyboard reference.</desc>
+ <desc>Complete keyboard shortcuts reference.</desc>
</info>
<title>Command Keys and Accelerator Keys</title>
@@ -157,7 +157,35 @@
<td><p> Show <app>Kupfer</app> with 'Selection' object focused</p></td>
</tr>
</table>
-
+ <steps>
+ <title>How to configure a global keyboard shortcut</title>
+ <item>
+ <p>
+ Open <app>Kupfer Preferences</app> and go to the
+ <em>Keyboard</em> tab.
+ </p>
+ </item>
+ <item>
+ <p>
+ Double-click the shorcut's row under <em>Global Keyboard
+ Shortcuts</em>.
+ </p>
+ </item>
+ <item>
+ <p>
+ Using the window that appears, press modifier keys and a letter or
+ number key to set a global shortcut. An example is pressing and
+ holding <key>Super</key> and then pressing and releasing
+ <key>Space</key> to bind
+ <keyseq><key>Super</key><key>Space</key></keyseq>.
+ </p>
+ </item>
+ </steps>
+ <p>
+ Since these keyboard shortcuts are global, they can be used from any
+ application. Select shortcuts with care so that they do not
+ conflict with other functions.
+ </p>
</section>
<section>
<title>Triggers</title>
diff --git a/help/C/managing-plugins.page b/help/C/managing-plugins.page
index e2fa141..a52f550 100644
--- a/help/C/managing-plugins.page
+++ b/help/C/managing-plugins.page
@@ -7,7 +7,7 @@
<desc>Using plugins with <app>Kupfer</app>.</desc>
</info>
- <title>How to configure plugins</title>
+ <title>How to Configure Plugins</title>
<p>
Functionality in Kupfer is organized by extentsion modules called
@@ -39,9 +39,8 @@
<p>
Select plugins in the list to read about them, and tick the box
- next its name to load the plugin.
+ next to its name to load the plugin.
</p>
-
<p>
If the plugin has any configurable parameters, they will be
visible below the plugin information.
@@ -51,6 +50,25 @@
reveals the implementation.
</p>
</section>
+ <section>
+ <title>If a Plugin can not be Loaded</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:
+ </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
+ from your distributionâ??and possibly the plugin documentation can
+ tell you how.
+ </p>
+ <p>The plugin may also unexpectedly fail to load, and display a
+ different error message. It may then be a program error in either
+ the plugin or <app>Kupfer</app>.
+ </p>
+ </section>
<section>
<title>Installing more Plugins</title>
@@ -62,6 +80,10 @@
in the package format can include icon files. Python packages can even
be installed as <code>.zip</code> files.
</p>
+ <p>
+ <em>Caution:</em> Treat a plugin as a computer program.
+ Do not install untrusted plugins.
+ </p>
</section>
<section>
@@ -75,10 +97,10 @@
</p>
</section>
<section>
- <title>The <em>Catalog</em> tab in preferences</title>
+ <title>The <em>Catalog</em> Tab in Preferences</title>
<p>
Each plugin can export a number of sources which contain objects.
- Normally, all their contents are directly accessible from a top-level
+ Normally, all these objects are directly accessible from a top-level
search.
Some plugins export so specialized or so many objects that their
catalogs should better not have their objects exported to the top
@@ -92,8 +114,8 @@
An unticked box means that its contents are hidden from the top level.
</p>
<p>
- <em>Note:</em> Kupfer may become slow if large enough subcatalogs are exported
- to the top level.
+ <em>Note:</em> Kupfer may become slow if large enough subcatalogs are
+ exported to the top level.
</p>
</section>
</page>
diff --git a/help/C/moreusage.page b/help/C/moreusage.page
index 8e99432..a3b8c3a 100644
--- a/help/C/moreusage.page
+++ b/help/C/moreusage.page
@@ -7,7 +7,7 @@
<desc>More advanced usage information.</desc>
</info>
- <title>Using <app>Kupfer</app> in depth.</title>
+ <title>Using <app>Kupfer</app> in Depth</title>
<section>
<title>Open Terminal Here</title>
diff --git a/help/C/plugin-favorites.page b/help/C/plugin-favorites.page
index c7a374f..d19e90f 100644
--- a/help/C/plugin-favorites.page
+++ b/help/C/plugin-favorites.page
@@ -35,7 +35,7 @@
</steps>
</section>
<section>
- <title>Power user tips</title>
+ <title>Power User Tips</title>
<p>
If you favorite an object, you can access it in more places. Not only in
the "Favorites" subcatalog, but also as the indirect (secondary) object
diff --git a/help/C/plugin-triggers.page b/help/C/plugin-triggers.page
index b85089e..2f1adac 100644
--- a/help/C/plugin-triggers.page
+++ b/help/C/plugin-triggers.page
@@ -43,18 +43,19 @@
<p>
Using the window that appears, press modifier keys and a letter or
number key to set a global shortcut. An example is pressing and
- holding <key>Ctrl</key><key>Alt</key> and then typing <key>R</key>
- to bind <keyseq><key>Ctrl</key><key>Alt</key><key>R</key></keyseq>.
+ holding <keyseq><key>Ctrl</key><key>Alt</key></keyseq> and then
+ pressing and releasing <key>R</key> to bind
+ <keyseq><key>Ctrl</key><key>Alt</key><key>R</key></keyseq>.
</p>
</item>
</steps>
<p> Since trigger keyboard shortcuts are global, they can be used from
- any application. You must select shortcuts with care so that they do
+ any application. Select shortcuts with care so that they do
not conflict with other functions.
</p>
</section>
<section>
- <title>Power user tips</title>
+ <title>Power User Tips</title>
<p> <em>Proxy objects</em> such as <em>Selected Text</em>, <em>Selected File</em>,
<em>Frontmost Window</em>, <em>Last Command</em> et cetera allow very
powerful triggers.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]