[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: Mon, 9 Aug 2010 22:11:12 +0000 (UTC)
commit e7825c850c542eda79c9a14c7d01d41a4a2975a8
Author: Pierre Wieser <pwieser trychlos org>
Date: Tue Aug 10 00:10:34 2010 +0200
Update NACT user's manual
doc/nact/C/nact-bugs.xml | 58 +++++
doc/nact/C/nact-conditions.xml | 64 ++++--
doc/nact/C/nact-execution.xml | 320 +++++++++++++++++++++++++--
doc/nact/C/nact-starting.xml | 50 ++++-
doc/nact/C/nact-where.xml | 90 +++++----
doc/nact/C/nautilus-actions-config-tool.xml | 10 +-
doc/nact/Makefile.am | 1 +
7 files changed, 510 insertions(+), 83 deletions(-)
---
diff --git a/doc/nact/C/nact-bugs.xml b/doc/nact/C/nact-bugs.xml
new file mode 100644
index 0000000..a9b160c
--- /dev/null
+++ b/doc/nact/C/nact-bugs.xml
@@ -0,0 +1,58 @@
+<sect2 id="bugs-bugs">
+ <title>Known bugs</title>
+ <para>
+ Known bugs are available on
+ <ulink url="https://bugzilla.gnome.org/buglist.cgi?product=nautilus-actions&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED"; type="http">Bugzilla summary page</ulink>.
+ </para>
+ <para>
+ If you find some new bug in &prodname;, you are welcome to open it by pointing
+ your favorite browser to
+ <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=nautilus-actions"; type="http">Bugzilla web site</ulink>.
+ </para>
+
+ <formalpara>
+ <title><ulink url="https://bugzilla.gnome.org/show_bug.cgi?id=616532"; type="http">#616532</ulink> Directory selection</title>
+ <para>
+ When you're browsing the folder you want to export to in the &appname;'s
+ export assistant you can't select it as the directory to export to.
+ Instead you have to go to the directory a level up and select the directory
+ you want to export to there.
+ </para>
+ </formalpara>
+</sect2>
+
+<sect2 id="bugs-limits">
+ <title>Known limitations</title>
+
+ <formalpara>
+ <title>Execution mode</title>
+ <para>
+ As of version 3.0, execution mode may be configured in &appname; but is
+ not yet honored by &nautilus; plugin.
+ </para>
+ </formalpara>
+ <para>
+ This concern working directory, execution mode, startup notification and
+ execution's owner parameters.
+ </para>
+
+ <formalpara>
+ <title>Suggested shortcut</title>
+ <para>
+ As of version 3.0, suggested shortcut, as described in &desema; cannot be
+ configured in &appname;, and is not honored by &nautilus; plugin.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Menu separator</title>
+ <para>
+ As of version 3.0, menu separators cannot be
+ configured in &appname;, and are not honored by &nautilus; plugin.
+ </para>
+ <para>
+ One has to note that, for now, &nautilus; file manager does not
+ allow its plugins to define separators in the context menu.
+ </para>
+ </formalpara>
+</sect2>
\ No newline at end of file
diff --git a/doc/nact/C/nact-conditions.xml b/doc/nact/C/nact-conditions.xml
index 81121b8..001faf1 100644
--- a/doc/nact/C/nact-conditions.xml
+++ b/doc/nact/C/nact-conditions.xml
@@ -434,13 +434,37 @@
<listitem>
<para>
Or click on
- <guibutton>Common</guibutton> to select a scheme among these
- defined as default schemes in
+ <guibutton>Common</guibutton> to select a scheme among those
+ predefined in
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Preferences</guimenuitem>
</menuchoice>.
</para>
+ <figure id="nact-FIG-add-scheme">
+ <title>Selecting a scheme among predefined defaults</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-new-scheme.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Show the list of predefined schemess.</phrase>
+ </textobject>
+ <caption>
+ <para>Selecting a scheme among predefined defaults</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ A new scheme may only be selected here if it is not already
+ defined as a scheme filter.
+ </para>
+ <para>
+ To select a new scheme, click <guibutton>OK</guibutton>, or
+ double-click on the desired row.
+ </para>
</listitem>
</itemizedlist>
</listitem>
@@ -546,6 +570,14 @@
</mediaobject>
</screenshot>
</figure>
+ <para>
+ A new capability may only be selected here if it is not already
+ defined as a capability filter.
+ </para>
+ <para>
+ To select a new capability, click <guibutton>OK</guibutton>, or
+ double-click on the desired row.
+ </para>
</listitem>
</itemizedlist>
</listitem>
@@ -609,7 +641,7 @@
<para>
If your action consists in displaying the differences between
two files, you may define here
- <guilabel>Count = (equal to) 2</guilabel>.
+ «sp;<literal>Count = (equal to) 2</literal>&spraquo;.
</para>
</example>
<para>
@@ -668,7 +700,7 @@
</listitem>
</itemizedlist>
<para>
- Only one of three choices is authorized.
+ Only one choice between these three items is possible.
</para>
<para>
To define the desktop environment condition:
@@ -681,15 +713,15 @@
<simplelist type="vert">
<member>does your action should always appear, regarding of
the desktop environment ?</member>
- <member>does your action should also appear in some desktop
+ <member>does your action should only appear in some desktop
environment(s) ?</member>
- <member>does your action should never appeat in some
+ <member>does your action should never appear in some
desktop environment(s) ?</member>
</simplelist>
</listitem>
<listitem>
<para>
- If your action does not should always appear, then
+ If your action should not always appear, then
select the relevant desktop environment(s) in the listbox
in the right side.
</para>
@@ -697,7 +729,7 @@
</orderedlist>
<para>
The target desktop environment condition defaults to
- «sp;<guilabel>Always appear</guilabel>&spraquo;,
+ «sp;<literal>Always appear</literal>&spraquo;,
which means that the action will be candidate to be displayed
regarding of the current desktop environment.
</para>
@@ -710,8 +742,10 @@
which will permit you to configure your environment-based conditions.
</para>
<para>
- You may define that your action will only appear in some given
- file is present on the filesystem and is executable.
+ You may define that your action will only appear if some
+ prerequisite package is installed on your system. This is
+ checked here by specifying that a specific file from the
+ package must be present on the filesystem and executable.
</para>
<para>
To define the relevant file, enter its full filename in the
@@ -725,7 +759,7 @@
</para>
<tip>
<para>
- You may embed some parameters in the searched filename or its options.
+ You may embed some parameters in the searched filename.
These parameters will be dynamically substituted at runtime with values
which will depend of currently selected item(s).
</para>
@@ -739,7 +773,7 @@
which will permit you to configure your environment-based conditions.
</para>
<para>
- You may define that your action will only appear in some given
+ You may define that your action will only appear if some given
name is registered on D-Bus system at runtime.
</para>
<para>
@@ -767,13 +801,13 @@
which will permit you to configure your environment-based conditions.
</para>
<para>
- You may define that your action will only appear in some given
+ You may define that your action will only appear if some given
command outputs a <literal>true</literal> string.
</para>
<para>
This lets you define your own customized condition filter,
by writing a small script which outputs, or not, the
- <literal>true</literal> string when it is ran.
+ <literal>true</literal> string on stdout when it is ran.
</para>
<para>
To define the command, enter it in the
@@ -800,7 +834,7 @@
which will permit you to configure your environment-based conditions.
</para>
<para>
- You may define that your action will only appear in some given
+ You may define that your action will only appear if some given
binary is currently running.
</para>
<para>
diff --git a/doc/nact/C/nact-execution.xml b/doc/nact/C/nact-execution.xml
index 46124ce..ec6a1fc 100644
--- a/doc/nact/C/nact-execution.xml
+++ b/doc/nact/C/nact-execution.xml
@@ -2,23 +2,22 @@
<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
+ executing something. And, 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.
+ As we have already seen, the command to be executed is configured
+ in the <guilabel>Command</guilabel> page.
</para>
<para>
- Enter the parameters of your command in the
- <guilabel>Parameters</guilabel> entry box.
+ This command may take arguments, which themselves may embed
+ parameters. These parameters will be expanded at runtime,
+ with values which will depend of currently selected item(s).
</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.
+ In the <guilabel>Command</guilabel> page, click on <guilabel>Legend</guilabel>
+ button to see the list of available parameters.
</para>
<figure id="nact-FIG-legend">
<title>List of available parameters</title>
@@ -36,6 +35,26 @@
</mediaobject>
</screenshot>
</figure>
+ <tip>
+ <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>
+ </tip>
+ <note>
+ <para>
+ the word «sp;<guilabel>first</guilabel>&spraquo; may be misleading
+ as it only refers to the list of selected items as provided by the file
+ manager to the &prodname; plugin.
+ </para>
+ <para>
+ In particular, it has nothing to do with the visual selection you may
+ have done in the file manager window. And, in fact, which is the
+ «sp;<guilabel>first</guilabel>&spraquo; selected item in a
+ multiple selection is absolutly undefined and rather unpredictable.
+ </para>
+ </note>
<sect3 id="usage-execution-work">
<title>Where the action should it be executed ?</title>
@@ -48,7 +67,13 @@
</para>
<para>
The working directory defaults to <literal>%d</literal>, which runs
- the command in the base directory of the first selected item.
+ the command in the base directory of the (first) selected item.
+ </para>
+ <para>
+ In the particular case of the <literal>%d</literal> parameter,
+ which is the «sp;<guilabel>first</guilabel>&spraquo; selected item
+ is not very important: we are rather sure that all selected items
+ are located in the same base directory.
</para>
</sect3>
@@ -72,7 +97,7 @@
</figure>
<sect4 id="usage-execution-how-mode">
- <title>Specifying the execution mode</title>
+ <title>Execution mode</title>
<para>
The execution mode of your command may be choosen between following
values:
@@ -135,9 +160,9 @@
</sect4>
<sect4 id="usage-execution-how-notify">
- <title>Specifying the startup notification</title>
+ <title>Startup notification</title>
<para>
- If the execution mode of the command is actually <literal>Normal</literal>,
+ If the execution mode of the command is <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.
@@ -151,9 +176,9 @@
</sect4>
<sect4 id="usage-execution-how-class">
- <title>Specifying the window class</title>
+ <title>Window class</title>
<para>
- If the execution mode of the command is actually <literal>Normal</literal>,
+ If the execution mode of the command is <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>
@@ -168,7 +193,7 @@
</sect4>
<sect4 id="usage-execution-how-user">
- <title>Specifying the owner of the execution</title>
+ <title>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.
@@ -182,8 +207,269 @@
<sect4 id="usage-execution-how-singular">
<title>Multiple execution</title>
<para>
+ You may want your command be executed once, giving it the list of
+ selected items as argument.
</para>
- </sect4>
+ <para>
+ Or you may prefer your command be repeated for each selected item,
+ giving to each execution a different item as argument.
+ </para>
+ <para>
+ Actually, the command will be executed once, or repeated for each
+ selected item, depending of the form of arguments.
+ </para>
+ <para>
+ Though some parameters are not sensible to the count of the
+ selection (<abbrev>e.g.</abbrev> «sp;<literal>%c</literal>&spraquo;,
+ the selection count itself), most have two declensions:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ a «sp;singular&spraquo; one, <abbrev>e.g.</abbrev>
+ «sp;<literal>%b</literal>&spraquo;,
+ the basename of the selected item;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ a «sp;plural&spraquo; one, <abbrev>e.g.</abbrev>
+ «sp;<literal>%B</literal>&spraquo;,
+ the space-separated list of the basenames of selected items.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ When the selection is empty or contains only one element,
+ and from this topic point of view, these two forms are exactly equivalent.
+ </para>
+ <para>
+ When the selection contains more than one item:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ if the first relevant parameter is of a singular form,
+ then &prodname; will consider that the command is only able to deal
+ with one item at a time, and thus that it has to be ran one time for
+ each selected item;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ contrarily, if the first relevant parameter found is of the plural form,
+ then &prodname; will consider that the command is able to deal with a
+ list of items, and thus the command will be executed only once;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ if all found parameters are irrelevant, then &prodname; defaults
+ to consider that the command should be executed only once.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <table id="nact-TAB-multiple-execution" frame="all" tocentry="1">
+ <title>Characterization of the parameters <abbrev>vs.</abbrev> multiple execution</title>
+ <tgroup cols="5">
+ <colspec align="center" colwidth="*" />
+ <colspec align="left" colwidth="5*" />
+ <colspec align="center" colwidth="*" colname="c3"/>
+ <colspec align="center" colwidth="*" />
+ <colspec align="center" colwidth="*" colname="c5"/>
+ <thead>
+ <row>
+ <entry>Parameter</entry>
+ <entry>Description</entry>
+ <entry namest="c3" nameend="c5">Said form</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>%b</literal></entry>
+ <entry>(first) basename</entry>
+ <entry>singular</entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%B</literal></entry>
+ <entry>space-separated list of basenames</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>plural</entry>
+ </row>
+ <row>
+ <entry><literal>%c</literal></entry>
+ <entry>count of selected items</entry>
+ <entry></entry>
+ <entry>irrelevant</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%d</literal></entry>
+ <entry>(first) base directory</entry>
+ <entry>singular</entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%D</literal></entry>
+ <entry>space-separated list of base directory of each selected items</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>plural</entry>
+ </row>
+ <row>
+ <entry><literal>%f</literal></entry>
+ <entry>(first) file name</entry>
+ <entry>singular</entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%F</literal></entry>
+ <entry>space-separated list of selected file names</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>plural</entry>
+ </row>
+ <row>
+ <entry><literal>%h</literal></entry>
+ <entry>hostname of the (first) URI</entry>
+ <entry></entry>
+ <entry>irrelevant</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%m</literal></entry>
+ <entry>mimetype of the (first) selected item</entry>
+ <entry>singular</entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%M</literal></entry>
+ <entry>space-separated list of the mimetypes of the selected items</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>plural</entry>
+ </row>
+ <row>
+ <entry><literal>%n</literal></entry>
+ <entry>username of the (first) URI</entry>
+ <entry></entry>
+ <entry>irrelevant</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%p</literal></entry>
+ <entry>port number of the (first) URI</entry>
+ <entry></entry>
+ <entry>irrelevant</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%s</literal></entry>
+ <entry>scheme of the (first) URI</entry>
+ <entry></entry>
+ <entry>irrelevant</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%u</literal></entry>
+ <entry>(first) URI</entry>
+ <entry>singular</entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%U</literal></entry>
+ <entry>space-separated list of selected URIs</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>plural</entry>
+ </row>
+ <row>
+ <entry><literal>%w</literal></entry>
+ <entry>(first) basename without the extension</entry>
+ <entry>singular</entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%W</literal></entry>
+ <entry>space-separated list of basenames without their extension</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>plural</entry>
+ </row>
+ <row>
+ <entry><literal>%x</literal></entry>
+ <entry>(first) extension</entry>
+ <entry>singular</entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>%X</literal></entry>
+ <entry>space-separated list of extensions</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>plural</entry>
+ </row>
+ <row>
+ <entry><literal>%%</literal></entry>
+ <entry>the «sp;<literal>%</literal>&spraquo; character</entry>
+ <entry></entry>
+ <entry>irrelevant</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <example>
+ <title>Usage of singular <abbrev>vs.</abbrev> plural forms</title>
+ <para>
+ Say the current folder is <filename>/data</filename>,
+ and the current selection contains the three files
+ <filename>pierre</filename>, <filename>paul</filename>
+ and <filename>jacques</filename>.
+ </para>
+ <para>
+ If we have requested <literal>echo %b</literal>,
+ then the following commands will be run:
+ </para>
+ <simplelist>
+ <member><command>echo pierre</command></member>
+ <member><command>echo paul</command></member>
+ <member><command>echo jacques</command></member>
+ </simplelist>
+ <para>
+ Contrarily, if we have requester <literal>echo %B</literal>,
+ then the following command will be run:
+ </para>
+ <simplelist>
+ <member><command>echo pierre paul jacques</command></member>
+ </simplelist>
+ <para>
+ If we have requested <literal>echo %b %B</literal>,
+ then the following commands will be run:
+ </para>
+ <simplelist>
+ <member><command>echo pierre pierre paul jacques</command></member>
+ <member><command>echo paul pierre paul jacques</command></member>
+ <member><command>echo jacques pierre paul jacques</command></member>
+ </simplelist>
+ <para>
+ And if we have requested <literal>echo %B %b</literal>,
+ then the following commands will be run:
+ </para>
+ <simplelist>
+ <member><command>echo pierre paul jacques pierre</command></member>
+ </simplelist>
+ </example>
+ </sect4>
</sect3>
</sect2>
diff --git a/doc/nact/C/nact-starting.xml b/doc/nact/C/nact-starting.xml
index 315a60a..2118986 100644
--- a/doc/nact/C/nact-starting.xml
+++ b/doc/nact/C/nact-starting.xml
@@ -213,6 +213,18 @@
<varlistentry>
<term>
<keycombo>
+ <keycap>F2</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Edit a cell in a listbox.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
<keycap>F1</keycap>
</keycombo>
</term>
@@ -248,7 +260,7 @@
</para>
<para>
Items may be sorted in ascending or descending alphabetical order, or
- not sorted at all, directly organized and managed by the user.
+ not sorted at all, being directly organized and managed by the user.
</para>
<para>
Invalid items are displayed in red color.
@@ -259,6 +271,14 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term>Sort buttons</term>
+ <listitem>
+ <para>
+ Three buttons allow you to toggle between sort modes.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>Properties tabs.</term>
<listitem>
<para>
@@ -388,6 +408,10 @@
When no relevant information is to be displayed, the statusbar
displays the count of loaded menus, actions and profiles.
</para>
+ <para>
+ The «sp;read-only&spraquo; icon is displayed in
+ the right of the statusbar when appropriate.
+ </para>
</listitem>
</varlistentry>
</variablelist>
@@ -406,7 +430,7 @@
</para>
</formalpara>
<para>
- &zenity; is a program which allows its user to create a graphical
+ &zenity; is a program which will allow you to create a graphical
user interface from a command-line.
</para>
<para>
@@ -439,10 +463,7 @@
</para>
</formalpara>
<para>
- A new action is inserted in the items list.
- </para>
- <para>
- This new action is automatically selected in the items list,
+ A new action is inserted in the items list,
and its properties are displayed in the tabs on the right pane.
</para>
<para>
@@ -498,8 +519,9 @@
<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.
+ &prodname;: it will be displayed in red in <guilabel>Items list</guilabel>
+ and will never be candidate to be displayed in the
+ file manager context menus.
</para>
</listitem>
<listitem>
@@ -600,6 +622,11 @@
</para>
</listitem>
</itemizedlist>
+ <para>
+ If the cmmand you enter does not have an absolute path,
+ then it will be searched for in the <envvar>PATH</envvar>
+ variable at execution time.
+ </para>
</listitem>
<listitem>
<para>
@@ -612,6 +639,13 @@
be passed to your command when it will be executed. These arguments may
embed parameters which will be expanded at runtime.
</para>
+ <para>
+ If both <guilabel>Path</guilabel> and <guilabel>Parameters</guilabel>
+ are empty, then this action will be considered as invalid: it will be
+ displayed in red in <guilabel>Items list</guilabel> and will be
+ never be candidate to be displayed in the
+ file manager context menus.
+ </para>
</listitem>
</itemizedlist>
<formalpara>
diff --git a/doc/nact/C/nact-where.xml b/doc/nact/C/nact-where.xml
index 2489ca6..6caf105 100644
--- a/doc/nact/C/nact-where.xml
+++ b/doc/nact/C/nact-where.xml
@@ -1,34 +1,47 @@
<sect2 id="usage-where">
<title>Locating the action</title>
+ <figure id="nact-FIG-tab-action-where">
+ <title>Target configuration</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-action-tab.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you configure the target of your action.</phrase>
+ </textobject>
+ <caption>
+ <para>Target configuration</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
<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.
+ &nautilus; file manager may display your action in different places,
+ depending on what 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).
+ When <guilabel>Display item in selection context menu</guilabel>
+ is checked, then your action will be candidate to be displayed in
+ &nautilus; context menu as soon as at least one item is selected in
+ the file manager. Your action will so deal with currently selected
+ item(s).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>
<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.
+ in &nautilus; <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.
+ This target is checked by default.
</para>
</sect3>
@@ -37,22 +50,20 @@
<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.
+ &nautilus; context menu when the file manager selection will be empty.
Your action will so deal with currently displayed location.
+ 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>
<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.
+ in &nautilus; <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">
@@ -77,8 +88,8 @@
<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
+ Whether it is the selection context menu or the location
+ context menu, and both in &nautilus; context menus and in
<guimenu>File</guimenu> or <guimenu>Edit</guimenu> menus, your
action will be displayed as
</para>
@@ -96,7 +107,7 @@
</listitem>
<listitem>
<para>
- those two properties being associated with the
+ these two properties being associated with the
<guilabel>Tooltip</guilabel>.
</para>
</listitem>
@@ -110,7 +121,7 @@
</note>
<tip>
<para>
- You may embed some parameters in the label, the icon name of the tooltip.
+ You may embed some parameters in the label, the icon name or the tooltip.
These parameters will be dynamically substituted at runtime with values
which will depend of currently selected item(s).
</para>
@@ -119,7 +130,7 @@
<formalpara>
<title>If your action targets the toolbar</title>
<para>
- In the toolbar, your action will be displayed as
+ Your action will be displayed as
</para>
</formalpara>
<itemizedlist>
@@ -127,15 +138,6 @@
<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>
@@ -144,7 +146,8 @@
</listitem>
<listitem>
<para>
- associated with the <guilabel>Tooltip</guilabel>.
+ these two properties being associated with the
+ <guilabel>Tooltip</guilabel>.
</para>
</listitem>
</itemizedlist>
@@ -157,7 +160,16 @@
</note>
<tip>
<para>
- You may embed some parameters in the toolbar label, the icon name of the tooltip.
+ 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 that those defined for the menus.
+ </para>
+ </tip>
+ <tip>
+ <para>
+ You may embed some parameters in the toolbar label, the icon name or the tooltip.
These parameters will be dynamically substituted at runtime with values
which will depend of currently selected item(s).
</para>
diff --git a/doc/nact/C/nautilus-actions-config-tool.xml b/doc/nact/C/nautilus-actions-config-tool.xml
index 70f73e4..3534199 100644
--- a/doc/nact/C/nautilus-actions-config-tool.xml
+++ b/doc/nact/C/nautilus-actions-config-tool.xml
@@ -16,6 +16,9 @@
<!ENTITY windows "<productname>Windows</productname>">
<!ENTITY zenity "<productname>Zenity</productname>">
+ <!-- other entities -->
+ <!ENTITY desema "<ulink url='http://www.nautilus-actions.org/?q=node/377' type='http'>DES-EMA specification</ulink>">
+
<!-- the synopsys of the document -->
<!ENTITY articleinfo SYSTEM "articleinfo.xml">
<!ENTITY legalnotice SYSTEM "legalnotice.xml">
@@ -32,6 +35,7 @@
<!ENTITY import SYSTEM "nact-import.xml">
<!ENTITY preferences SYSTEM "nact-prefs.xml">
<!ENTITY misc-infos SYSTEM "nact-misc.xml">
+ <!ENTITY bugs SYSTEM "nact-bugs.xml">
<!ENTITY gnu-fdl SYSTEM "appendix-gnu-fdl-1.3.xml">
<!-- some user-defined internal entities
@@ -167,14 +171,12 @@
<!-- This section is optional and is commented out by default.
You can use it to describe known bugs and limitations of the
program if there are any - please be frank and list all
- problems you know of.
+ problems you know of. -->
<sect1 id="bugs">
<title>Known Bugs and Limitations</title>
- <para>
- </para>
+ &bugs;
</sect1>
--->
<!-- =========================== About ================================ -->
<!-- This section contains info about the program (not docs), such as
diff --git a/doc/nact/Makefile.am b/doc/nact/Makefile.am
index 2eb3a9b..7550383 100644
--- a/doc/nact/Makefile.am
+++ b/doc/nact/Makefile.am
@@ -39,6 +39,7 @@ DOC_ENTITIES = \
appendix-gnu-fdl-1.3.xml \
articleinfo.xml \
legalnotice.xml \
+ nact-bugs.xml \
nact-conditions.xml \
nact-edit.xml \
nact-execution.xml \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
