[kupfer] help: Add basic documentation for applications and notes



commit 293df61d5223bf6ea31106f6bc2a3752b141cb58
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Wed Mar 9 00:50:17 2011 +0100

    help: Add basic documentation for applications and notes

 help/C/plugin-applications.page |   64 +++++++++++++++++++++++++++++++++++
 help/C/plugin-notes.page        |   70 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 134 insertions(+), 0 deletions(-)
---
diff --git a/help/C/plugin-applications.page b/help/C/plugin-applications.page
new file mode 100644
index 0000000..15e52ea
--- /dev/null
+++ b/help/C/plugin-applications.page
@@ -0,0 +1,64 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="plugin-applications">
+
+  <info>
+   <link type="guide" xref="index#plugins"/>
+   <desc>Using the applications plugin.</desc>
+  </info>
+
+  <title><app>Applications</app></title>
+
+  <section>
+    <title>Applications Plugin</title>
+    <p>
+      <app>Applications</app> provides all installed programs.
+    </p>
+  </section>
+  <section>
+    <title>Basic Usage</title>
+    <steps>
+     <title>Launching an application</title>
+     <item>
+      <p>
+        Activate Kupfer and type an abbreviation of the application name
+      </p>
+     </item>
+     <item>
+      <p>
+         Press <key>Return</key> to launch the application.
+      </p>
+     </item>
+    </steps>
+    <steps>
+     <title>Opening a file with a specific application</title>
+     <item>
+      <p>
+        Select a file in <app>Kupfer</app>
+      </p>
+     </item>
+     <item>
+      <p>
+        Type <key>Tab</key> and select the action <em>Open With...</em>
+      </p>
+     </item>
+     <item>
+      <p>
+        Type <key>Tab</key> to select the third (indirect object) pane
+        and in it, select the application the file with.
+      </p>
+     </item>
+   </steps>
+ </section>
+  <section>
+  <title>Configuration</title>
+    <p>
+      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
+      shown depending on which desktop environment is used. By default, it
+      behaves like GNOME.
+    </p>
+  </section>
+</page>
diff --git a/help/C/plugin-notes.page b/help/C/plugin-notes.page
new file mode 100644
index 0000000..e2f1214
--- /dev/null
+++ b/help/C/plugin-notes.page
@@ -0,0 +1,70 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="plugin-notes">
+
+  <info>
+   <link type="guide" xref="index#plugins"/>
+   <desc>Using the notes plugin.</desc>
+  </info>
+
+  <title><app>Notes</app></title>
+
+ <section>
+  <title>Notes Plugin</title>
+  <p>
+    With <app>Notes</app> you can access or create new notes in either the
+    program <app>Gnote</app> or <app>Tomboy</app>. <app>Notes</app> will
+    work identically with either applicationâ??you can configure which one
+    to use in the plugin's information pane in <app>Kupfer Preferences</app>.
+  </p>
+  </section>
+  <section>
+    <title>Basic Usage</title>
+    <steps>
+     <title>Creating a new note</title>
+     <item>
+      <p>
+        Activate Kupfer and type <key>.</key> to enter text mode, then 
+        type in a note title
+      </p>
+     </item>
+     <item>
+      <p>
+        Type <key>Tab</key> and select the action <em>Create
+          Note</em> and press <key>Return</key>.
+      </p>
+     </item>
+    </steps>
+    <steps>
+     <title>Finding a note by title</title>
+     <item>
+       <p>Simply search for the note title in <app>Kupfer</app></p>
+     </item>
+   </steps>
+    <steps>
+     <title>Finding a note by content</title>
+     <item>
+      <p>
+        Activate Kupfer and type <key>.</key> to enter text mode, then 
+        type in a search query
+      </p>
+     </item>
+     <item>
+      <p>
+        Type <key>Tab</key> and select the action <em>Get Note Search
+          Results...</em> and press <key>Return</key>.  </p>
+     </item>
+   </steps>
+ </section>
+ <section>
+   <title>Power User Tips</title>
+   <list>
+   <item>
+     <p>
+       You can use the <em>Selected Text</em> object and create a new note
+       with the content of the selection.
+     </p>
+   </item>
+   </list>
+   </section>
+</page>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]