nautilus-actions-config-tool.xml 8.3 KB
Newer Older
Pierre Wieser's avatar
Pierre Wieser committed
1 2 3 4
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

  <!-- name and version of the application -->
5 6
  <!ENTITY prodname "<productname>FileManager-Actions</productname>">
  <!ENTITY appnamex "FileManager-Actions Configuration Tool">
Pierre Wieser's avatar
Pierre Wieser committed
7
  <!ENTITY appname "<application>&appnamex;</application>">
Pierre Wieser's avatar
Pierre Wieser committed
8
  <!ENTITY appversion "3.2">
Pierre Wieser's avatar
Pierre Wieser committed
9 10

  <!-- revision number and release date of this manual -->
Pierre Wieser's avatar
Pierre Wieser committed
11 12
  <!ENTITY manrevision "3.2">
  <!ENTITY mandate "January 2012">
Pierre Wieser's avatar
Pierre Wieser committed
13

Pierre Wieser's avatar
Pierre Wieser committed
14
  <!-- product name used -->
Pierre Wieser's avatar
Pierre Wieser committed
15
  <!ENTITY nautilus "<productname>Nautilus</productname>">
Pierre Wieser's avatar
Pierre Wieser committed
16
  <!ENTITY windows  "<productname>Windows</productname>">
Pierre Wieser's avatar
Pierre Wieser committed
17
  <!ENTITY zenity   "<productname>Zenity</productname>">
Pierre Wieser's avatar
Pierre Wieser committed
18

19 20 21 22 23 24
  <!-- 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;">

Pierre Wieser's avatar
Pierre Wieser committed
25 26
  <!-- other entities -->
  <!ENTITY desema "<ulink url='http://www.nautilus-actions.org/?q=node/377' type='http'>DES-EMA specification</ulink>">
27 28 29 30
  <!ENTITY asterisk       "&laquosp;<literal>*</literal>&spraquo;">
  <!ENTITY question_mark  "&laquosp;<literal>?</literal>&spraquo;">
  <!ENTITY must_match     "&laquosp;must match one of&spraquo;">
  <!ENTITY must_not_match "&laquosp;must not match any of&spraquo;">
Pierre Wieser's avatar
Pierre Wieser committed
31

Pierre Wieser's avatar
Pierre Wieser committed
32
  <!-- the synopsys of the document -->
Pierre Wieser's avatar
Pierre Wieser committed
33
  <!ENTITY articleinfo SYSTEM "articleinfo.xml">
Pierre Wieser's avatar
Pierre Wieser committed
34
  <!ENTITY legalnotice SYSTEM "legalnotice.xml">
Pierre Wieser's avatar
Pierre Wieser committed
35 36
  <!ENTITY starting    SYSTEM "nact-starting.xml">
  <!ENTITY conditions  SYSTEM "nact-conditions.xml">
Pierre Wieser's avatar
Pierre Wieser committed
37 38
  <!ENTITY where       SYSTEM "nact-where.xml">
  <!ENTITY execution   SYSTEM "nact-execution.xml">
Pierre Wieser's avatar
Pierre Wieser committed
39
  <!ENTITY profiles    SYSTEM "nact-profiles.xml">
Pierre Wieser's avatar
Pierre Wieser committed
40
  <!ENTITY menus       SYSTEM "nact-menus.xml">
Pierre Wieser's avatar
Pierre Wieser committed
41
  <!ENTITY sorting     SYSTEM "nact-sorting.xml">
Pierre Wieser's avatar
Pierre Wieser committed
42 43 44 45
  <!ENTITY edit        SYSTEM "nact-edit.xml">
  <!ENTITY save        SYSTEM "nact-save.xml">
  <!ENTITY export      SYSTEM "nact-export.xml">
  <!ENTITY import      SYSTEM "nact-import.xml">
46
  <!ENTITY preferences SYSTEM "nact-prefs.xml">
Pierre Wieser's avatar
Pierre Wieser committed
47
  <!ENTITY properties  SYSTEM "nact-properties.xml">
48
  <!ENTITY misc-infos  SYSTEM "nact-misc.xml">
Pierre Wieser's avatar
Pierre Wieser committed
49
  <!ENTITY bugs        SYSTEM "nact-bugs.xml">
Pierre Wieser's avatar
Pierre Wieser committed
50
  <!ENTITY gnu-fdl     SYSTEM "appendix-gnu-fdl-1.3.xml">
Pierre Wieser's avatar
Pierre Wieser committed
51 52 53 54 55 56
]>

<!-- ========================= Document Header ======================== -->
<!-- Please do not change the id!
     For translations, change lang to appropriate code -->

Pierre Wieser's avatar
Pierre Wieser committed
57
<article id="index" lang="en">
Pierre Wieser's avatar
Pierre Wieser committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

  &articleinfo;

  <indexterm zone="index">
    <primary>&nautilus;</primary>
  </indexterm>
  <indexterm zone="index">
    <primary>&prodname;</primary>
  </indexterm>

<!-- =========================== Document Body ======================== -->
<!-- =========================== Introduction ========================= -->
<!-- Use the Introduction section to give a brief overview of what
     the application is and what it does. -->

  <sect1 id="introduction">
    <title>Introduction</title>
    <para>
Pierre Wieser's avatar
Pierre Wieser committed
76 77 78 79
      &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.
Pierre Wieser's avatar
Pierre Wieser committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    </para>
    <para>
      The &appname; application is the user interface which lets you precisely
      configure how, where and when your actions should appear in &nautilus;
      context menus, and how they will be executed.
    </para>
    <para>
      &appname; provides the following features:
    </para>
    <itemizedlist>
      <listitem>
        <para>Define and configure actions from scratch.</para>
      </listitem>
      <listitem>
        <para>Organize actions into menus, submenus and so on.</para>
      </listitem>
      <listitem>
        <para>Import and export actions and menus from and to outside world.</para>
      </listitem>
    </itemizedlist>
Pierre Wieser's avatar
Pierre Wieser committed
100
    <note>
Pierre Wieser's avatar
Pierre Wieser committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
      <para>
        &prodname; also comes with additional features such as:
      </para>
      <itemizedlist>
        <listitem>
          <para>
            A &nautilus; plugin which exports in real time to D-Bus the currently
            selected files.
          </para>
        </listitem>
        <listitem>
          <para>
            A command-line program which is able to run any action.
          </para>
          <para>
            Associated with the D-Bus interface, this program lets the user
Pierre Wieser's avatar
Pierre Wieser committed
117 118
            run any action from a keyboard shortcut, applying this action
            to the item(s) currently selected in the file manager.
Pierre Wieser's avatar
Pierre Wieser committed
119 120 121 122 123 124 125 126 127
          </para>
        </listitem>
        <listitem>
          <para>
            A command-line program which is able to create a new action.
          </para>
        </listitem>
      </itemizedlist>
      <para>
Pierre Wieser's avatar
Pierre Wieser committed
128
        All these features are more thoroughly described in the global
Pierre Wieser's avatar
Pierre Wieser committed
129 130
        &prodname; documentation.
      </para>
Pierre Wieser's avatar
Pierre Wieser committed
131
    </note>
Pierre Wieser's avatar
Pierre Wieser committed
132 133 134 135 136 137 138 139 140 141 142 143 144
  </sect1>

<!-- ========================= Getting Started ======================== -->
<!-- Use the Getting Started section to describe the steps required
     to start the application and to describe the user interface components
     of the application. If there is other information that it is important
     for readers to know before they start using the application, you should
     also include this information here.
     If the information about how to get started is very short, you can
     include it in the Introduction and omit this section. -->

  <sect1 id="getting-started">
    <title>Getting Started</title>
Pierre Wieser's avatar
Pierre Wieser committed
145
    &starting;
Pierre Wieser's avatar
Pierre Wieser committed
146 147 148
  </sect1>

<!-- ============================== Usage ============================= -->
Pierre Wieser's avatar
Pierre Wieser committed
149 150 151 152 153 154
<!-- 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;
Pierre Wieser's avatar
Pierre Wieser committed
155 156
    &where;
    &execution;
Pierre Wieser's avatar
Pierre Wieser committed
157
    &profiles;
Pierre Wieser's avatar
Pierre Wieser committed
158
    &menus;
Pierre Wieser's avatar
Pierre Wieser committed
159
    &sorting;
Pierre Wieser's avatar
Pierre Wieser committed
160 161 162 163
    &edit;
    &save;
    &export;
    &import;
Pierre Wieser's avatar
Pierre Wieser committed
164 165
    &preferences;
  </sect1>
Pierre Wieser's avatar
Pierre Wieser committed
166 167

<!-- ============================ Misc ================================ -->
Pierre Wieser's avatar
Pierre Wieser committed
168 169 170 171 172 173
<!-- informations I do not know where to put -->

  <sect1 id="misc">
    <title>Miscellaneous informations</title>
    &misc-infos;
  </sect1>
Pierre Wieser's avatar
Pierre Wieser committed
174 175 176

<!-- ============================ Bugs ================================ -->
<!-- This section is optional and is commented out by default.
Pierre Wieser's avatar
Pierre Wieser committed
177
     You can use it to describe known bugs and limitations of the
Pierre Wieser's avatar
Pierre Wieser committed
178
     program if there are any - please be frank and list all
Pierre Wieser's avatar
Pierre Wieser committed
179
     problems you know of. -->
Pierre Wieser's avatar
Pierre Wieser committed
180

Pierre Wieser's avatar
Pierre Wieser committed
181 182
  <sect1 id="bugs">
    <title>Known Bugs and Limitations</title>
Pierre Wieser's avatar
Pierre Wieser committed
183
    &bugs;
Pierre Wieser's avatar
Pierre Wieser committed
184 185 186 187
  </sect1>

<!-- =========================== About ================================ -->
<!-- This section contains info about the program (not docs), such as
Pierre Wieser's avatar
Pierre Wieser committed
188 189 190 191
      author's name(s), web page, license, feedback address. This
      section is optional: primary place for this info is "About.." box of
      the program. However, if you do wish to include this info in the
      manual, this is the place to put it.
Pierre Wieser's avatar
Pierre Wieser committed
192 193 194 195 196 197 198 199 200 201 202 203
      Alternatively, you can put this information in the title page.
  -->

  <sect1 id="about">
    <title>About &appname;</title>
    <para>
      The first version of &prodname; was initially written by
      Frederic Ruaudel (<email>grumz@grumz.net</email>) and
      Rodrigo Moya (<email>rodrigo@gnome-db.org</email>).
      It has been thoroughly improved and is currently maintained by
      Pierre Wieser (<email>pwieser@trychlos.org</email>).
    </para>
Pierre Wieser's avatar
Pierre Wieser committed
204 205 206 207 208 209
    <para>
      Artwork is due to courtesy of
      Ulisse Perusin (<email>uli.peru@gmail.com</email>) and
      DragonArtz
      (<ulink url="http://www.dragonartz.net/" type="http">http://www.dragonartz.net</ulink>).
    </para>
Pierre Wieser's avatar
Pierre Wieser committed
210 211
    <para>
      To find more information about &prodname;, please visit the
Pierre Wieser's avatar
Pierre Wieser committed
212 213
      <ulink url="http://www.nautilus-actions.org/" type="http"></ulink>
      &prodname; website.
Pierre Wieser's avatar
Pierre Wieser committed
214 215
    </para>
    <para>
Pierre Wieser's avatar
Pierre Wieser committed
216
      To report a bug or make a suggestion regarding &prodname;,
Pierre Wieser's avatar
Pierre Wieser committed
217 218 219
      the &appname; or this manual, follow the directions in the
      <ulink url="ghelp:user-guide#feedback" type="help">GNOME Feedback Page</ulink>,
      or you may prefer, at your convenience, directly open a bug
Pierre Wieser's avatar
Pierre Wieser committed
220
      or a request for enhancement in
Pierre Wieser's avatar
Pierre Wieser committed
221 222 223
      <ulink
       url="https://bugzilla.gnome.org/enter_bug.cgi?product=nautilus-actions"
       type="http">Bugzilla website</ulink>.
Pierre Wieser's avatar
Pierre Wieser committed
224 225
    </para>
  </sect1>
Pierre Wieser's avatar
Pierre Wieser committed
226 227 228

  &gnu-fdl;

Pierre Wieser's avatar
Pierre Wieser committed
229
</article>