[nautilus-actions] Update NACT user's manual
- From: Pierre Wieser <pwieser src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nautilus-actions] Update NACT user's manual
- Date: Sat, 7 Aug 2010 18:52:53 +0000 (UTC)
commit ba2a620426418c173e8d2377a9d1a97bff78133c
Author: Pierre Wieser <pwieser trychlos org>
Date: Sat Aug 7 20:50:58 2010 +0200
Update NACT user's manual
TODO | 3 +
doc/nact/C/figures/add.png | Bin 448 -> 685 bytes
doc/nact/C/figures/nact-basenames-tab.png | Bin 43269 -> 42631 bytes
doc/nact/C/figures/nact-capabilities-tab.png | Bin 41556 -> 41077 bytes
doc/nact/C/figures/nact-command-tab.png | Bin 48333 -> 49332 bytes
doc/nact/C/figures/nact-environment-tab.png | Bin 64202 -> 63606 bytes
doc/nact/C/figures/nact-execution-tab.png | Bin 43738 -> 42871 bytes
doc/nact/C/figures/nact-folders-tab.png | Bin 43752 -> 43157 bytes
doc/nact/C/figures/nact-legend.png | Bin 23221 -> 27137 bytes
doc/nact/C/figures/nact-mimetypes-tab.png | Bin 42242 -> 41550 bytes
doc/nact/C/figures/nact-preferences-export.png | Bin 17900 -> 18269 bytes
doc/nact/C/figures/nact-preferences-import.png | Bin 21818 -> 21810 bytes
.../C/figures/nact-preferences-io-providers.png | Bin 23686 -> 24044 bytes
doc/nact/C/figures/nact-preferences-runtime.png | Bin 21535 -> 21957 bytes
doc/nact/C/figures/nact-preferences-schemes.png | Bin 20005 -> 20406 bytes
doc/nact/C/figures/nact-preferences-ui.png | Bin 22658 -> 27789 bytes
doc/nact/C/figures/nact-properties-tab.png | Bin 41168 -> 42168 bytes
doc/nact/C/figures/nact-schemes-tab.png | Bin 43163 -> 42468 bytes
doc/nact/C/figures/remove.png | Bin 261 -> 559 bytes
doc/nact/C/nact-edit.xml | 5 +
doc/nact/C/nact-execution.xml | 189 +++++++++
doc/nact/C/nact-export.xml | 5 +
doc/nact/C/nact-import.xml | 5 +
doc/nact/C/nact-menus.xml | 5 +
doc/nact/C/nact-prefs.xml | 110 +++++-
doc/nact/C/nact-profiles.xml | 2 +-
doc/nact/C/nact-save.xml | 5 +
doc/nact/C/nact-starting.xml | 6 +
doc/nact/C/nact-usage.xml | 417 --------------------
doc/nact/C/nact-where.xml | 176 ++++++++
doc/nact/C/nautilus-actions-config-tool.xml | 20 +
doc/nact/Makefile.am | 7 +
32 files changed, 532 insertions(+), 423 deletions(-)
---
diff --git a/TODO b/TODO
index 38ddcce..8f31101 100644
--- a/TODO
+++ b/TODO
@@ -493,3 +493,6 @@ Parameter Description
instead of terminating the edition and letting the old value
- 2010-06-20: TODO: is_candidate_for_show_in: get current environment
+
+- 2010-08-07: review the notification bufferisation
+ + why na_ipivot_consumer_notify is it subject to is_notify_allowed for preferences ?
diff --git a/doc/nact/C/figures/add.png b/doc/nact/C/figures/add.png
index 9f222fc..907e457 100644
Binary files a/doc/nact/C/figures/add.png and b/doc/nact/C/figures/add.png differ
diff --git a/doc/nact/C/figures/nact-basenames-tab.png b/doc/nact/C/figures/nact-basenames-tab.png
index d190ede..d7b6b31 100644
Binary files a/doc/nact/C/figures/nact-basenames-tab.png and b/doc/nact/C/figures/nact-basenames-tab.png differ
diff --git a/doc/nact/C/figures/nact-capabilities-tab.png b/doc/nact/C/figures/nact-capabilities-tab.png
index 455fadb..5e1f2b6 100644
Binary files a/doc/nact/C/figures/nact-capabilities-tab.png and b/doc/nact/C/figures/nact-capabilities-tab.png differ
diff --git a/doc/nact/C/figures/nact-command-tab.png b/doc/nact/C/figures/nact-command-tab.png
index 3500601..a5de737 100644
Binary files a/doc/nact/C/figures/nact-command-tab.png and b/doc/nact/C/figures/nact-command-tab.png differ
diff --git a/doc/nact/C/figures/nact-environment-tab.png b/doc/nact/C/figures/nact-environment-tab.png
index dd301f5..64ab4fd 100644
Binary files a/doc/nact/C/figures/nact-environment-tab.png and b/doc/nact/C/figures/nact-environment-tab.png differ
diff --git a/doc/nact/C/figures/nact-execution-tab.png b/doc/nact/C/figures/nact-execution-tab.png
index 053904c..de64927 100644
Binary files a/doc/nact/C/figures/nact-execution-tab.png and b/doc/nact/C/figures/nact-execution-tab.png differ
diff --git a/doc/nact/C/figures/nact-folders-tab.png b/doc/nact/C/figures/nact-folders-tab.png
index 16ffa67..86c4ca2 100644
Binary files a/doc/nact/C/figures/nact-folders-tab.png and b/doc/nact/C/figures/nact-folders-tab.png differ
diff --git a/doc/nact/C/figures/nact-legend.png b/doc/nact/C/figures/nact-legend.png
index 8ad5ff5..412e25c 100644
Binary files a/doc/nact/C/figures/nact-legend.png and b/doc/nact/C/figures/nact-legend.png differ
diff --git a/doc/nact/C/figures/nact-mimetypes-tab.png b/doc/nact/C/figures/nact-mimetypes-tab.png
index 1dea349..fc2daf4 100644
Binary files a/doc/nact/C/figures/nact-mimetypes-tab.png and b/doc/nact/C/figures/nact-mimetypes-tab.png differ
diff --git a/doc/nact/C/figures/nact-preferences-export.png b/doc/nact/C/figures/nact-preferences-export.png
index d5448a7..11217ba 100644
Binary files a/doc/nact/C/figures/nact-preferences-export.png and b/doc/nact/C/figures/nact-preferences-export.png differ
diff --git a/doc/nact/C/figures/nact-preferences-import.png b/doc/nact/C/figures/nact-preferences-import.png
index 3fb3082..d98b1d3 100644
Binary files a/doc/nact/C/figures/nact-preferences-import.png and b/doc/nact/C/figures/nact-preferences-import.png differ
diff --git a/doc/nact/C/figures/nact-preferences-io-providers.png b/doc/nact/C/figures/nact-preferences-io-providers.png
index ea684a0..903e0d3 100644
Binary files a/doc/nact/C/figures/nact-preferences-io-providers.png and b/doc/nact/C/figures/nact-preferences-io-providers.png differ
diff --git a/doc/nact/C/figures/nact-preferences-runtime.png b/doc/nact/C/figures/nact-preferences-runtime.png
index 8ead757..0af8447 100644
Binary files a/doc/nact/C/figures/nact-preferences-runtime.png and b/doc/nact/C/figures/nact-preferences-runtime.png differ
diff --git a/doc/nact/C/figures/nact-preferences-schemes.png b/doc/nact/C/figures/nact-preferences-schemes.png
index d7c106c..c2bfdd1 100644
Binary files a/doc/nact/C/figures/nact-preferences-schemes.png and b/doc/nact/C/figures/nact-preferences-schemes.png differ
diff --git a/doc/nact/C/figures/nact-preferences-ui.png b/doc/nact/C/figures/nact-preferences-ui.png
index 4304f97..350f237 100644
Binary files a/doc/nact/C/figures/nact-preferences-ui.png and b/doc/nact/C/figures/nact-preferences-ui.png differ
diff --git a/doc/nact/C/figures/nact-properties-tab.png b/doc/nact/C/figures/nact-properties-tab.png
index 25ced31..b7f28f3 100644
Binary files a/doc/nact/C/figures/nact-properties-tab.png and b/doc/nact/C/figures/nact-properties-tab.png differ
diff --git a/doc/nact/C/figures/nact-schemes-tab.png b/doc/nact/C/figures/nact-schemes-tab.png
index 47c3867..4f1d0f5 100644
Binary files a/doc/nact/C/figures/nact-schemes-tab.png and b/doc/nact/C/figures/nact-schemes-tab.png differ
diff --git a/doc/nact/C/figures/remove.png b/doc/nact/C/figures/remove.png
index a12ec4a..4a342d8 100644
Binary files a/doc/nact/C/figures/remove.png and b/doc/nact/C/figures/remove.png differ
diff --git a/doc/nact/C/nact-edit.xml b/doc/nact/C/nact-edit.xml
new file mode 100644
index 0000000..9323acf
--- /dev/null
+++ b/doc/nact/C/nact-edit.xml
@@ -0,0 +1,5 @@
+<sect2 id="usage-edit">
+ <title>Editing</title>
+ <para>
+ </para>
+</sect2>
diff --git a/doc/nact/C/nact-execution.xml b/doc/nact/C/nact-execution.xml
new file mode 100644
index 0000000..46124ce
--- /dev/null
+++ b/doc/nact/C/nact-execution.xml
@@ -0,0 +1,189 @@
+<sect2 id="usage-execution">
+ <title>What the action should it execute ?</title>
+ <para>
+ You most probably want your action eventually ends up with
+ executing something. As a matter of fact, having something
+ to execute is one of the few conditions which are required
+ in order an action be considered as valid.
+ </para>
+ <para>
+ Enter the command you wish to execute in the <guilabel>Path</guilabel>
+ entry box. Or click on <guibutton>Browse</guibutton> to
+ select a file on the filesystem.
+ </para>
+ <para>
+ Enter the parameters of your command in the
+ <guilabel>Parameters</guilabel> entry box.
+ </para>
+ <para>
+ The <guibutton>Legend</guibutton> button has a toggling action:
+ click once to display the <guilabel>Parameter Legend</guilabel>
+ dialog box; click a second time to hide it.
+ </para>
+ <figure id="nact-FIG-legend">
+ <title>List of available parameters</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-legend.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the list of available parameters.</phrase>
+ </textobject>
+ <caption>
+ <para>The available parameters</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <sect3 id="usage-execution-work">
+ <title>Where the action should it be executed ?</title>
+ <para>
+ Your action may be executed in a particular working directory.
+ You may specify it in the <guilabel>Command</guilabel> tab, in the
+ <guilabel>Working directory</guilabel> entry box, or by clicking
+ on <guibutton>Browse</guibutton> to select a folder on the
+ filesystem.
+ </para>
+ <para>
+ The working directory defaults to <literal>%d</literal>, which runs
+ the command in the base directory of the first selected item.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-execution-how">
+ <title>How the action should it be executed ?</title>
+ <figure id="nact-FIG-execution">
+ <title>Configuration of the execution mode</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-execution-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows how to configure the execution mode of a command.</phrase>
+ </textobject>
+ <caption>
+ <para>Configuration of the execution mode</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <sect4 id="usage-execution-how-mode">
+ <title>Specifying the execution mode</title>
+ <para>
+ The execution mode of your command may be choosen between following
+ values:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ Normal
+ </term>
+ <listitem>
+ <para>
+ Starts the command as a standard graphical user interface.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Terminal
+ </term>
+ <listitem>
+ <para>
+ Starts the preferred terminal of the desktop environment,
+ and runs the command in it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Embedded
+ </term>
+ <listitem>
+ <para>
+ Makes use of a special feature of the file manager which may allow
+ a terminal to be ran in it.
+ </para>
+ <para>
+ As &nautilus; does not have this feature, this option is strictly
+ equivalent to <literal>Terminal</literal> option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Display output
+ </term>
+ <listitem>
+ <para>
+ Starts the preferred terminal of the desktop environment, and
+ runs the command in it. At end, standard streams (stdout, stderr)
+ are collected and displayed.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ The execution mode of a command defaults to <literal>Normal</literal>.
+ That is, the command is executed without any particular pre- or
+ post-work.
+ </para>
+ </sect4>
+
+ <sect4 id="usage-execution-how-notify">
+ <title>Specifying the startup notification</title>
+ <para>
+ If the execution mode of the command is actually <literal>Normal</literal>,
+ and if you know that the application will send a <literal>remove</literal>
+ message with the <envar>DESKTOP_STARTUP_ID</envar> environment variable set,
+ then check the <guilabel>Startup notify</guilabel> checkbox.
+ </para>
+ <para>
+ See the
+ <ulink url="http://www.freedesktop.org/Standards/startup-notification-spec"; type="http">
+ <citetitle>Startup Notification Protocol Specification</citetitle></ulink>
+ for more details.
+ </para>
+ </sect4>
+
+ <sect4 id="usage-execution-how-class">
+ <title>Specifying the window class</title>
+ <para>
+ If the execution mode of the command is actually <literal>Normal</literal>,
+ and if you know that the application will map at least one window with a
+ given class name,
+ then enter that name into the <guilabel>Startup Window Manager class</guilabel>
+ entry box.
+ </para>
+ <para>
+ See the
+ <ulink url="http://www.freedesktop.org/Standards/startup-notification-spec"; type="http">
+ <citetitle>Startup Notification Protocol Specification</citetitle></ulink>
+ for more details.
+ </para>
+ </sect4>
+
+ <sect4 id="usage-execution-how-user">
+ <title>Specifying the owner of the execution</title>
+ <para>
+ Enter in the <guilabel>Execute as user</guilabel> entry box the username
+ or the <acronym>UID</acronym> of the user your command must be ran as.
+ </para>
+ <para>
+ If you do not enter anything in this field, then the command will be
+ executed as the current user.
+ </para>
+ </sect4>
+
+ <sect4 id="usage-execution-how-singular">
+ <title>Multiple execution</title>
+ <para>
+ </para>
+ </sect4>
+ </sect3>
+
+</sect2>
diff --git a/doc/nact/C/nact-export.xml b/doc/nact/C/nact-export.xml
new file mode 100644
index 0000000..20d8e68
--- /dev/null
+++ b/doc/nact/C/nact-export.xml
@@ -0,0 +1,5 @@
+<sect2 id="usage-export">
+ <title>Exporting your actions</title>
+ <para>
+ </para>
+</sect2>
diff --git a/doc/nact/C/nact-import.xml b/doc/nact/C/nact-import.xml
new file mode 100644
index 0000000..14d6058
--- /dev/null
+++ b/doc/nact/C/nact-import.xml
@@ -0,0 +1,5 @@
+<sect2 id="usage-import">
+ <title>Importing actions</title>
+ <para>
+ </para>
+</sect2>
diff --git a/doc/nact/C/nact-menus.xml b/doc/nact/C/nact-menus.xml
new file mode 100644
index 0000000..5204198
--- /dev/null
+++ b/doc/nact/C/nact-menus.xml
@@ -0,0 +1,5 @@
+<sect2 id="usage-menus">
+ <title>Organizing actions in menus</title>
+ <para>
+ </para>
+</sect2>
diff --git a/doc/nact/C/nact-prefs.xml b/doc/nact/C/nact-prefs.xml
index b571446..203c660 100644
--- a/doc/nact/C/nact-prefs.xml
+++ b/doc/nact/C/nact-prefs.xml
@@ -1,38 +1,138 @@
<sect2 id="usage-prefs">
<title>Setting your own preferences</title>
+ <para>
+ Choose
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Preferences</guimenuitem>
+ </menuchoice>
+ to access to the configuration of your preferences.
+ </para>
<sect3 id="usage-prefs-runtime">
<title>Runtime preferences</title>
- <para>
- </para>
+ <figure id="nact-FIG-prefs-runtime">
+ <title>Runtime preferences</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-preferences-runtime.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define runtime preferences.</phrase>
+ </textobject>
+ <caption>
+ <para>Runtime preferences</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
</sect3>
<sect3 id="usage-prefs-ui">
- <title>UI preferences</title>
- <para>
- </para>
+ <title>User interface preferences</title>
+ <figure id="nact-FIG-prefs-ui">
+ <title>UI preferences</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-preferences-ui.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define UI preferences.</phrase>
+ </textobject>
+ <caption>
+ <para>UI preferences</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
</sect3>
<sect3 id="usage-prefs-import">
<title>Import preferences</title>
+ <figure id="nact-FIG-prefs-import">
+ <title>Import preferences</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-preferences-import.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define import preferences.</phrase>
+ </textobject>
+ <caption>
+ <para>Import preferences</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
<para>
</para>
</sect3>
<sect3 id="usage-prefs-export">
<title>Export preferences</title>
+ <figure id="nact-FIG-prefs-export">
+ <title>Export preferences</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-preferences-export.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define export preferences.</phrase>
+ </textobject>
+ <caption>
+ <para>Export preferences</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
<para>
</para>
</sect3>
<sect3 id="usage-prefs-schemes">
<title>Schemes preferences</title>
+ <figure id="nact-FIG-prefs-schemes">
+ <title>Schemes preferences</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-preferences-schemes.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define schemes preferences.</phrase>
+ </textobject>
+ <caption>
+ <para>Schemes preferences</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
<para>
</para>
</sect3>
<sect3 id="usage-prefs-providers">
<title>I/O providers preferences</title>
+ <figure id="nact-FIG-prefs-io-providers">
+ <title>I/O providers preferences</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-preferences-io-providers.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define I/O providers preferences.</phrase>
+ </textobject>
+ <caption>
+ <para>I/O providers preferences</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
<para>
</para>
</sect3>
diff --git a/doc/nact/C/nact-profiles.xml b/doc/nact/C/nact-profiles.xml
index fad0701..12dccf2 100644
--- a/doc/nact/C/nact-profiles.xml
+++ b/doc/nact/C/nact-profiles.xml
@@ -1,5 +1,5 @@
<sect2 id="usage-profile">
- <title>Defining several profiles</title>
+ <title>Using profiles to extend your action</title>
<para>
There is some situations where you will want a given action behave
slightly differently depending on the currently selected items or
diff --git a/doc/nact/C/nact-save.xml b/doc/nact/C/nact-save.xml
new file mode 100644
index 0000000..0864aca
--- /dev/null
+++ b/doc/nact/C/nact-save.xml
@@ -0,0 +1,5 @@
+<sect2 id="usage-save">
+ <title>Saving your modifications</title>
+ <para>
+ </para>
+</sect2>
diff --git a/doc/nact/C/nact-starting.xml b/doc/nact/C/nact-starting.xml
index d19d15e..315a60a 100644
--- a/doc/nact/C/nact-starting.xml
+++ b/doc/nact/C/nact-starting.xml
@@ -495,6 +495,12 @@
of the action as you want it to be displayed in the file manager
context menu.
</para>
+ <para>
+ The label is a mandatory property of your action. If it happens
+ to be empty, then your action will be considered as invalid by
+ &prodname;, and will never be candidate to be displayed in the
+ file-manager context menus.
+ </para>
</listitem>
<listitem>
<para>
diff --git a/doc/nact/C/nact-where.xml b/doc/nact/C/nact-where.xml
new file mode 100644
index 0000000..2489ca6
--- /dev/null
+++ b/doc/nact/C/nact-where.xml
@@ -0,0 +1,176 @@
+<sect2 id="usage-where">
+ <title>Locating the action</title>
+ <para>
+ &nautilus; file-manager may display your custom action in different places,
+ depending on you will request here, and if some item is currently selected.
+ </para>
+
+ <sect3 id="usage-where-selection">
+ <title>Targeting the selection context menu</title>
+ <para>
+ When <guilabel>Display item in selection context menu</guilabel> checkbox
+ is activated, then your action will be candidate to be displayed in
+ &nautilus; context menu, as long as at least one item is selected in
+ the file-manager. Your action will so deal with currently selected
+ item(s).
+ </para>
+ <tip>
+ <para>
+ When an action targets the selection context menu, and is actually
+ displayed in &nautilus; context menu, then it is also displayed
+ in the <guimenu>Edit</guimenu> menu.
+ </para>
+ </tip>
+ <para>
+ This checkbox is activated by default.
+ </para>
+ <para>
+ When targeting the selection context menu, and in order to be
+ actually displayed, all the conditions defined in
+ your candidate action must be met by each item currently selected
+ in the &nautilus; file-manager.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-where-location">
+ <title>Targeting the location context menu</title>
+ <para>
+ When <guilabel>Display item in location context menu</guilabel> checkbox
+ is activated, then your action will be candidate to be displayed in
+ &nautilus; context menu, when the file-manager selection will be empty.
+ Your action will so deal with currently displayed location.
+ </para>
+ <tip>
+ <para>
+ When an action targets the location context menu, and is actually
+ displayed in &nautilus; context menu, then it is also displayed
+ in the <guimenu>File</guimenu> menu.
+ </para>
+ </tip>
+ <para>
+ When targeting the location context menu, and in order to be
+ actually displayed, all the conditions defined in
+ your candidate action must be met by the location currently displayed
+ in the &nautilus; file-manager.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-where-toolbar">
+ <title>Targeting the toolbar</title>
+ <para>
+ When <guilabel>Display item in the toolbar</guilabel> checkbox
+ is activated, then your action will be candidate to be displayed in
+ &nautilus; toolbar.
+ </para>
+ <para>
+ Actions displayed in the toolbar only deal with the location which
+ is currently displayed in the file-manager, not with the items which
+ may be currently selected (or not). In order to be displayed, all the
+ conditions defined in your candidate action must so be met by the
+ current location.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-where-notes">
+ <title>Notes</title>
+
+ <formalpara>
+ <title>If your action targets a menu</title>
+ <para>
+ Whether your action targets the selection context menu or the location
+ context menu, and both in &nautilus; context menus that in
+ <guimenu>File</guimenu> or <guimenu>Edit</guimenu> menus, your
+ action will be displayed as
+ </para>
+ </formalpara>
+ <itemizedlist>
+ <listitem>
+ <para>
+ the <guilabel>Context label</guilabel> as a label,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the <guilabel>Icon</guilabel>,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ those two properties being associated with the
+ <guilabel>Tooltip</guilabel>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>
+ Depending of the exact configuration of your desktop environment,
+ the icon may or may not be displayed in front of the label in
+ the menu.
+ </para>
+ </note>
+ <tip>
+ <para>
+ You may embed some parameters in the label, the icon name of the tooltip.
+ These parameters will be dynamically substituted at runtime with values
+ which will depend of currently selected item(s).
+ </para>
+ </tip>
+
+ <formalpara>
+ <title>If your action targets the toolbar</title>
+ <para>
+ In the toolbar, your action will be displayed as
+ </para>
+ </formalpara>
+ <itemizedlist>
+ <listitem>
+ <para>
+ the <guilabel>Toolbar label</guilabel> as a label,
+ </para>
+ <tip>
+ <para>
+ The toolbar label defaults to the same label than
+ those used in menus. By unchecking the
+ <guilabel>Use same label for icon in the toolbar</guilabel>
+ checkbox, then you can define a label specific to the
+ toolbar, usually shorter those defined for the menus.
+ </para>
+ </tip>
+ </listitem>
+ <listitem>
+ <para>
+ the <guilabel>Icon</guilabel>,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ associated with the <guilabel>Tooltip</guilabel>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>
+ Depending of the exact configuration of your desktop environment,
+ the toolbar label may or may not be displayed in front of the icon
+ in the toolbar.
+ </para>
+ </note>
+ <tip>
+ <para>
+ You may embed some parameters in the toolbar label, the icon name of the tooltip.
+ These parameters will be dynamically substituted at runtime with values
+ which will depend of currently selected item(s).
+ </para>
+ </tip>
+
+ <formalpara>
+ <title>Defining several targets</title>
+ <para>
+ An action may target both the selection context menu, the location context
+ menu and the toolbar, or one or more among these. If no target is defined,
+ <abbrev>i.e.</abbrev> if the three checkboxes are unchecked, then your action
+ will never be displayed.
+ </para>
+ </formalpara>
+ </sect3>
+</sect2>
diff --git a/doc/nact/C/nautilus-actions-config-tool.xml b/doc/nact/C/nautilus-actions-config-tool.xml
index 7289a9d..70f73e4 100644
--- a/doc/nact/C/nautilus-actions-config-tool.xml
+++ b/doc/nact/C/nautilus-actions-config-tool.xml
@@ -21,8 +21,15 @@
<!ENTITY legalnotice SYSTEM "legalnotice.xml">
<!ENTITY starting SYSTEM "nact-starting.xml">
<!ENTITY conditions SYSTEM "nact-conditions.xml">
+ <!ENTITY where SYSTEM "nact-where.xml">
+ <!ENTITY execution SYSTEM "nact-execution.xml">
<!ENTITY profiles SYSTEM "nact-profiles.xml">
+ <!ENTITY menus SYSTEM "nact-menus.xml">
<!ENTITY sorting SYSTEM "nact-sorting.xml">
+ <!ENTITY edit SYSTEM "nact-edit.xml">
+ <!ENTITY save SYSTEM "nact-save.xml">
+ <!ENTITY export SYSTEM "nact-export.xml">
+ <!ENTITY import SYSTEM "nact-import.xml">
<!ENTITY preferences SYSTEM "nact-prefs.xml">
<!ENTITY misc-infos SYSTEM "nact-misc.xml">
<!ENTITY gnu-fdl SYSTEM "appendix-gnu-fdl-1.3.xml">
@@ -136,8 +143,15 @@
<sect1 id="usage">
<title>Using &appname;</title>
&conditions;
+ &where;
+ &execution;
&profiles;
+ &menus;
&sorting;
+ &edit;
+ &save;
+ &export;
+ &import;
&preferences;
</sect1>
@@ -181,6 +195,12 @@
Pierre Wieser (<email>pwieser trychlos org</email>).
</para>
<para>
+ Artwork is due to courtesy of
+ Ulisse Perusin (<email>uli peru gmail com</email>) and
+ DragonArtz
+ (<ulink url="http://www.dragonartz.net/"; type="http">http://www.dragonartz.net</ulink>).
+ </para>
+ <para>
To find more information about &prodname;, please visit the
<ulink url="http://www.nautilus-actions.org/"; type="http">
&prodname; website</ulink>.
diff --git a/doc/nact/Makefile.am b/doc/nact/Makefile.am
index 98ef918..2eb3a9b 100644
--- a/doc/nact/Makefile.am
+++ b/doc/nact/Makefile.am
@@ -40,11 +40,18 @@ DOC_ENTITIES = \
articleinfo.xml \
legalnotice.xml \
nact-conditions.xml \
+ nact-edit.xml \
+ nact-execution.xml \
+ nact-export.xml \
+ nact-import.xml \
+ nact-menus.xml \
nact-misc.xml \
nact-prefs.xml \
nact-profiles.xml \
+ nact-save.xml \
nact-sorting.xml \
nact-starting.xml \
+ nact-where.xml \
$(NULL)
DOC_INCLUDES = \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
