File: fma-starting.xml

package info (click to toggle)
filemanager-actions 3.4-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 27,428 kB
  • sloc: ansic: 48,857; xml: 17,767; sh: 4,662; makefile: 1,375; lisp: 9
file content (738 lines) | stat: -rw-r--r-- 25,538 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
    <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>FileManager-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>fma-config-tool</filename></command>
            </para>
            <para>
              <!-- i18n: "Return" is a key name -->
              then press <keycap>Return</keycap>.
            </para>
            <tip>
              <para>
                To view available command line options, type:
              </para>
              <para>
                <command>
                  <filename>fma-config-tool</filename>
                  <option>--help-all</option>
                </command>
              </para>
              <para>
                <!-- i18n: "Return" is a key name -->
                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="fma-FIG-main-empty">
        <title>&appname; Start Up Window</title>
        <screenshot>
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/fma-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, being 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>Sort buttons</term>
          <listitem>
            <para>
              Three buttons allow you to toggle between sort modes.
            </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 file manager 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 file manager 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 file manager 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 file manager 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 file manager 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 file manager 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 file manager
                    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 information 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>
            <para>
              <!-- i18n: "read-only" may be translated -->
              The &laquosp;read-only&spraquo; icon 
              <inlinegraphic fileref="figures/read-only.png" />
              is displayed in
              the right of the statusbar when appropriate.
            </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 information 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 will allow you 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,
        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="fma-FIG-tab-action">
        <title>Default properties of a new action</title>
        <screenshot>
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/fma-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>
        <!-- i18n: "Items list" is a UI label -->
        In the <guilabel>Items list</guilabel>, 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 that there is some pending modifications,
        an asterisk (&laquosp;<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>
            <!-- i18n: "My first action" is a user entry -->
            Enter <userinput>My first action</userinput>
            <!-- i18n: "Context label" is a UI label -->
            in the <guilabel>Context label</guilabel> entry box.
          </para>
          <para>
            <!-- i18n: "Context label" is a UI label -->
            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>
         <para>
            The label is a mandatory property of your action. If it
            happens to be empty, then your action will be considered as
            invalid by &prodname;: it will be displayed in red in
            <!-- i18n: "Items list" is a UI label -->
            <guilabel>Items list</guilabel> and will never be candidate
            to be displayed in the file manager context menus.
          </para>
        </listitem>
        <listitem>
          <para>
            Enter <userinput>This will execute an action with some parameters</userinput>
            <!-- i18n: "Tooltip" is a UI label -->
            in the <guilabel>Tooltip</guilabel> entry box.
          </para>
          <para>
            <!-- i18n: "Tooltip" is a UI label -->
            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 <inlinegraphic fileref="figures/stock-icon-about.png" /> 
            <!-- i18n: "Icon" is a UI label -->
            in the <guilabel>Icon</guilabel> drop-down list.
          </para>
          <para>
            <!-- i18n: "Icon" is a UI label -->
            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>
                <!-- i18n: "Icon" is a UI label -->
                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>
        <!-- i18n: "Command" is a UI label -->
        Click on the <guilabel>Command</guilabel> tab to show the page
        which will permit you to enter the command.
      </para>
      <figure id="fma-FIG-tab-command">
        <title>Command page</title>
        <screenshot>
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/fma-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
            <!-- i18n: "Path" is a UI label -->
            <guilabel>Path</guilabel> entry box.
          </para>
          <para>
            <!-- i18n: "Path" is a UI label -->
            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>
                <!-- i18n: "Path" is a UI label -->
                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>
          <para>
            If the command you enter does not have an absolute path,
            then it will be searched for in the <envar>PATH</envar>
            variable at execution time.
          </para>
        </listitem>
        <listitem>
          <para>
            <!-- i18n: only "selected item(s)" is translatable -->
            Enter <userinput>--info --text='%c selected item(s): %U'</userinput>
            <!-- i18n: "Parameters" is a UI label -->
            in the <guilabel>Parameters</guilabel>
            entry box.
          </para>
          <para>
            <!-- i18n: "Parameters" is a UI label -->
            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>
          <para>
            <!-- i18n: "Path" and "Parameters" are UI labels -->
            If both <guilabel>Path</guilabel> and <guilabel>Parameters</guilabel>
            are empty, then this action will be considered as invalid:
            <!-- i18n: "Items list" is a UI label -->
            it will be displayed in red in <guilabel>Items list</guilabel>
            and will never be candidate to be displayed in the file
            manager context menus.
          </para>
        </listitem>
      </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>
        The file manager automatically takes into account your new action,
        and displays it in its context menu.
      </para>
      <figure id="fma-FIG-start-nautilus-context">
        <title>Your first action in the file manager 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 file manager context menu.
              </phrase>
            </textobject>
            <caption>
              <para>Your first action in the file manager context menu</para>
            </caption>
          </mediaobject>
        </screenshot>
      </figure>
      <para>
        Cliking of the item in the file manager context menu activates it,
        and executes the corresponding command.
      </para>
      <figure id="fma-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>