[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:18 +0000 (UTC)
commit c7cb62091054186fd5bb901573dc87490a069bca
Author: Pierre Wieser <pwieser trychlos org>
Date: Wed Aug 4 23:10:38 2010 +0200
Update NACT user's manual
doc/.gitignore | 3 +
doc/nact/.gitignore | 2 -
doc/nact/C/articleinfo.xml | 9 +-
doc/nact/C/figures/nact-action-tab.png | Bin 0 -> 49521 bytes
doc/nact/C/figures/nact-command-tab.png | Bin 43994 -> 48333 bytes
doc/nact/C/figures/nact-main-empty.png | Bin 43537 -> 43137 bytes
doc/nact/C/figures/nact-new-scheme.png | Bin 0 -> 13267 bytes
doc/nact/C/figures/start-context-menu-nautilus.png | Bin 0 -> 56462 bytes
doc/nact/C/figures/start-context-menu.png | Bin 0 -> 150831 bytes
doc/nact/C/figures/start-zenity-result.png | Bin 0 -> 9882 bytes
doc/nact/C/nact-conditions.xml | 831 ++++++++++++++++++++
doc/nact/C/nact-misc.xml | 18 +-
doc/nact/C/nact-prefs.xml | 67 +-
doc/nact/C/nact-profiles.xml | 85 ++
doc/nact/C/nact-sorting.xml | 78 ++
doc/nact/C/nact-starting.xml | 671 ++++++++++++++++
doc/nact/C/nact-usage.xml | 777 ------------------
doc/nact/C/nautilus-actions-config-tool.xml | 432 +----------
doc/nact/Makefile.am | 16 +-
nautilus-actions.doap | 7 +-
20 files changed, 1757 insertions(+), 1239 deletions(-)
---
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..ffb2ea8
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,3 @@
+*.html
+*.omf
+*.pdf
diff --git a/doc/nact/C/articleinfo.xml b/doc/nact/C/articleinfo.xml
index 03f3c68..ef34c24 100644
--- a/doc/nact/C/articleinfo.xml
+++ b/doc/nact/C/articleinfo.xml
@@ -8,12 +8,13 @@
<abstract role="description">
<para>
- In short, &prodname; is a &nautilus; extension which let the user
- define new actions in the file-manager context menus, and group them
- into his own menus.
+ &prodname; is a &nautilus; extension whose principal function
+ is to allow the user to add arbitrary actions to the file manager
+ context menus. These actions may be organized in menus and submenus,
+ exported and shared with other desktop environments.
</para>
<para>
- This manual describes the &appname; user interface, and shows how
+ This manual describes the &appname; user interface, and explains how
you may configure your menus and actions, making them be displayed
and applied depending on specific conditions.
</para>
diff --git a/doc/nact/C/figures/nact-action-tab.png b/doc/nact/C/figures/nact-action-tab.png
new file mode 100644
index 0000000..cd46536
Binary files /dev/null and b/doc/nact/C/figures/nact-action-tab.png differ
diff --git a/doc/nact/C/figures/nact-command-tab.png b/doc/nact/C/figures/nact-command-tab.png
index 4e6bf6e..3500601 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-main-empty.png b/doc/nact/C/figures/nact-main-empty.png
index 244e419..27ea87b 100644
Binary files a/doc/nact/C/figures/nact-main-empty.png and b/doc/nact/C/figures/nact-main-empty.png differ
diff --git a/doc/nact/C/figures/nact-new-scheme.png b/doc/nact/C/figures/nact-new-scheme.png
new file mode 100644
index 0000000..c2279e2
Binary files /dev/null and b/doc/nact/C/figures/nact-new-scheme.png differ
diff --git a/doc/nact/C/figures/start-context-menu-nautilus.png b/doc/nact/C/figures/start-context-menu-nautilus.png
new file mode 100644
index 0000000..e2af30d
Binary files /dev/null and b/doc/nact/C/figures/start-context-menu-nautilus.png differ
diff --git a/doc/nact/C/figures/start-context-menu.png b/doc/nact/C/figures/start-context-menu.png
new file mode 100644
index 0000000..562c71a
Binary files /dev/null and b/doc/nact/C/figures/start-context-menu.png differ
diff --git a/doc/nact/C/figures/start-zenity-result.png b/doc/nact/C/figures/start-zenity-result.png
new file mode 100644
index 0000000..94c991d
Binary files /dev/null and b/doc/nact/C/figures/start-zenity-result.png differ
diff --git a/doc/nact/C/nact-conditions.xml b/doc/nact/C/nact-conditions.xml
new file mode 100644
index 0000000..81121b8
--- /dev/null
+++ b/doc/nact/C/nact-conditions.xml
@@ -0,0 +1,831 @@
+<sect2 id="usage-conditions">
+ <title>Defining the conditions</title>
+ <para>
+ Whether your action will eventually be displayed in &nautilus; file manager
+ context menus as well as in its toolbar depends of the conditions you will have
+ defined for it.
+ </para>
+ <para>
+ Each time the selection changes in the file manager, &prodname;
+ checks all your actions, comparing the defined conditions against
+ the properties of selected items.
+ </para>
+ <para>
+ All defined conditions must be satisfied by the current file manager
+ selection in order your action be actually displayed.
+ </para>
+
+ <sect3 id="usage-conditions-basenames">
+ <title>Basename-based conditions</title>
+ <para>
+ Click on the <guilabel>Basenames</guilabel> tab to show the page
+ which will permit you to configure your basename-based conditions.
+ </para>
+ <figure id="nact-FIG-tab-basenames">
+ <title>Basename-based conditions</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-basenames-tab.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define basename-based conditions.</phrase>
+ </textobject>
+ <caption>
+ <para>The basename-based conditions tab</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ You may decide that your action will appear depending on the basenames
+ of the items currently selected in the file-manager: you may define that each
+ item of the selection must meet some sort of basename, and you may simultaneously
+ decide that none of the selected item(s) can have some other sort of basename.
+ </para>
+ <para>
+ Defining a new basename-based condition involves two steps.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Define the new condition filter.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Press <keycap>Insert</keycap> or click on
+ <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
+ button to insert a new condition filter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Edit the newly inserted condition filter to the basename you want match.
+ </para>
+ <tip>
+ <para>
+ A basename-based condition may use «sp;<literal>*</literal>&spraquo; or
+ «sp;<literal>?</literal>&spraquo; wildcard characters.
+ </para>
+ </tip>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Indicates whether this a «sp;match&spraquo; or a «sp;no match&spraquo;
+ condition.
+ </para>
+ <para>
+ Click on the <guilabel>Must match one of</guilabel> or
+ <guilabel>Must not match any of</guilabel> radio button in the same
+ row to set a «sp;must have&spraquo; or
+ «sp;must not have&spraquo; condition.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ Depending of your target operating system, make sure that the
+ <guilabel>Match case</guilabel> checkbox is activated (or not).
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ When activated, all filters are considered as case sensitive,
+ which means that <filename>/my/file</filename> filename is
+ considered distinct from <filename>/My/File</filename> one.
+ </para>
+ <para>
+ This is the default behavior on Unix-like systems.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When disactivated, filters are considered as case insensitive,
+ which means that <filename>/my/file</filename> and
+ <filename>My/File</filename> filenames are considered the same
+ name.
+ </para>
+ <para>
+ This is most probably what you want if you target some sort of
+ &windows; system.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ When the action is examined to see if it should be displayed, the basename
+ of each currently selected item is compared to the list of these basename-based
+ conditions for this action.
+ </para>
+ <para>
+ By default, the basename-based condition is just one
+ «sp;<literal>must match *</literal>&spraquo; condition.
+ This means that basenames are not considered as a relevant condition
+ for the action.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-conditions-mimetypes">
+ <title>Mimetype-based conditions</title>
+ <para>
+ Click on the <guilabel>Mimetypes</guilabel> tab to show the page
+ which will permit you to configure your mimetype-based conditions.
+ </para>
+ <figure id="nact-FIG-tab-mimetypes">
+ <title>Mimetype-based conditions</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-mimetypes-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define mimetype-based conditions.</phrase>
+ </textobject>
+ <caption>
+ <para>The mimetype-based conditions tab</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ You may decide that your action will appear depending on the mimetypes
+ of the items currently selected in the file-manager: you may define that each
+ item of the selection must meet some sort of mimetype; and you may simultaneously
+ decide that none of the selected item(s) can have some other sort of mimetype.
+ </para>
+ <para>
+ Defining a new mimetype-based condition involves two steps.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Define the new condition filter.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Press <keycap>Insert</keycap> or click on
+ <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
+ button to insert a new condition filter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Edit the newly inserted condition filter to the mimetype you want match.
+ </para>
+ <para>
+ A mimetype must be defined as a <literal>group/subgroup</literal>
+ expression.
+ </para>
+ <tip>
+ <para>
+ The «sp;<literal>*</literal>&spraquo; asterisk may be used as
+ a wildcard in some situations:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ The «sp;<literal>*/*</literal>&spraquo; expression
+ matches all mimetypes. As a convenient shortcut, the
+ «sp;<literal>*</literal>&spraquo; literal is
+ also accepted for this same purpose.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A «sp;<literal>group/*</literal>&spraquo; string
+ matches all subgroups of <literal>group</literal> mimetype.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </tip>
+ <note>
+ <para>
+ The «sp;<literal>*/subgroup</literal>&spraquo; string
+ is not accepted as a valid wildcard.
+ </para>
+ </note>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Indicates whether this a «sp;match&spraquo; or a «sp;no match&spraquo;
+ condition.
+ </para>
+ <para>
+ Click on the <guilabel>Must match one of</guilabel> or
+ <guilabel>Must not match any of</guilabel> radio button in the same
+ row to set a «sp;must have&spraquo; or
+ «sp;must not have&spraquo; condition.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ When the action is examined to see if it should be displayed, the mimetype
+ of each currently selected item is compared to the list of these mimetype-based
+ conditions for this action.
+ </para>
+ <para>
+ By default, the mimetype-based condition is just one
+ «sp;<literal>must match */*</literal>&spraquo; condition.
+ This means that mimetypes are not considered as a relevant condition
+ for the action.
+ </para>
+ <example>
+ <title>Example of usual mimetypes</title>
+ <variablelist>
+ <varlistentry>
+ <term>
+ all/all
+ </term>
+ <listitem>
+ <para>
+ Matches all items.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ all/allfiles
+ </term>
+ <listitem>
+ <para>
+ Matches all regular files.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ inode/directory
+ </term>
+ <listitem>
+ <para>
+ Matches only directories.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </example>
+ </sect3>
+
+ <sect3 id="usage-conditions-folders">
+ <title>Folder-based conditions</title>
+ <para>
+ Click on the <guilabel>Folders</guilabel> tab to show the page
+ which will permit you to configure your folder-based conditions.
+ </para>
+ <figure id="nact-FIG-tab-folders">
+ <title>Folder-based conditions</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-folders-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define folder-based conditions.</phrase>
+ </textobject>
+ <caption>
+ <para>The folder-based conditions tab</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ You may decide that your action will appear depending on the directory
+ the items currently selected in the file-manager are located in:
+ you may define that each item of the selection must be located in one
+ hierarchy or in another; and you may simultaneously
+ decide that none of the selected item(s) can be located in some other
+ hierarchy.
+ </para>
+ <para>
+ A folder-based condition must be understood as the specification
+ of the hierarchy in which the currently examined item should (or
+ should not) stay.
+ </para>
+ <para>
+ Defining a new folder-based condition involves two steps.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Define the new condition filter.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Press <keycap>Insert</keycap> or click on
+ <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
+ button to insert a new condition filter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Edit the newly inserted condition filter to the folder you want match.
+ </para>
+ <tip>
+ <para>
+ The «sp;<literal>*</literal>&spraquo; and
+ «sp;<literal>?</literal>&spraquo; characters
+ are accepted as wildcards at any level of the defined
+ folder filter.
+ </para>
+ </tip>
+ </listitem>
+ <listitem>
+ <para>
+ Or click on
+ <guibutton>Browse</guibutton> to select a folder on the filesystem.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Indicates whether this a «sp;match&spraquo; or a «sp;no match&spraquo;
+ condition.
+ </para>
+ <para>
+ Click on the <guilabel>Must match one of</guilabel> or
+ <guilabel>Must not match any of</guilabel> radio button in the same
+ row to set a «sp;must have&spraquo; or
+ «sp;must not have&spraquo; condition.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ When the action is examined to see if it should be displayed, the location
+ of each currently selected item is compared to the list of these folder-based
+ conditions for this action.
+ </para>
+ <para>
+ By default, the folder-based condition is just one
+ «sp;<literal>must match /</literal>&spraquo; condition.
+ As <literal>/</literal> is always the top of an Unix-like filesystem,
+ then all selected files always match this condition.
+ </para>
+ <note>
+ <para>
+ If you target a &windows; system, then this default value may
+ not be what you actually want.
+ </para>
+ </note>
+ </sect3>
+
+ <sect3 id="usage-conditions-schemes">
+ <title>Scheme-base-conditions</title>
+ <para>
+ Click on the <guilabel>Schemes</guilabel> tab to show the page
+ which will permit you to configure your scheme-based conditions.
+ </para>
+ <figure id="nact-FIG-tab-schemes">
+ <title>Scheme-based conditions</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-schemes-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define scheme-based conditions.</phrase>
+ </textobject>
+ <caption>
+ <para>The scheme-based conditions tab</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ You may decide that your action will appear depending on the schemes
+ of the URIs of the items currently selected in the file-manager:
+ you may define that each item of the selection must have some scheme;
+ and you may simultaneously
+ decide that none of the selected item(s) may have some other scheme.
+ </para>
+ <para>
+ Defining a new scheme-based condition involves two steps.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Define the new condition filter.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Press <keycap>Insert</keycap> or click on
+ <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
+ button to insert a new condition filter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Edit the newly inserted condition filter to the scheme you want match.
+ </para>
+ <tip>
+ <para>
+ Scheme-based conditions only accept
+ «sp;<literal>*</literal>&spraquo; asterisk wildcard,
+ which stands for «sp;any scheme&spraquo;.
+ </para>
+ </tip>
+ </listitem>
+ <listitem>
+ <para>
+ Or click on
+ <guibutton>Common</guibutton> to select a scheme among these
+ defined as default schemes in
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Preferences</guimenuitem>
+ </menuchoice>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Indicates whether this a «sp;match&spraquo; or a «sp;no match&spraquo;
+ condition.
+ </para>
+ <para>
+ Click on the <guilabel>Must match one of</guilabel> or
+ <guilabel>Must not match any of</guilabel> radio button in the same
+ row to set a «sp;must have&spraquo; or
+ «sp;must not have&spraquo; condition.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ When the action is examined to see if it should be displayed, the
+ scheme of the URI
+ of each currently selected item is compared to the list of these
+ scheme-based conditions for this action.
+ </para>
+ <para>
+ By default, the scheme-based condition is just one
+ «sp;<literal>must match *</literal>&spraquo; condition,
+ which means that schemes are not relevant for this action.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-conditions-capabilities">
+ <title>Capability-based conditions</title>
+ <para>
+ Click on the <guilabel>Capabilities</guilabel> tab to show the page
+ which will permit you to configure your capability-based conditions.
+ </para>
+ <figure id="nact-FIG-tab-capabilities">
+ <title>Capability-based conditions</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-capabilities-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the tab which lets you define capability-based conditions.</phrase>
+ </textobject>
+ <caption>
+ <para>The capability-based conditions tab</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ Capabilities are some properties that a file may exhibit to the user.
+ </para>
+ <para>
+ But the <literal>Local</literal> capability, all others are dependant
+ of the user who executes the command.
+ </para>
+ <para>
+ You may so decide that your action will appear, or not, depending
+ on the capabilities of the selected item(s) <abbrev>vs.</abbrev>
+ the current user.
+ </para>
+ <para>
+ Defining a new capability-based condition involves two steps.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Define the new condition filter.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Press <keycap>Insert</keycap> to insert a new condition filter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Edit the newly inserted condition filter to the capability you want match.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Or click on
+ <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
+ to open the <guilabel>Adding a new capability</guilabel> dialog
+ box.
+ </para>
+ <figure id="nact-FIG-add-capability">
+ <title>Managed capabilities</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-new-capability.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the list of managed capabilities.</phrase>
+ </textobject>
+ <caption>
+ <para>The list of managed capabilities</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Indicates whether this a «sp;match&spraquo; or a «sp;no match&spraquo;
+ condition.
+ </para>
+ <para>
+ Click on the <guilabel>Must match one of</guilabel> or
+ <guilabel>Must not match any of</guilabel> radio button in the same
+ row to set a «sp;must have&spraquo; or
+ «sp;must not have&spraquo; condition.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ When the action is examined to see if it should be displayed, this list
+ of capabilities that selected item(s) must match (or not) is compared
+ to those exhibited to the user.
+ </para>
+ <para>
+ By default, the capability-based condition list is empty. This means
+ that capabilities are not relevant for this action.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-conditions-count">
+ <title>Selection count condition</title>
+ <para>
+ Click on the <guilabel>Environment</guilabel> tab to show the page
+ which will permit you to configure your environment-based conditions.
+ </para>
+ <figure id="nact-FIG-tab-environment">
+ <title>Environment-based conditions</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-environment-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>
+ Shows the tab which lets you define environment-based conditions.
+ This include the selection count configuration, the desktop
+ selection, along with the runtime filters.
+ </phrase>
+ </textobject>
+ <caption>
+ <para>The environment-based conditions tab</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ You may define that your action will only appear if the current
+ selection in the file manager has some precise count, or some
+ precise relation with a given count.
+ </para>
+ <example>
+ <title>A selection count use case</title>
+ <para>
+ If your action consists in displaying the differences between
+ two files, you may define here
+ <guilabel>Count = (equal to) 2</guilabel>.
+ </para>
+ </example>
+ <para>
+ To define a selection count condition:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select in the <guilabel>Count</guilabel> drop-down list
+ the operator you want apply to the selection count:
+ </para>
+ <simplelist type="vert">
+ <member><literal>< (strictly less than)</literal></member>
+ <member><literal>= (equal to)</literal></member>
+ <member><literal>> (strictly greather than)</literal></member>
+ </simplelist>
+ </listitem>
+ <listitem>
+ <para>
+ Enter the reference count you wish.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The selection count defaults to
+ «sp;<literal>Count > (strictly greater than) 0</literal>&spraquo;,
+ which means that the action will be candidate to be displayed
+ as soon as at least one item is selected in the file manager.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-conditions-desktop">
+ <title>Desktop selection</title>
+ <para>
+ Click on the <guilabel>Environment</guilabel> tab to show the page
+ which will permit you to configure your environment-based conditions.
+ </para>
+ <para>
+ You may define that your action:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ will always appear,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ or will only appear in some given desktop environments,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ or will not appear in some given desktop environments.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Only one of three choices is authorized.
+ </para>
+ <para>
+ To define the desktop environment condition:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ First select the type of filter:
+ </para>
+ <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
+ environment(s) ?</member>
+ <member>does your action should never appeat in some
+ desktop environment(s) ?</member>
+ </simplelist>
+ </listitem>
+ <listitem>
+ <para>
+ If your action does not should always appear, then
+ select the relevant desktop environment(s) in the listbox
+ in the right side.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ The target desktop environment condition defaults to
+ «sp;<guilabel>Always appear</guilabel>&spraquo;,
+ which means that the action will be candidate to be displayed
+ regarding of the current desktop environment.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-conditions-executable">
+ <title>Executable found condition</title>
+ <para>
+ Click on the <guilabel>Environment</guilabel> tab to show the page
+ 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.
+ </para>
+ <para>
+ To define the relevant file, enter its full filename in the
+ <guilabel>Appears if the file is executable</guilabel> entry
+ box, or click on <guibutton>Browse</guibutton> to select a file
+ on the filesystem.
+ </para>
+ <para>
+ Leave the field empty if this condition is not relevant for
+ your action.
+ </para>
+ <tip>
+ <para>
+ You may embed some parameters in the searched filename or its options.
+ These parameters will be dynamically substituted at runtime with values
+ which will depend of currently selected item(s).
+ </para>
+ </tip>
+ </sect3>
+
+ <sect3 id="usage-conditions-dbus">
+ <title>D-Bus registration condition</title>
+ <para>
+ Click on the <guilabel>Environment</guilabel> tab to show the page
+ which will permit you to configure your environment-based conditions.
+ </para>
+ <para>
+ You may define that your action will only appear in some given
+ name is registered on D-Bus system at runtime.
+ </para>
+ <para>
+ To define the relevant name, enter it in the
+ <guilabel>Appears if the name is registered on D-Bus</guilabel>
+ entry box.
+ </para>
+ <para>
+ Leave the field empty if this condition is not relevant for
+ your action.
+ </para>
+ <tip>
+ <para>
+ You may embed some parameters in the searched name.
+ These parameters will be dynamically substituted at runtime with values
+ which will depend of currently selected item(s).
+ </para>
+ </tip>
+ </sect3>
+
+ <sect3 id="usage-conditions-true">
+ <title>Customized condition</title>
+ <para>
+ Click on the <guilabel>Environment</guilabel> tab to show the page
+ which will permit you to configure your environment-based conditions.
+ </para>
+ <para>
+ You may define that your action will only appear in 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.
+ </para>
+ <para>
+ To define the command, enter it in the
+ <guilabel>Appears if the command outputs "true"</guilabel>
+ entry box.
+ </para>
+ <para>
+ Leave the field empty if this condition is not relevant for
+ your action.
+ </para>
+ <tip>
+ <para>
+ You may embed some parameters in the executed filename or its options.
+ These parameters will be dynamically substituted at runtime with values
+ which will depend of currently selected item(s).
+ </para>
+ </tip>
+ </sect3>
+
+ <sect3 id="usage-conditions-run">
+ <title>Running process condition</title>
+ <para>
+ Click on the <guilabel>Environment</guilabel> tab to show the page
+ which will permit you to configure your environment-based conditions.
+ </para>
+ <para>
+ You may define that your action will only appear in some given
+ binary is currently running.
+ </para>
+ <para>
+ To define the binary, enter its name in the
+ <guilabel>Appears if the binary is running</guilabel>
+ entry box, or click on <guibutton>Browse</guibutton> to select
+ a file on the filesystem.
+ </para>
+ <note>
+ <para>
+ Even if you enter here the full filename of a binary, only
+ its basename will be searched for in the processes list
+ at runtime.
+ </para>
+ </note>
+ <para>
+ Leave the field empty if this condition is not relevant for
+ your action.
+ </para>
+ <tip>
+ <para>
+ You may embed some parameters in the searched name.
+ These parameters will be dynamically substituted at runtime with values
+ which will depend of currently selected item(s).
+ </para>
+ </tip>
+ </sect3>
+</sect2>
diff --git a/doc/nact/C/nact-misc.xml b/doc/nact/C/nact-misc.xml
index fcd7cd6..6eb3238 100644
--- a/doc/nact/C/nact-misc.xml
+++ b/doc/nact/C/nact-misc.xml
@@ -1,10 +1,8 @@
-<!-- ============================ Misc ================================ -->
-<!-- informations I do not know where to put -->
-
- <sect1 id="misc">
- <title>Miscellaneous informations</title>
- <para>
- </para>
-
- </sect1>
- <!-- end of sect1 - misc -->
+ <para>
+ The new action is also displayed in red color in the items list.
+ Red color is used as an indicator that the item
+ is invalid, that is that the item cannot be candidate to be displayed in a
+ &nautilus; context menu because some of its informations are missing or erroneous.
+ Here, and though this newly inserted action has some suitable defaults, it lacks a
+ command to be executed to be considered valid by &appname;
+ </para>
diff --git a/doc/nact/C/nact-prefs.xml b/doc/nact/C/nact-prefs.xml
index 66580f0..b571446 100644
--- a/doc/nact/C/nact-prefs.xml
+++ b/doc/nact/C/nact-prefs.xml
@@ -1,45 +1,40 @@
-<!-- ========================= Preferences ============================ -->
+<sect2 id="usage-prefs">
+ <title>Setting your own preferences</title>
- <sect1 id="prefs">
- <title>Preferences</title>
+ <sect3 id="usage-prefs-runtime">
+ <title>Runtime preferences</title>
<para>
</para>
+ </sect3>
- <sect2 id="prefs-runtime">
- <title>Runtime preferences</title>
- <para>
- </para>
- </sect2>
-
- <sect2 id="prefs-ui">
- <title>UI preferences</title>
- <para>
- </para>
- </sect2>
+ <sect3 id="usage-prefs-ui">
+ <title>UI preferences</title>
+ <para>
+ </para>
+ </sect3>
- <sect2 id="prefs-import">
- <title>Import preferences</title>
- <para>
- </para>
- </sect2>
+ <sect3 id="usage-prefs-import">
+ <title>Import preferences</title>
+ <para>
+ </para>
+ </sect3>
- <sect2 id="prefs-export">
- <title>Export preferences</title>
- <para>
- </para>
- </sect2>
+ <sect3 id="usage-prefs-export">
+ <title>Export preferences</title>
+ <para>
+ </para>
+ </sect3>
- <sect2 id="prefs-schemes">
- <title>Schemes preferences</title>
- <para>
- </para>
- </sect2>
+ <sect3 id="usage-prefs-schemes">
+ <title>Schemes preferences</title>
+ <para>
+ </para>
+ </sect3>
- <sect2 id="prefs-providers">
- <title>I/O providers preferences</title>
- <para>
- </para>
- </sect2>
+ <sect3 id="usage-prefs-providers">
+ <title>I/O providers preferences</title>
+ <para>
+ </para>
+ </sect3>
- </sect1>
- <!-- end of sect1 - preferences -->
+</sect2>
diff --git a/doc/nact/C/nact-profiles.xml b/doc/nact/C/nact-profiles.xml
new file mode 100644
index 0000000..fad0701
--- /dev/null
+++ b/doc/nact/C/nact-profiles.xml
@@ -0,0 +1,85 @@
+<sect2 id="usage-profile">
+ <title>Defining several profiles</title>
+ <para>
+ There is some situations where you will want a given action behave
+ slightly differently depending on the currently selected items or
+ the current runtime environment.
+ </para>
+ <example>
+ <title>Open a terminal here</title>
+ <para>
+ Say you have an action which opens a terminal in the current location.
+ </para>
+ <para>
+ You have configured it to open your preferred terminal in the
+ location your file manager currently points to.
+ </para>
+ <para>
+ But what if you want select a directory in your file manager,
+ and directly opens your terminal in this directory ? If you
+ keep based on the current file manager location, your
+ terminal will open in the parent of the targeted directory.
+ </para>
+ <para>
+ The solution is to define a new profile to your action,
+ configuring this profile to open the terminal in the
+ targeted directory.
+ </para>
+ </example>
+ <para>
+ To create a new profile, first select the action in the items list,
+ then choose
+ <menuchoice>
+ <guisubmenu>File</guisubmenu>
+ <guimenuitem>New profile</guimenuitem>
+ </menuchoice>.
+ </para>
+ <para>
+ A new profile is created in your action.
+ </para>
+ <para>
+ You can now define the conditions which are to be met in order
+ this profile be selected, and the command which will be executed.
+ </para>
+
+ <sect3 id="usage-profile-order">
+ <title>Ordering the profiles inside an action</title>
+ <para>
+ At runtime, &prodname; will begin with examining the conditions
+ set on your action.
+ </para>
+ <para>
+ If these conditions (the action-conditions) are met, then &prodname;
+ will examine in order each profile.
+ </para>
+ <para>
+ If the conditions defined in a profile are met, then this profile
+ will be validated, and the review of other profiles will stop.
+ </para>
+ <para>
+ If no profile is found valid at runtime, then the action will be
+ itself considered invalid, and will not be displayed in the file
+ manager context menu.
+ </para>
+ <para>
+ So, ordering of the profiles may be important for your action: the
+ first valid profile found, the first selected profile.
+ </para>
+ <para>
+ You may order your profiles inside an action in two ways.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Cut the profile to be moved, select the profile before which
+ you want yout cut profile to be inserted, and paste it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Cick on the profile to be moved, and drag it to its right place.
+ </para>
+ </listitem>
+ </orderedlist>
+ </sect3>
+</sect2>
diff --git a/doc/nact/C/nact-sorting.xml b/doc/nact/C/nact-sorting.xml
new file mode 100644
index 0000000..5baca33
--- /dev/null
+++ b/doc/nact/C/nact-sorting.xml
@@ -0,0 +1,78 @@
+<sect2 id="usage-sorting">
+ <title>Sorting the items list</title>
+ <para>
+ Your actions and menus will be displayed in file manager context menus
+ in the same order that they are listed in the items list, on the left
+ pane of the main &appname; window.
+ </para>
+ <para>
+ You may decide to:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ sort your actions and menus in ascending or descending alphabetical
+ order of their label,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ or do not sort, and manually organize your actions and menus
+ in your own order.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <sect3 id="usage-sorting-alpha">
+ <title>Alphabetically sorting your actions and menus</title>
+ <para>
+ In these modes, actions and menus are sorted depending of their label,
+ inside of their parent.
+ </para>
+ </sect3>
+
+ <sect3 id="usage-sorting-manual">
+ <title>Manually organizing your actions and menus</title>
+ <para>
+ In this mode, a new action or a new menu will be inserted just before
+ the current action or menu, inside of the same parent if apply.
+ </para>
+ </sect3>
+</sect2>
+
+<!--
+ <para>
+ The exact place where the
+ action is inserted depends of the current sort order of the items list:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ Manual order:
+ </term>
+ <listitem>
+ <para>
+ The new action is inserted just before the current action or menu.
+ </para>
+ <para>
+ This place will not change when you later modify the label of the action.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Ascending (resp. descending) alphabetical order:
+ </term>
+ <listitem>
+ <para>
+ The new action is inserted at the correct place, regarding the default
+ «sp;<literal>New Nautilus action</literal>&spraquo; label.
+ </para>
+ <para>
+ This place will be automatically changed, each time you modify the
+ label of the action.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+-->
\ No newline at end of file
diff --git a/doc/nact/C/nact-starting.xml b/doc/nact/C/nact-starting.xml
new file mode 100644
index 0000000..d19d15e
--- /dev/null
+++ b/doc/nact/C/nact-starting.xml
@@ -0,0 +1,671 @@
+ <sect2 id="getting-started-starting">
+ <title>Starting &appname;</title>
+ <para>
+ You can start &appname; in the following ways:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><guimenu>System</guimenu> menu</term>
+ <listitem>
+ <para>
+ Choose
+ <menuchoice>
+ <guisubmenu>Preferences</guisubmenu>
+ <guisubmenu>Look and Feel</guisubmenu>
+ <guimenuitem>Nautilus Actions Configuration Tool</guimenuitem>
+ </menuchoice>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Command line</term>
+ <listitem>
+ <para>
+ To start &appname; from a command line, type the following command:
+ </para>
+ <para>
+ <command><filename>nautilus-actions-config-tool</filename></command>
+ </para>
+ <para>
+ then press <keycap>Return</keycap>.
+ </para>
+ <tip>
+ <para>
+ To view available command line options, type:
+ </para>
+ <para>
+ <command>
+ <filename>nautilus-actions-config-tool</filename>
+ <option>--help-all</option>
+ </command>
+ </para>
+ <para>
+ then press <keycap>Return</keycap>.
+ </para>
+ </tip>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="getting-started-first-run">
+ <title>The first run</title>
+ <para>
+ When you start &appname;, the following window is displayed.
+ </para>
+ <figure id="nact-FIG-main-empty">
+ <title>&appname; Start Up Window</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-main-empty.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>
+ Shows &appname; main window.
+ Contains menubar, toolbar, display area,
+ an empty items list in the left, several disabled properties tabs,
+ and statusbar.
+ </phrase>
+ </textobject>
+ <caption>
+ <para>The empty &appname; main window</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <!-- Include any descriptions of the GUI immediately after the screenshot
+ of the main UI, for example, the items on the menubar and on the toolbar.
+ This section is optional. -->
+
+ <para>
+ The &appname; main window contains the following elements:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Menubar.</term>
+ <listitem>
+ <para>
+ The menus on the menubar contain all of the commands
+ you need to use in &appname;.
+ </para>
+ <para>
+ Shortcuts are available for some commands:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>N</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Create a new action.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>S</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Save modified actions and menus.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>Q</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Quit the application.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>X</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Cut the current selection, keeping it in the clipboard.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>C</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Copy the current selection to the clipboard.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>V</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Insert the content of the clipboard before the current item.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Shift</keycap>
+ <keycap>Ctrl</keycap>
+ <keycap>V</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Insert the content of the clipboard as subitem(s) of the current item.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>Delete</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Delete the current selection.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>F5</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Reload the actions and menus.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <keycombo>
+ <keycap>F1</keycap>
+ </keycombo>
+ </term>
+ <listitem>
+ <para>
+ Display the help.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Toolbar.</term>
+ <listitem>
+ <para>
+ Several toolbars may be displayed below the menubar, depending of
+ your choices in the
+ <menuchoice>
+ <guimenu>View</guimenu>
+ <guimenuitem>Toolbars</guimenuitem>
+ </menuchoice> submenu.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Items list.</term>
+ <listitem>
+ <para>
+ The list on the left of the main window contains all items,
+ whether they are actions or menus, currently available for edition in
+ &appname;.
+ </para>
+ <para>
+ Items may be sorted in ascending or descending alphabetical order, or
+ not sorted at all, directly organized and managed by the user.
+ </para>
+ <para>
+ Invalid items are displayed in red color.
+ </para>
+ <para>
+ Modified items are displayed in italic characters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Properties tabs.</term>
+ <listitem>
+ <para>
+ The right part of the main window displays all is needed to define
+ how, when and where actions and menus should be displayed.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ Action/Menu
+ </term>
+ <listitem>
+ <para>
+ Define in which &nautilus; menus the item should appear, and
+ how it will be displayed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Command
+ </term>
+ <listitem>
+ <para>
+ Specify which command to execute, and which parameters
+ pass to it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Execution
+ </term>
+ <listitem>
+ <para>
+ Specify how the command should be executed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Basenames
+ </term>
+ <listitem>
+ <para>
+ Define the basename filters the &nautilus; selection must satisfy
+ in order the action or menu be candidate for display.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Mimetypes
+ </term>
+ <listitem>
+ <para>
+ Define the mimetype filters the &nautilus; selection must satisfy
+ in order the action or menu be candidate for display.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Folders
+ </term>
+ <listitem>
+ <para>
+ Define the folder filters the &nautilus; selection must satisfy
+ in order the action or menu be candidate for display.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Schemes
+ </term>
+ <listitem>
+ <para>
+ Define the scheme filters the &nautilus; selection must satisfy
+ in order the action or menu be candidate for display.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Capabilities
+ </term>
+ <listitem>
+ <para>
+ Define the capability filters the &nautilus; selection must satisfy
+ in order the action or menu be candidate for display.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Environment
+ </term>
+ <listitem>
+ <para>
+ Define some environment conditions the &nautilus; selection must satisfy
+ in order the action or menu be candidate for display.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Properties
+ </term>
+ <listitem>
+ <para>
+ Display item properties.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Statusbar.</term>
+ <listitem>
+ <para>
+ The statusbar displays some status informations about the
+ currently selected row in the items list.
+ </para>
+ <para>
+ When no relevant information is to be displayed, the statusbar
+ displays the count of loaded menus, actions and profiles.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="getting-started-first-action">
+ <title>Creating your first action</title>
+ <para>
+ In this example, we are going to create an action which displays some
+ pretty informations about the current selection.
+ </para>
+ <formalpara>
+ <title>Checking for prerequisites</title>
+ <para>
+ This action will require &zenity;.
+ </para>
+ </formalpara>
+ <para>
+ &zenity; is a program which allows its user to create a graphical
+ user interface from a command-line.
+ </para>
+ <para>
+ You should check that this program
+ is installed on your system, by example by typing the following command
+ in a terminal:
+ </para>
+ <para>
+ <command>
+ <filename>zenity</filename>
+ </command>
+ </para>
+ <para>
+ then press <keycap>Return</keycap>.
+ </para>
+ <formalpara>
+ <title>Creating the action</title>
+ <para>
+ To create a new action, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>N</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>File</guimenu>
+ <guisubmenu>New action</guisubmenu>
+ </menuchoice>.
+ </para>
+ </formalpara>
+ <para>
+ A new action is inserted in the items list.
+ </para>
+ <para>
+ This new action is automatically selected in the items list,
+ and its properties are displayed in the tabs on the right pane.
+ </para>
+ <para>
+ The label of the currently edited action (this one) is added
+ to the application name in the title bar.
+ </para>
+ <figure id="nact-FIG-tab-action">
+ <title>Default properties of a new action</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-action-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>
+ Shows the default properties of a newly created action.
+ </phrase>
+ </textobject>
+ <caption>
+ <para>Default properties of a new action</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ In the items list, the new action is displayed in italic characters.
+ </para>
+ <para>
+ Italics are used as a reminder that the item has not yet been saved.
+ </para>
+ <para>
+ As another reminder, an asterisk («sp;<literal>*</literal>&spraquo;)
+ comes to prefix the application name in the title bar.
+ </para>
+ <formalpara>
+ <title>Qualifying your new action</title>
+ <para>
+ It merely consists of choosing how your action will be displayed
+ in the file manager context menu.
+ </para>
+ </formalpara>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Enter <userinput>My first action</userinput>
+ in the <guilabel>Context label</guilabel> entry box.
+ </para>
+ <para>
+ The <guilabel>Context label</guilabel> entry box contains the label
+ of the action as you want it to be displayed in the file manager
+ context menu.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enter <userinput>This will execute an action with some parameters</userinput>
+ in the <guilabel>Tooltip</guilabel> entry box.
+ </para>
+ <para>
+ The <guilabel>Tooltip</guilabel> entry box contains the text
+ you want to be displayed as a short help to your action.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select <userinput>gtk-about</userinput> in the <guilabel>Icon</guilabel>
+ drop-down list.
+ </para>
+ <para>
+ The <guilabel>Icon</guilabel> selection defines the icon which will
+ be associated with your action in file manager context menus and in
+ the toolbar.
+ </para>
+ <para>
+ You have two ways of choosing the icon associated to your action:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Click on the <guilabel>Icon</guilabel> drop-down list to select an icon.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click on <guibutton>Browse</guibutton> to search
+ for an image in the filesystem.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <formalpara>
+ <title>Specifying the command to be executed</title>
+ <para>
+ When you will select your action in the file manager
+ context menu, this command will be executed, with
+ arguments of your choice.
+ </para>
+ </formalpara>
+ <para>
+ Click on the <guilabel>Command</guilabel> tab to show the page
+ which will permit you to enter the command.
+ </para>
+ <figure id="nact-FIG-tab-command">
+ <title>Command page</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-command-tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>
+ Shows the Command tab.
+ This tab contains the name of the profile, the command to
+ be executed along with its parameters, and the configuration
+ of the starting working directory.
+ </phrase>
+ </textobject>
+ <caption>
+ <para>Command page</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Enter <userinput>zenity</userinput> in the <guilabel>Path</guilabel>
+ entry box.
+ </para>
+ <para>
+ The <guilabel>Path</guilabel> entry box defines the command which
+ will be executed when you will select your action in the file manager
+ context menu.
+ </para>
+ <para>
+ You have two ways of defining the command to be executed:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Enter it in the <guilabel>Path</guilabel> entry box.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click on <guibutton>Browse</guibutton> to select
+ the executable file on the filesystem.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Enter <userinput>--info --text="%c selected item(s): %U"</userinput>
+ in the <guilabel>Parameters</guilabel>
+ entry box.
+ </para>
+ <para>
+ The <guilabel>Parameters</guilabel> contains the arguments which will
+ be passed to your command when it will be executed. These arguments may
+ embed parameters which will be expanded at runtime.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <formalpara>
+ <title>Saving</title>
+ <para>
+ To save all pending modifications, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>S</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>File</guimenu>
+ <guisubmenu>Save</guisubmenu>
+ </menuchoice>.
+ </para>
+ </formalpara>
+ <para>
+ &nautilus; automatically takes into account your new action,
+ and displays it in its context menu.
+ </para>
+ <figure id="nact-FIG-start-nautilus-context">
+ <title>Your first action in the &nautilus; context menu</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/start-context-menu-nautilus.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the first action in the &nautilus; context menu.
+ </phrase>
+ </textobject>
+ <caption>
+ <para>Your first action in the &nautilus; context menu</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <para>
+ Cliking of the item in the &nautilus; context menu activates it,
+ and executes the corresponding command.
+ </para>
+ <figure id="nact-FIG-start-zenity">
+ <title>The result of the execution of your first action</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/start-zenity-result.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>
+ Shows the result of the execution of your first action.
+ This is &zenity; dialog box, displaying the URI of the selected item.
+ </phrase>
+ </textobject>
+ <caption>
+ <para>The result of the execution of your first action</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </sect2>
diff --git a/doc/nact/C/nact-usage.xml b/doc/nact/C/nact-usage.xml
index a402b0f..794e33a 100644
--- a/doc/nact/C/nact-usage.xml
+++ b/doc/nact/C/nact-usage.xml
@@ -1,79 +1,3 @@
-<!-- ============================== Usage ============================= -->
-<!-- Use this section to describe how to use the application to perform the
- tasks for which the application is designed. -->
-
- <sect1 id="usage">
- <title>Using &appname;</title>
-
- <sect2 id="usage-create-action">
- <title>Creating an action</title>
- <para>
- To create a new action, choose
- <menuchoice>
- <shortcut>
- <keycombo>
- <keycap>Ctrl</keycap>
- <keycap>N</keycap>
- </keycombo>
- </shortcut>
- <guimenu>File</guimenu>
- <guisubmenu>New action</guisubmenu>
- </menuchoice>.
- </para>
- <para>
- A new action is inserted in the items list. The exact place where the
- action is inserted depends of the current sort order of the items list:
- </para>
- <variablelist>
- <varlistentry>
- <term>
- Manual order:
- </term>
- <listitem>
- <para>
- The new action is inserted just before the current action or menu.
- </para>
- <para>
- This place will not change when you later modify the label of the action.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Ascending (resp. descending) alphabetical order:
- </term>
- <listitem>
- <para>
- The new action is inserted at the correct place, regarding the default
- «sp;<literal>New Nautilus action</literal>&spraquo; label.
- </para>
- <para>
- This place will be automatically changed, each time you modify the
- label of the action.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>
- Properties of this new action are also displayed in right tabs.
- </para>
- <note>
- <para>
- In theitems list, the new action is displayed in italic characters.
- Italics are used as a reminder that the item has not yet been saved.
- </para>
- </note>
- <note>
- <para>
- The new action is also displayed in red color in the items list.
- Red color is used as an indicator that the item
- is invalid, that is that the item cannot be candidate to be displayed in a
- &nautilus; context menu because some of its informations are missing or erroneous.
- Here, and though this newly inserted action has some suitable defaults, it lacks a
- command to be executed to be considered valid by &appname;
- </para>
- </note>
-
<sect3 id="usage-create-action-where">
<title>Where should appear the action ?</title>
<para>
@@ -254,699 +178,7 @@
</para>
</tip>
</sect4>
-
- <sect4 id="usage-create-action-display-icon">
- <title>Choosing an icon</title>
- <para>
- You have two ways of choosing the icon associated to your action.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Click on the dropdown list to select an icon among standard
- themed icons of your desktop environment.
- </para>
- </listitem>
- <listitem>
- <para>
- Click on the <guibutton>Browse</guibutton> button to search
- for an image in the filesystem.
- </para>
- </listitem>
- </itemizedlist>
- </sect4>
- </sect3>
-
- <sect3 id="usage-create-action-when">
- <title>When the action will it be displayed ?</title>
- <para>
- Whether your action is actually displayed in &nautilus; file-manager
- context menus and toolbar depends of the conditions you will define
- for it.
- </para>
- <para>
- All defined conditions must be satisfied by the current file-manager
- selection (resp. location) in order your action be displayed.
- </para>
-
- <sect4 id="usage-create-action-when-basenames">
- <title>Basenames</title>
- <figure id="nact-FIG-tab-basenames">
- <title>Basename-based conditions</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-basenames-tab.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Shows the tab which lets you define basename-based conditions.</phrase>
- </textobject>
- <caption>
- <para>The basename-based conditions tab</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
- <para>
- You may define that your action will only appear depending on the basenames
- of the items currently selected in the file-manager. You may define that each
- item of the selection must meet some sort of condition; and you may simultaneously
- decide that none of the selected item(s) can have some other sort of basename.
- </para>
- <para>
- Defining a new basename-based condition involves only two simple steps.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Press <keycap>Insert</keycap> or click on
- <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
- button to insert a new condition filter
- </para>
- <tip>
- <para>
- A condition may use «sp;<literal>*</literal>&spraquo; or
- «sp;<literal>?</literal>&spraquo; wildcard characters.
- </para>
- </tip>
- </listitem>
- <listitem>
- <para>
- Click on the <guilabel>Must match one of</guilabel> or
- <guilabel>Must not match any of</guilabel> radio button in the same
- row to set a «sp;must have&spraquo; or
- «sp;must not have&spraquo; condition.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- Depending of your target operating system, make sure that the
- <guilabel>Match case</guilabel> checkbox is activated (or not).
- </para>
- <itemizedlist>
- <listitem>
- <para>
- When activated, all filters are considered as case sensitive,
- which means that <filename>/my/file</filename> filename is
- considered distinct from <filename>My/File</filename> one.
- </para>
- <para>
- This is the default behavior on Unix-like systems.
- </para>
- </listitem>
- <listitem>
- <para>
- When disactivated, filters are considered as case insensitive,
- which means that <filename>/my/file</filename> and
- <filename>My/File</filename> filenames are considered the same
- name.
- </para>
- <para>
- This is most probably what you want if you target some sort of
- &windows; system.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- When the action is examined to see if it should be displayed, the basename
- of each currently selected item is compared to the list of these basename-based
- conditions for this action.
- </para>
- <para>
- By default, the basename-based condition is just one
- «sp;<literal>must match *</literal>&spraquo; condition.
- This means that basenames are not considered as a relevant condition
- for the action.
- </para>
- </sect4>
-
- <sect4 id="usage-create-action-when-mimetypes">
- <title>Mimetypes</title>
- <figure id="nact-FIG-tab-mimetypes">
- <title>Mimetype-based conditions</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-mimetypes-tab.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Shows the tab which lets you define mimetype-based conditions.</phrase>
- </textobject>
- <caption>
- <para>The mimetype-based conditions tab</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
- <para>
- You may define that your action will only appear depending on the mimetypes
- of the items currently selected in the file-manager. You may define that each
- item of the selection must meet some sort of condition; and you may simultaneously
- decide that none of the selected item(s) can have some other sort of mimetype.
- </para>
- <para>
- Defining a new mimetype-based condition involves only two simple steps.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Press <keycap>Insert</keycap> or click on
- <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
- button to insert a new condition filter
- </para>
- <para>
- A mimetype must be defined as a <literal>group/subgroup</literal>
- group.
- </para>
- <para>
- Some sort of wildcards are accepted.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- The «sp;<literal>*/*</literal>&spraquo; literal
- matches all mimetypes. As a convenient shortcut, the
- «sp;<literal>*</literal>&spraquo; literal is
- also accepted for the same purpose.
- </para>
- </listitem>
- <listitem>
- <para>
- A «sp;<literal>group/*</literal>&spraquo; string
- matches all subgroups of <literal>group</literal> mimetype.
- </para>
- </listitem>
- </itemizedlist>
- <note>
- <para>
- The «sp;<literal>*/subgroup</literal>&spraquo; string
- is not accepted as a valid wildcard.
- </para>
- </note>
- </listitem>
- <listitem>
- <para>
- Click on the <guilabel>Must match one of</guilabel> or
- <guilabel>Must not match any of</guilabel> radio button in the same
- row to set a «sp;must have&spraquo; or
- «sp;must not have&spraquo; condition.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- When the action is examined to see if it should be displayed, the mimetype
- of each currently selected item is compared to the list of these mimetype-based
- conditions for this action.
- </para>
- <para>
- By default, the mimetype-based condition is just one
- «sp;<literal>must match */*</literal>&spraquo; condition.
- This means that mimetypes are not considered as a relevant condition
- for the action.
- </para>
- <example>
- <title>Example of usual mimetypes</title>
- <variablelist>
- <varlistentry>
- <term>
- all/all
- </term>
- <listitem>
- <para>
- Matches all items.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- all/allfiles
- </term>
- <listitem>
- <para>
- Matches all regular files.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- inode/directory
- </term>
- <listitem>
- <para>
- Matches only directories.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </example>
- </sect4>
-
- <sect4 id="usage-create-action-when-folders">
- <title>Folders</title>
- <figure id="nact-FIG-tab-folders">
- <title>Folder-based conditions</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-folders-tab.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Shows the tab which lets you define folder-based conditions.</phrase>
- </textobject>
- <caption>
- <para>The folder-based conditions tab</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
- <para>
- You may define that your action will only appear depending on the directory
- the items currently selected in the file-manager are located in.
- You may define that each item of the selection must be located in one
- hierarchy or in another; and you may simultaneously
- decide that none of the selected item(s) can be located in some other
- hierarchy.
- </para>
- <para>
- Defining a new folder-based condition involves only two simple steps.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Press <keycap>Insert</keycap> or click on
- <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
- button to insert a new condition filter, or click on
- <guibutton>Browse</guibutton> to select a folder on the filesystem.
- </para>
- <para>
- A folder-based condition must be understood as the specification
- of the hierarchy in which the currently examined item should (or
- should not) stay.
- </para>
- <note>
- <para>
- The «sp;<literal>*</literal>&spraquo; and
- «sp;<literal>?</literal>&spraquo; characters
- are accepted as wildcards at any level of the defined
- folder filter.
- </para>
- </note>
- </listitem>
- <listitem>
- <para>
- Click on the <guilabel>Must match one of</guilabel> or
- <guilabel>Must not match any of</guilabel> radio button in the same
- row to set a «sp;must have&spraquo; or
- «sp;must not have&spraquo; condition.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- When the action is examined to see if it should be displayed, the location
- of each currently selected item is compared to the list of these folder-based
- conditions for this action.
- </para>
- <para>
- By default, the folder-based condition is just one
- «sp;<literal>must match /</literal>&spraquo; condition.
- As <literal>/</literal> is always the top of an Unix-like filesystem,
- then all selected files always match this condition.
- </para>
- <note>
- <para>
- If you target a &windows; system, then this default value may
- not be what you actually want.
- </para>
- </note>
- </sect4>
-
- <sect4 id="usage-create-action-when-schemes">
- <title>Schemes</title>
- <figure id="nact-FIG-tab-schemes">
- <title>Scheme-based conditions</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-schemes-tab.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Shows the tab which lets you define scheme-based conditions.</phrase>
- </textobject>
- <caption>
- <para>The scheme-based conditions tab</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
- <para>
- You may define that your action will only appear depending on the schemes
- of the URIs of the items currently selected in the file-manager.
- You may define that each item of the selection must have some scheme;
- and you may simultaneously
- decide that none of the selected item(s) may have some other scheme.
- </para>
- <para>
- Defining a new scheme-based condition involves only two simple steps.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Press <keycap>Insert</keycap> or click on
- <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
- button to insert a new condition filter, or click on
- <guibutton>Common</guibutton> to select a scheme among these
- defined as default schemes in
- <menuchoice>
- <guimenu>Edit</guimenu>
- <guimenuitem>Preferences</guimenuitem>
- </menuchoice>.
- </para>
- <para>
- Scheme-based conditions only accept
- «sp;<literal>*</literal>&spraquo; wildcard,
- which stands for «sp;any scheme&spraquo;.
- </para>
- </listitem>
- <listitem>
- <para>
- Click on the <guilabel>Must match one of</guilabel> or
- <guilabel>Must not match any of</guilabel> radio button in the same
- row to set a «sp;must have&spraquo; or
- «sp;must not have&spraquo; condition.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- When the action is examined to see if it should be displayed, the
- scheme of the URI
- of each currently selected item is compared to the list of these
- scheme-based conditions for this action.
- </para>
- <para>
- By default, the folder-based condition is just one
- «sp;<literal>must match *</literal>&spraquo; condition,
- which means that schemes are not relevant for this action.
- </para>
- </sect4>
-
- <sect4 id="usage-create-action-when-capabilities">
- <title>Capabilities</title>
- <para>
- Capabilities are some properties that a file may exhibit to the user.
- </para>
- <figure id="nact-FIG-add-capability">
- <title>Managed capabilities</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-new-capability.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Shows the list of managed capabilities.</phrase>
- </textobject>
- <caption>
- <para>The list of managed capabilities</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
- <para>
- But the <literal>Local</literal> capability, all others are dependant
- of the user who executes the command.
- </para>
- <figure id="nact-FIG-tab-capabilities">
- <title>Capability-based conditions</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-capabilities-tab.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Shows the tab which lets you define capability-based conditions.</phrase>
- </textobject>
- <caption>
- <para>The capability-based conditions tab</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
- <para>
- You may so decide that your action will appear, or not, depending
- on the capabilities of the selected item(s) <abbrev>vs.</abbrev>
- the current user.
- </para>
- <para>
- Defining a new capability-based condition involves only two simple steps.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Press <keycap>Insert</keycap> or click on
- <guibutton><inlinegraphic fileref="figures/add.png"/></guibutton>
- button to insert a new condition filter.
- </para>
- </listitem>
- <listitem>
- <para>
- Click on the <guilabel>Must match one of</guilabel> or
- <guilabel>Must not match any of</guilabel> radio button in the same
- row to set a «sp;must have&spraquo; or
- «sp;must not have&spraquo; condition.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- When the action is examined to see if it should be displayed, this list
- of capabilities that selected item(s) must match (or not) is compared
- to those exhibited to the user.
- </para>
- <para>
- By default, the capability-based condition list is empty. This means
- that capabilities are not relevant for this action.
- </para>
- <note>
- <para>
- If you target a &windows; system, then this default value may
- not be what you actually want.
- </para>
- </note>
- </sect4>
-
- <sect4 id="usage-create-action-when-environment">
- <title>Environment</title>
- <figure id="nact-FIG-tab-environment">
- <title>Environment-based conditions</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-environment-tab.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Shows the tab which lets you define environment-based conditions.</phrase>
- </textobject>
- <caption>
- <para>The environment-based conditions tab</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
-
- <sect5 id="usage-create-action-when-environment-count">
- <title>Selection count</title>
- <para>
- You may define that your action will only appear if the current
- selection in the file-manager has some precise count.
- </para>
- <example>
- <title>A selection count use case</title>
- <para>
- If your action consists in displaying the difference between
- two files, you may define here
- <guilabel>Count = (equal to) 2</guilabel>.
- </para>
- </example>
- <para>
- To define a selection count condition
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Select in the dropdown list the operator you want apply
- to the selection count
- </para>
- <simplelist type="vert">
- <member><literal>< (strictly less than)</literal></member>
- <member><literal>= (equal to)</literal></member>
- <member><literal>> (strictly greather than)</literal></member>
- </simplelist>
- </listitem>
- <listitem>
- <para>
- Enter the reference count you wish.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- The selection count defaults to
- <guilabel>Count > (strictly greater than) 0</guilabel>
- which means that the action will be candidate to be displayed
- as soon as at least one item is selected in the file-manager.
- </para>
- </sect5>
-
- <sect5 id="usage-create-action-when-environment-desktop">
- <title>Desktop environment</title>
- <para>
- You may define that your action will only appear in some given
- desktop environments, or, contrarily, will not appear in some
- given desktop environments.
- </para>
- <para>
- To define the desktop environment condition
- </para>
- <orderedlist>
- <listitem>
- <para>
- First select the type of filter
- </para>
- <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
- environment(s) ?</member>
- <member>does your action should never appeat in some
- desktop environment(s) ?</member>
- </simplelist>
- </listitem>
- <listitem>
- <para>
- If your action does not should always appear, then
- select the relevant desktop environment(s) in the listbox
- in the right side.
- </para>
- </listitem>
- </orderedlist>
- <para>
- The target desktop environment condition defaults to
- <guilabel>Always appear</guilabel>
- which means that the action will be candidate to be displayed
- regarding of the current desktop environment.
- </para>
- </sect5>
-
- <sect5 id="usage-create-action-when-environment-executable">
- <title>Presence of an executable</title>
- <para>
- You may define that your action will only appear in some given
- file is present on the filesystem and is executable.
- </para>
- <para>
- To define the relevant file, enter its full filename in the
- <guilabel>Appears if the file is executable</guilabel> entry
- box, or click on <guibutton>Browse</guibutton> to select a file
- on the filesystem.
- </para>
- <para>
- Leave the field empty if this condition is not relevant for
- your action.
- </para>
- <tip>
- <para>
- You may embed some parameters in the searched filename or its options.
- These parameters will be dynamically substituted at runtime with values
- which will depend of currently selected item(s).
- </para>
- </tip>
- </sect5>
-
- <sect5 id="usage-create-action-when-environment-dbus">
- <title>D-Bus-registered name</title>
- <para>
- You may define that your action will only appear in some given
- name is registered on D-Bus system at runtime.
- </para>
- <para>
- To define the relevant name, enter it in the
- <guilabel>Appears if the name is registered on D-Bus</guilabel>
- entry box.
- </para>
- <para>
- Leave the field empty if this condition is not relevant for
- your action.
- </para>
- <tip>
- <para>
- You may embed some parameters in the searched name.
- These parameters will be dynamically substituted at runtime with values
- which will depend of currently selected item(s).
- </para>
- </tip>
- </sect5>
-
- <sect5 id="usage-create-action-when-environment-true">
- <title>Customized condition</title>
- <para>
- You may define that your action will only appear in 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.
- </para>
- <para>
- To define the command, enter it in the
- <guilabel>Appears if the command outputs "true"</guilabel>
- entry box.
- </para>
- <para>
- Leave the field empty if this condition is not relevant for
- your action.
- </para>
- <tip>
- <para>
- You may embed some parameters in the executed filename or its options.
- These parameters will be dynamically substituted at runtime with values
- which will depend of currently selected item(s).
- </para>
- </tip>
- </sect5>
-
- <sect5 id="usage-create-action-when-environment-run">
- <title>Running process</title>
- <para>
- You may define that your action will only appear in some given
- binary is currently running.
- </para>
- <para>
- To define the binary, enter its name in the
- <guilabel>Appears if the binary is running</guilabel>
- entry box, or click on <guibutton>Browse</guibutton> to select
- a file on the filesystem.
- </para>
- <note>
- <para>
- Even if you enter here the full filename of a binary, only
- its basename will be searched for in the processes list
- at runtime.
- </para>
- </note>
- <para>
- Leave the field empty if this condition is not relevant for
- your action.
- </para>
- <tip>
- <para>
- You may embed some parameters in the searched name.
- These parameters will be dynamically substituted at runtime with values
- which will depend of currently selected item(s).
- </para>
- </tip>
- </sect5>
- </sect4>
-
</sect3>
- <!-- end of sect3 - conditions section -->
<sect3 id="usage-create-action-what">
<title>What the action should it execute ?</title>
@@ -1160,12 +392,6 @@
</para>
</sect2>
- <sect2 id="usage-profile">
- <title>Defining more profiles</title>
- <para>
- </para>
- </sect2>
-
<sect2 id="usage-edit">
<title>Editing</title>
<para>
@@ -1189,6 +415,3 @@
<para>
</para>
</sect2>
-
- </sect1>
- <!-- end of sect1 - using nautils-actions-config-tool -->
diff --git a/doc/nact/C/nautilus-actions-config-tool.xml b/doc/nact/C/nautilus-actions-config-tool.xml
index 7527676..7289a9d 100644
--- a/doc/nact/C/nautilus-actions-config-tool.xml
+++ b/doc/nact/C/nautilus-actions-config-tool.xml
@@ -14,16 +14,22 @@
<!-- product name used -->
<!ENTITY nautilus "<productname>Nautilus</productname>">
<!ENTITY windows "<productname>Windows</productname>">
+ <!ENTITY zenity "<productname>Zenity</productname>">
<!-- the synopsys of the document -->
<!ENTITY articleinfo SYSTEM "articleinfo.xml">
<!ENTITY legalnotice SYSTEM "legalnotice.xml">
- <!ENTITY usage SYSTEM "nact-usage.xml">
+ <!ENTITY starting SYSTEM "nact-starting.xml">
+ <!ENTITY conditions SYSTEM "nact-conditions.xml">
+ <!ENTITY profiles SYSTEM "nact-profiles.xml">
+ <!ENTITY sorting SYSTEM "nact-sorting.xml">
<!ENTITY preferences SYSTEM "nact-prefs.xml">
<!ENTITY misc-infos SYSTEM "nact-misc.xml">
<!ENTITY gnu-fdl SYSTEM "appendix-gnu-fdl-1.3.xml">
- <!-- some user-defined internal entities -->
+ <!-- some user-defined internal entities
+ merely because it appears that xsltproc may sometimes loose
+ its path to the DocBook DTD -->
<!ENTITY laquosp "« ">
<!ENTITY spraquo " »">
]>
@@ -51,9 +57,10 @@
<sect1 id="introduction">
<title>Introduction</title>
<para>
- &prodname; is a &nautilus; extension which lets the user
- define new actions in the file-manager context menus, and group them
- into his own menus.
+ &prodname; is a &nautilus; extension whose principal function
+ is to allow the user to add arbitrary actions to the file manager
+ context menus. These actions may be organized in menus and submenus,
+ exported and shared with other desktop environments.
</para>
<para>
The &appname; application is the user interface which lets you precisely
@@ -119,409 +126,28 @@
<sect1 id="getting-started">
<title>Getting Started</title>
-
- <sect2 id="getting-started-starting">
- <title>Starting &appname;</title>
- <para>
- You can start &appname; in the following ways:
- </para>
- <variablelist>
- <varlistentry>
- <term><guimenu>System</guimenu> menu</term>
- <listitem>
- <para>
- Choose
- <menuchoice>
- <guisubmenu>Preferences</guisubmenu>
- <guimenuitem>Look and Feel</guimenuitem>
- </menuchoice>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Command line</term>
- <listitem>
- <para>
- To start &appname; from a command line, type the following command,
- then press <keycap>Return</keycap>:
- </para>
- <para>
- <command><filename>nautilus-actions-config-tool</filename></command>
- </para>
- <tip>
- <para>
- To view other command line options that are available,
- type
- </para>
- <para>
- <command>
- <filename>nautilus-actions-config-tool</filename>
- <option>--help-all</option>
- </command>
- </para>
- <para>
- then press <keycap>Return</keycap>.
- </para>
- </tip>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="getting-started-first-run">
- <title>The first run</title>
- <para>
- When you start &appname;, the following window is displayed.
- </para>
- <figure id="nact-FIG-main-empty">
- <title>&appname; Start Up Window</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-main-empty.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>
- Shows &appname; main window.
- Contains menubar, toolbar, display area,
- an empty items list in the left, several disabled properties tabs,
- and statusbar.
- </phrase>
- </textobject>
- <caption>
- <para>The empty &appname; main window</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
-
- <!-- Include any descriptions of the GUI immediately after the screenshot
- of the main UI, for example, the items on the menubar and on the toolbar.
- This section is optional. -->
-
- <para>
- The &appname; main window contains the following elements:
- </para>
- <variablelist>
- <varlistentry>
- <term>Menubar.</term>
- <listitem>
- <para>
- The menus on the menubar contain all of the commands
- you need to use in &appname;.
- </para>
- <para>
- Shortcuts are available for some commands:
- </para>
- <variablelist>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Ctrl</keycap>
- <keycap>N</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Create a new action.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Ctrl</keycap>
- <keycap>S</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Save modified actions and menus.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Ctrl</keycap>
- <keycap>Q</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Quit the application.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Ctrl</keycap>
- <keycap>X</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Cut the current selection, keeping it in the clipboard.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Ctrl</keycap>
- <keycap>C</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Copy the current selection to the clipboard.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Ctrl</keycap>
- <keycap>V</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Insert the content of the clipboard before the current item.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Shift</keycap>
- <keycap>Ctrl</keycap>
- <keycap>V</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Insert the content of the clipboard as subitem(s) of the current item.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>Delete</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Delete the current selection.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>F5</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Reload the actions and menus.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <keycombo>
- <keycap>F1</keycap>
- </keycombo>
- </term>
- <listitem>
- <para>
- Display the help.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Toolbar.</term>
- <listitem>
- <para>
- Several toolbars may be displayed below the menubar, depending of
- your choices in the
- <menuchoice>
- <guimenu>View</guimenu>
- <guimenuitem>Toolbars</guimenuitem>
- </menuchoice> submenu.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Items list.</term>
- <listitem>
- <para>
- The list on the left of the main window contains all items,
- whether they are actions or menus, currently available for edition in
- &appname;.
- </para>
- <para>
- Items may be sorted in ascending or descending alphabetical order, or
- not sorted at all, directly organized and managed by the user.
- </para>
- <para>
- Invalid items are displayed in red color.
- </para>
- <para>
- Modified items are displayed in italic characters.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Properties tabs.</term>
- <listitem>
- <para>
- The right part of the main window displays all is needed to define
- how, when and where actions and menus should be displayed.
- </para>
- <variablelist>
- <varlistentry>
- <term>
- Action/Menu
- </term>
- <listitem>
- <para>
- Define in which &nautilus; menus the item should appear, and
- how it will be displayed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Command
- </term>
- <listitem>
- <para>
- Specify which command to execute, and which parameters
- pass to it.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Execution
- </term>
- <listitem>
- <para>
- Specify how the command should be executed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Basenames
- </term>
- <listitem>
- <para>
- Define the basename filters the &nautilus; selection must satisfy
- in order the action or menu be candidate for display.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Mimetypes
- </term>
- <listitem>
- <para>
- Define the mimetype filters the &nautilus; selection must satisfy
- in order the action or menu be candidate for display.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Folders
- </term>
- <listitem>
- <para>
- Define the folder filters the &nautilus; selection must satisfy
- in order the action or menu be candidate for display.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Schemes
- </term>
- <listitem>
- <para>
- Define the scheme filters the &nautilus; selection must satisfy
- in order the action or menu be candidate for display.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Capabilities
- </term>
- <listitem>
- <para>
- Define the capability filters the &nautilus; selection must satisfy
- in order the action or menu be candidate for display.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Environment
- </term>
- <listitem>
- <para>
- Define some environment conditions the &nautilus; selection must satisfy
- in order the action or menu be candidate for display.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Properties
- </term>
- <listitem>
- <para>
- Display item properties.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Statusbar.</term>
- <listitem>
- <para>
- The statusbar displays some status informations about the
- currently selected row in the items list.
- </para>
- <para>
- When no relevant information is to be displayed, the statusbar
- displays the count of loaded menus, actions and profiles.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
+ &starting;
</sect1>
<!-- ============================== Usage ============================= -->
- &usage;
-
-<!-- ========================= Preferences ============================ -->
- &preferences;
+<!-- Use this section to describe how to use the application to perform the
+ tasks for which the application is designed. -->
+
+ <sect1 id="usage">
+ <title>Using &appname;</title>
+ &conditions;
+ &profiles;
+ &sorting;
+ &preferences;
+ </sect1>
<!-- ============================ Misc ================================ -->
- &misc-infos;
+<!-- informations I do not know where to put -->
+
+ <sect1 id="misc">
+ <title>Miscellaneous informations</title>
+ &misc-infos;
+ </sect1>
<!-- ============================ Bugs ================================ -->
<!-- This section is optional and is commented out by default.
diff --git a/doc/nact/Makefile.am b/doc/nact/Makefile.am
index e38242a..98ef918 100644
--- a/doc/nact/Makefile.am
+++ b/doc/nact/Makefile.am
@@ -36,12 +36,15 @@ dist-hook: doc-dist-hook
DOC_MODULE = nautilus-actions-config-tool
DOC_ENTITIES = \
+ appendix-gnu-fdl-1.3.xml \
articleinfo.xml \
- nact-usage.xml \
- nact-prefs.xml \
- nact-misc.xml \
legalnotice.xml \
- appendix-gnu-fdl-1.3.xml \
+ nact-conditions.xml \
+ nact-misc.xml \
+ nact-prefs.xml \
+ nact-profiles.xml \
+ nact-sorting.xml \
+ nact-starting.xml \
$(NULL)
DOC_INCLUDES = \
@@ -50,6 +53,7 @@ DOC_INCLUDES = \
DOC_FIGURES = \
figures/add.png \
figures/remove.png \
+ figures/nact-action-tab.png \
figures/nact-basenames-tab.png \
figures/nact-capabilities-tab.png \
figures/nact-command-tab.png \
@@ -60,6 +64,7 @@ DOC_FIGURES = \
figures/nact-main-empty.png \
figures/nact-mimetypes-tab.png \
figures/nact-new-capability.png \
+ figures/nact-new-scheme.png \
figures/nact-preferences-export.png \
figures/nact-preferences-import.png \
figures/nact-preferences-io-providers.png \
@@ -68,6 +73,9 @@ DOC_FIGURES = \
figures/nact-preferences-ui.png \
figures/nact-properties-tab.png \
figures/nact-schemes-tab.png \
+ figures/start-context-menu.png \
+ figures/start-context-menu-nautilus.png \
+ figures/start-zenity-result.png \
$(NULL)
clean-local :
diff --git a/nautilus-actions.doap b/nautilus-actions.doap
index e507c25..199c858 100644
--- a/nautilus-actions.doap
+++ b/nautilus-actions.doap
@@ -11,9 +11,10 @@
<shortdesc xml:lang="en">Nautilus extension which offers user configurable context menu actions</shortdesc>
<description xml:lang="en">
- Nautilus-actions is an extension for nautilus
- which allow to add arbitrary program to launch through the nautilus
- popup menu of selected files.
+ Nautilus-Actions is a Nautilus extension whose principal function
+ is to allow the user to add arbitrary actions to the file manager
+ context menus. These actions may be organized in menus and submenus,
+ exported and shared with other desktop environments.
</description>
<homepage rdf:resource="http://www.nautilus-actions.org"; />
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
