Commit c7cb6209 authored by Pierre Wieser's avatar Pierre Wieser

Update NACT user's manual

parent a7f9bf06
......@@ -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>
......
doc/nact/C/figures/nact-main-empty.png

42.5 KB | W: | H:

doc/nact/C/figures/nact-main-empty.png

42.1 KB | W: | H:

doc/nact/C/figures/nact-main-empty.png
doc/nact/C/figures/nact-main-empty.png
doc/nact/C/figures/nact-main-empty.png
doc/nact/C/figures/nact-main-empty.png
  • 2-up
  • Swipe
  • Onion skin
This diff is collapsed.
<!-- ============================ 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>
<!-- ========================= 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>
<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>
<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
&laquosp;<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
This diff is collapsed.
This diff is collapsed.
......@@ -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 "&#171;&#160;">
<!ENTITY spraquo "&#160;&#187;">
]>
......@@ -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>
<!-- =========================