doc/tutorials/actions.txt

0001 A Short Tutorial for the User Actions System
0002 ============================================
0003
0004 Go to the Konfigurator and choose "Useractions". There you can manage all your
0005 actions. If you add a new action, you get an empty input-mask where you can
0006 enter all the properties. The action will be added as soon as you press "OK".
0007 Now it's shown in the list on the left.
0008
0009 You can choose it if you want to edit the properties (the changes will take
0010 effect if you press OK), remove it (per default you will be asked again if
0011 you really want to delete it but you can disable it by checking "don't ask me again").
0012
0013 If you export a useraction you have to give a file where to store it. If it
0014 does not exists it will be created. If it already contains some useractions,
0015 the action you're exporting will be added to that file.
0016
0017 If you import some actions they will be added automatically to your list. If
0018 there are name-conflicts (the names have to be unique because these are the
0019 ID for KDE's action-system) you're asked to resolve them. For this, the list on
0020 the left will only show the actions where conflicts exist. You now can give
0021 them new names or remove them.
0022
0023 All actions you've defined are now shown in the usermenu and in KDE's dialogs
0024 for changing shortcuts and managing the toolbar. In addition all actions
0025 which are available for the current item will also show up in the rightclick
0026 menu.
0027
0028 The fields of the properties are  (* are required):
0029
0030 identifier*:      unique ID of the action, used to identify it for KDE's action-system
0031 category:         used to group various actions together
0032 title*:           title displayed in the menus/dialogs
0033 icon:             icon for the action
0034 tooltip:          tooltip for the action - displayed in the toolbar on mouseover
0035 description:      description of what the action does
0036 command*:         command that is finally executed
0037                   you can add placeholders using a GUI with the 'add'-button
0038 workdir:           working-directory for the command
0039 execution-mode:   how should the command be run
0040 command accepts:  tells if the placeholder should return local addresses or URLs
0041 default shortcut: the action will run with this shortcut
0042
0043 On the advanced-tab you can say where your command should be visible (for the
0044 rightclick-menu). In addition it's possible to change the command executed and
0045 confirm it separately. You can also set a user under which the command should
0046 be executed.
0047
0048 There are basically two kinds of placeholders:
0049 1) those which access internal functions of Krusader
0050 2) those which are replaced by a string.
0051
0052 It's important to know that the first category is performed at expansion-time,
0053 meaning that the extra confirmation has only effect on programs which are
0054 executed, not on internal functions (which are called earlier.)
0055
0056 The list of placeholders is accessible via the 'add' button.
0057 Some Placeholders can get parameters, for which a GUI is also provided.
0058 The following list is already implemented:
0059     Path       replaced by the panels path
0060     Count      replaced by the number of <first parameter>
0061     Filter     replaced by the panels filter-mask
0062     Current    replaced by the current item
0063     List       replaced by a list of all <first parameter>
0064     Select     manipulates the selection in a panel
0065     Goto       changes the panel's path to <first parameter>
0066     Ask        asks the user for some text and is replaced by the answer
0067     Clipboard  manipulates the clipboard
0068     Copy       copies a file, useful for quick, local, backups
0069     Sync       opens the Synchronizer with a given profile
0070     NewSearch  opens the search-windows with a given profile
0071     Profile    loads a given panel-profile
0072
0073 Enjoy,
0074