[Xfce4-commits] <xfce4-docs:xfce4-clipman-plugin-master> doc: Include new section "Tweaks" of Settings dialog
Mike Massonnet
noreply at xfce.org
Sat Oct 29 12:10:03 CEST 2011
Updating branch refs/heads/xfce4-clipman-plugin-master
to 9096f9067e8b2ab26a4e1baf3434ac92e0999cb5 (commit)
from cb8da9de6c4b004403b7cd965072a91c572627d8 (commit)
commit 9096f9067e8b2ab26a4e1baf3434ac92e0999cb5
Author: Mike Massonnet <mmassonnet at xfce.org>
Date: Sat Oct 29 11:12:48 2011 +0200
doc: Include new section "Tweaks" of Settings dialog
index.page | 154 +++++++++++++++++++++++++++++++++++-------------------------
1 files changed, 90 insertions(+), 64 deletions(-)
diff --git a/index.page b/index.page
index c88e6a0..b8b9e95 100644
--- a/index.page
+++ b/index.page
@@ -5,7 +5,7 @@
id="xfce4-clipman">
<info>
- <revision pkgversion="1.2.0" date="2011-10-20" />
+ <revision pkgversion="1.2.1" date="2011-10-29" />
<title type="text">Clipman</title>
<desc>User documentation</desc>
<credit type="author" its:translate="no">
@@ -54,29 +54,30 @@
</section>
- <section id="getting-started">
+ </section>
- <title>Getting Started</title>
- <p>
- <app>Clipman</app> is used to keep in history a list of clipboard contents and to restore
- them. The history is displayed in a menu by clicking on the main icon. Within
- the menu it is possible to restore a text and to clear the history.
- </p>
- <figure>
- <title>Clipman menu with the history</title>
- <desc>Shows the menu that popups when clicking the Clipman icon in the Xfce Panel or the notification area</desc>
- <media type="image" src="media/clipman-menu.png" />
- </figure>
- <p>
- There are two ways to run <app>Clipman</app>. You can select <app>Clipman</app> in the applications menu under the category
- Utility or type <cmd>xfce4-clipman</cmd> on the command-line, or you can add it into your panel.
- To add a new item in the panel right click the panel and select <gui style="menuitem">Add new item...</gui>.
- </p>
+ <section id="starting-clipman">
- </section>
+ <title>Starting Clipman</title>
+ <p>
+ <app>Clipman</app> is used to keep in history a list of clipboard contents and to restore
+ them. The history is displayed in a menu by clicking on the main icon. Within
+ the menu it is possible to restore a text and to clear the history.
+ </p>
+ <figure>
+ <title>Clipman menu with the history</title>
+ <desc>Shows the menu that popups when clicking the Clipman icon in the Xfce Panel or the notification area</desc>
+ <media type="image" src="media/clipman-menu.png" />
+ </figure>
+ <p>
+ There are two ways to run <app>Clipman</app>. You can select <app>Clipman</app> in the applications menu under the category
+ Utility or type <cmd>xfce4-clipman</cmd> on the command-line, or you can add it into your panel.
+ To add a new item in the panel right click the panel and select <gui style="menuitem">Add new item...</gui>.
+ </p>
<section id="popup-command">
+ <title>Popup Command</title>
<p>
<app>Clipman</app> provides the command-line tool <cmd>xfce4-popup-clipman</cmd>. When called it
popups the main menu. The command is practical for the <app>Application Shortcuts</app>
@@ -87,9 +88,9 @@
</section>
- <section id="settings">
+ <section id="settings-dialog">
- <title>Settings</title>
+ <title>Settings Dialog</title>
<p>
The settings dialog is available under the <gui>Properties</gui> item in the right click context menu on
the main icon. It allows to tweak the history and to edit actions.
@@ -99,47 +100,34 @@
<title>General Settings</title>
<p>
- The following table describes the available options in the <gui>General</gui> tab of the <gui>Settings</gui> dialog.
+ The following list describes the available options in the <gui>General</gui> tab of the <gui>Settings</gui> dialog.
</p>
- <table rules="cols rowgroups" shade="rows" frame="all">
- <title>General options</title>
- <desc>Description of options from the General tab of the Settings dialog</desc>
- <thead>
- <tr>
- <td><p>Option</p></td>
- <td><p>Description</p></td>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><p>Sync selections</p></td>
- <td><p>Sync the primary clipboard with the default clipboard in a way that it is possible to paste
- what gets selected</p></td>
- </tr>
- <tr>
- <td><p>Save on quit</p></td>
- <td><p>Keeps the history at every new session</p></td>
- </tr>
- <tr>
- <td><p>Store last copied image</p></td>
- <td><p>Allows to store one image in the history</p></td>
- </tr>
- <tr>
- <td><p>Ignore selections</p></td>
- <td><p>Prevents the primary clipboard from being inserted in the history</p></td>
- </tr>
- <tr>
- <td><p>Reverse order</p></td>
- <td><p>Reverse order of the history shown in the menu</p></td>
- </tr>
- <tr>
- <td><p>Size of the history</p></td>
- <td><p>Sets the number of items to keep in history</p></td>
- </tr>
- </tbody>
- </table>
+ <terms>
+ <title>List of available General settings</title>
+ <item>
+ <title>Sync selections</title>
+ <p>Sync the primary clipboard with the default clipboard in a way that it is possible to paste
+ what gets selected.</p>
+ </item>
+ <item>
+ <title>Save on quit</title>
+ <p>Keeps the history at every new session.</p>
+ </item>
+ <item>
+ <title>Store last copied image</title>
+ <p>Allows to store one image in the history.</p>
+ </item>
+ <item>
+ <title>Ignore selections</title>
+ <p>Prevents the primary clipboard from being inserted in the history.</p>
+ </item>
+ <item>
+ <title>Size of the history</title>
+ <p>Sets the number of items to keep in history.</p>
+ </item>
+ </terms>
<figure>
- <title>Clipman Settings (General)</title>
+ <title>General Settings</title>
<desc>Settings dialog with the General tab</desc>
<media type="image" src="media/clipman-settings-general.png" />
</figure>
@@ -148,7 +136,7 @@
<section id="settings-actions">
- <title>Action Settings</title>
+ <title>Actions Settings</title>
<p>
An action is a pair of a name and a regular expression. Each action can have one or more commands. The
support of actions is optional and can be enabled or disabled through the <gui>Enable actions</gui> option.
@@ -162,12 +150,12 @@
To learn more about actions go to <link xref="#action-dialog" />.
</p>
<figure>
- <title>Clipman Settings (Actions)</title>
+ <title>Actions Settings</title>
<desc>Settings dialog with the Actions tab</desc>
<media type="image" src="media/clipman-settings-actions.png" />
</figure>
- <section id="action-dialog">
+ <section id="actions-dialog">
<title>Action Dialog</title>
<p>
@@ -245,6 +233,44 @@
</section>
+ <section id="tweaks">
+
+ <title>Tweaks</title>
+ <p>
+ The following list describes the available options in the <gui>Tweaks</gui> tab of the <gui>Settings</gui> dialog.
+ </p>
+ <terms>
+ <title>List of available Tweaks</title>
+ <item>
+ <title>Paste instantly</title>
+ <p>Automatically paste a selected item from the history to the current focused window.</p>
+ </item>
+ <item>
+ <title>Position menu at mouse pointer</title>
+ <p>Popup the menu at the mouse pointer position, only for the xfce4-popup-clipman command.</p>
+ </item>
+ <item>
+ <title>Reorder history items</title>
+ <p>Push last copied text to the top of the history, useful to reorder old items.</p>
+ </item>
+ <item>
+ <title>Reverse history order</title>
+ <p>Reverse order of the history shown in the menu.</p>
+ </item>
+ <item>
+ <title>Skip actions by holding Control</title>
+ <p>When the selection is done (mouse or keyboard) and the Control key is still pressed down, the
+ popup menu for matched actions will be skipped.</p>
+ </item>
+ </terms>
+ <figure>
+ <title>Tweaks</title>
+ <desc>Settings dialog with the Tweaks tab</desc>
+ <media type="image" src="media/clipman-settings-tweaks.png" />
+ </figure>
+
+ </section>
+
<section id="settings-xfconf">
<title>Xfconf</title>
@@ -256,7 +282,7 @@
</p>
<table rules="cols rowgroups" shade="rows" frame="all">
<title>Xfconf Properties</title>
- <desc>Description of all Xfconf properties with their possible values, some of them are not available in the Settings Dialog</desc>
+ <desc>Description of all Xfconf properties with their possible values</desc>
<thead>
<tr>
<td><p>Property</p></td>
More information about the Xfce4-commits
mailing list