docs/nact/C/nautilus-actions-config-tool.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   3
   4   <!-- name and version of the application -->
   5   <!ENTITY prodname "<productname>FileManager-Actions</productname>">
   6   <!ENTITY appnamex "FileManager-Actions Configuration Tool">
   7   <!ENTITY appname "<application>&appnamex;</application>">
   8   <!ENTITY appversion "3.2">
   9
  10   <!-- revision number and release date of this manual -->
  11   <!ENTITY manrevision "3.2">
  12   <!ENTITY mandate "January 2012">
  13
  14   <!-- product name used -->
  15   <!ENTITY nautilus "<productname>Nautilus</productname>">
  16   <!ENTITY windows  "<productname>Windows</productname>">
  17   <!ENTITY zenity   "<productname>Zenity</productname>">
  18
  19   <!-- some user-defined internal entities
  20        merely because it appears that xsltproc may sometimes loose
  21        its path to the DocBook DTD -->
  22   <!ENTITY laquosp "&#171;&#160;">
  23   <!ENTITY spraquo "&#160;&#187;">
  24
  25   <!-- other entities -->
  26   <!ENTITY desema "<ulink url='http://www.nautilus-actions.org/?q=node/377' type='http'>DES-EMA specification</ulink>">
  27   <!ENTITY asterisk       "&laquosp;<literal>*</literal>&spraquo;">
  28   <!ENTITY question_mark  "&laquosp;<literal>?</literal>&spraquo;">
  29   <!ENTITY must_match     "&laquosp;must match one of&spraquo;">
  30   <!ENTITY must_not_match "&laquosp;must not match any of&spraquo;">
  31
  32   <!-- the synopsys of the document -->
  33   <!ENTITY articleinfo SYSTEM "articleinfo.xml">
  34   <!ENTITY legalnotice SYSTEM "legalnotice.xml">
  35   <!ENTITY starting    SYSTEM "nact-starting.xml">
  36   <!ENTITY conditions  SYSTEM "nact-conditions.xml">
  37   <!ENTITY where       SYSTEM "nact-where.xml">
  38   <!ENTITY execution   SYSTEM "nact-execution.xml">
  39   <!ENTITY profiles    SYSTEM "nact-profiles.xml">
  40   <!ENTITY menus       SYSTEM "nact-menus.xml">
  41   <!ENTITY sorting     SYSTEM "nact-sorting.xml">
  42   <!ENTITY edit        SYSTEM "nact-edit.xml">
  43   <!ENTITY save        SYSTEM "nact-save.xml">
  44   <!ENTITY export      SYSTEM "nact-export.xml">
  45   <!ENTITY import      SYSTEM "nact-import.xml">
  46   <!ENTITY preferences SYSTEM "nact-prefs.xml">
  47   <!ENTITY properties  SYSTEM "nact-properties.xml">
  48   <!ENTITY misc-infos  SYSTEM "nact-misc.xml">
  49   <!ENTITY bugs        SYSTEM "nact-bugs.xml">
  50   <!ENTITY gnu-fdl     SYSTEM "appendix-gnu-fdl-1.3.xml">
  51 ]>
  52
  53 <!-- ========================= Document Header ======================== -->
  54 <!-- Please do not change the id!
  55      For translations, change lang to appropriate code -->
  56
  57 <article id="index" lang="en">
  58
  59   &articleinfo;
  60
  61   <indexterm zone="index">
  62     <primary>&nautilus;</primary>
  63   </indexterm>
  64   <indexterm zone="index">
  65     <primary>&prodname;</primary>
  66   </indexterm>
  67
  68 <!-- =========================== Document Body ======================== -->
  69 <!-- =========================== Introduction ========================= -->
  70 <!-- Use the Introduction section to give a brief overview of what
  71      the application is and what it does. -->
  72
  73   <sect1 id="introduction">
  74     <title>Introduction</title>
  75     <para>
  76       &prodname; is a &nautilus; extension whose principal function
  77       is to allow the user to add arbitrary actions to the file manager
  78       context menus. These actions may be organized in menus and submenus,
  79       exported and shared with other desktop environments.
  80     </para>
  81     <para>
  82       The &appname; application is the user interface which lets you precisely
  83       configure how, where and when your actions should appear in &nautilus;
  84       context menus, and how they will be executed.
  85     </para>
  86     <para>
  87       &appname; provides the following features:
  88     </para>
  89     <itemizedlist>
  90       <listitem>
  91         <para>Define and configure actions from scratch.</para>
  92       </listitem>
  93       <listitem>
  94         <para>Organize actions into menus, submenus and so on.</para>
  95       </listitem>
  96       <listitem>
  97         <para>Import and export actions and menus from and to outside world.</para>
  98       </listitem>
  99     </itemizedlist>
 100     <note>
 101       <para>
 102         &prodname; also comes with additional features such as:
 103       </para>
 104       <itemizedlist>
 105         <listitem>
 106           <para>
 107             A &nautilus; plugin which exports in real time to D-Bus the currently
 108             selected files.
 109           </para>
 110         </listitem>
 111         <listitem>
 112           <para>
 113             A command-line program which is able to run any action.
 114           </para>
 115           <para>
 116             Associated with the D-Bus interface, this program lets the user
 117             run any action from a keyboard shortcut, applying this action
 118             to the item(s) currently selected in the file manager.
 119           </para>
 120         </listitem>
 121         <listitem>
 122           <para>
 123             A command-line program which is able to create a new action.
 124           </para>
 125         </listitem>
 126       </itemizedlist>
 127       <para>
 128         All these features are more thoroughly described in the global
 129         &prodname; documentation.
 130       </para>
 131     </note>
 132   </sect1>
 133
 134 <!-- ========================= Getting Started ======================== -->
 135 <!-- Use the Getting Started section to describe the steps required
 136      to start the application and to describe the user interface components
 137      of the application. If there is other information that it is important
 138      for readers to know before they start using the application, you should
 139      also include this information here.
 140      If the information about how to get started is very short, you can
 141      include it in the Introduction and omit this section. -->
 142
 143   <sect1 id="getting-started">
 144     <title>Getting Started</title>
 145     &starting;
 146   </sect1>
 147
 148 <!-- ============================== Usage ============================= -->
 149 <!-- Use this section to describe how to use the application to perform the
 150      tasks for which the application is designed. -->
 151
 152   <sect1 id="usage">
 153     <title>Using &appname;</title>
 154     &conditions;
 155     &where;
 156     &execution;
 157     &profiles;
 158     &menus;
 159     &sorting;
 160     &edit;
 161     &save;
 162     &export;
 163     &import;
 164     &preferences;
 165   </sect1>
 166
 167 <!-- ============================ Misc ================================ -->
 168 <!-- informations I do not know where to put -->
 169
 170   <sect1 id="misc">
 171     <title>Miscellaneous informations</title>
 172     &misc-infos;
 173   </sect1>
 174
 175 <!-- ============================ Bugs ================================ -->
 176 <!-- This section is optional and is commented out by default.
 177      You can use it to describe known bugs and limitations of the
 178      program if there are any - please be frank and list all
 179      problems you know of. -->
 180
 181   <sect1 id="bugs">
 182     <title>Known Bugs and Limitations</title>
 183     &bugs;
 184   </sect1>
 185
 186 <!-- =========================== About ================================ -->
 187 <!-- This section contains info about the program (not docs), such as
 188       author's name(s), web page, license, feedback address. This
 189       section is optional: primary place for this info is "About.." box of
 190       the program. However, if you do wish to include this info in the
 191       manual, this is the place to put it.
 192       Alternatively, you can put this information in the title page.
 193   -->
 194
 195   <sect1 id="about">
 196     <title>About &appname;</title>
 197     <para>
 198       The first version of &prodname; was initially written by
 199       Frederic Ruaudel (<email>grumz@grumz.net</email>) and
 200       Rodrigo Moya (<email>rodrigo@gnome-db.org</email>).
 201       It has been thoroughly improved and is currently maintained by
 202       Pierre Wieser (<email>pwieser@trychlos.org</email>).
 203     </para>
 204     <para>
 205       Artwork is due to courtesy of
 206       Ulisse Perusin (<email>uli.peru@gmail.com</email>) and
 207       DragonArtz
 208       (<ulink url="http://www.dragonartz.net/" type="http">http://www.dragonartz.net</ulink>).
 209     </para>
 210     <para>
 211       To find more information about &prodname;, please visit the
 212       <ulink url="http://www.nautilus-actions.org/" type="http"></ulink>
 213       &prodname; website.
 214     </para>
 215     <para>
 216       To report a bug or make a suggestion regarding &prodname;,
 217       the &appname; or this manual, follow the directions in the
 218       <ulink url="ghelp:user-guide#feedback" type="help">GNOME Feedback Page</ulink>,
 219       or you may prefer, at your convenience, directly open a bug
 220       or a request for enhancement in
 221       <ulink
 222        url="https://bugzilla.gnome.org/enter_bug.cgi?product=nautilus-actions"
 223        type="http">Bugzilla website</ulink>.
 224     </para>
 225   </sect1>
 226
 227   &gnu-fdl;
 228
 229 </article>