Differential D14266 Diff 38184 doc-extras/actions_tutorial.txt

Changeset View

Standalone View

View Options

doc-extras/actions_tutorial.txt

1A Short Tutorial for the User Actions System 1​A Short Tutorial for the User Actions System
2============================================ 2​============================================
3Go to the Konfigurator and choose "Useractions". There you manage all your 3​
4actions. If you add an new action, you get an empty input-mask where you can 4​Go to the Konfigurator and choose "Useractions". There you can manage all your
5enter all the properties. The action will be added as soon as you press "ok". 5​actions. If you add a new action, you get an empty input-mask where you can
6​enter all the properties. The action will be added as soon as you press "OK".
6Now it's shown in the list on the left. 7​Now it's shown in the list on the left.
7 8​
8You can choose it if you want to edit the properties (the changes will take 9​You can choose it if you want to edit the properties (the changes will take
9effect if you press OK), remove it (per default you will be asked again if 10​effect if you press OK), remove it (per default you will be asked again if
10you realy want to delete it but you can disable it by checking "don't ask me again"). 11​you really want to delete it but you can disable it by checking "don't ask me again").
11 12​
12If you export a useraction you have to give a file where to store it. If it 13​If you export a useraction you have to give a file where to store it. If it
13does not exists it will be created. If it contains already some useractions, 14​does not exists it will be created. If it already contains some useractions,
14the action you're exporting will be added to that file. 15​the action you're exporting will be added to that file.
15 16​
16If you import some actions they will be added automaticly to your list. If 17​If you import some actions they will be added automatically to your list. If
17there are name-conflicts (the names have to be unique because these are the 18​there are name-conflicts (the names have to be unique because these are the
18ID for KDE's action-system) you're asked to resolve them. For this, the list on 19​ID for KDE's action-system) you're asked to resolve them. For this, the list on
19the left will only show the actions where conflicts exists. You now can give 20​the left will only show the actions where conflicts exists. You now can give
yurchorUnsubmitted
Not Done

exists -> exist

yurchor: exists -> exist
20them new names or remove them. 21​them new names or remove them.
21 22​
22All actions you've defined are now shown in the usermenu and in KDE's dialogs 23​All actions you've defined are now shown in the usermenu and in KDE's dialogs
23for changing shortcuts and managing the toolbar. In addition all actions 24​for changing shortcuts and managing the toolbar. In addition all actions
24which are available for the current item will also show up in the rightclick 25​which are available for the current item will also show up in the rightclick
25menu. 26​menu.
26 27​
27The fields of the properties are (* are required): 28​The fields of the properties are (* are required):
28name*: a unique name of the action, used to identiy it for KDE's action-system 29​
29title*: the title displayed in the menus/dialogs 30​identifier*: unique ID of the action, used to identify it for KDE's action-system
30icon: the icon for you action 31​category: used to group various actions together
31tooltip: a tooltip for your action - i.e. displayed in the toolbar on mouseover 32​title*: title displayed in the menus/dialogs
32desctiption: a description of what the action is doing. 33​icon: icon for the action
33command*: that is the command which is finaly executed. you can add 34​tooltip: tooltip for the action - displayed in the toolbar on mouseover
34 placeholder using a GUI with the 'add'-button 35​description: description of what the action does
35startpath: the working-directory for your command execution-mode should be clear 36​command*: command that is finally executed
36command eccepts: tells if the placeholder should return local addesses or URLs 37​ you can add placeholders using a GUI with the 'add'-button
37Default shortcut: the action will be init with this shortcut 38​workdir: working-directory for the command
39​execution-mode: how should the command be run
40​command accepts: tells if the placeholder should return local addesses or URLs
yurchorUnsubmitted
Not Done

addesses -> addresses

yurchor: addesses -> addresses
41​default shortcut: the action will run with this shortcut
38 42​
39On the advanced-tab you can say where your command should be visible (for the 43​On the advanced-tab you can say where your command should be visible (for the
40rightclick-menu). In addition it's possibe to change the command executed and 44​rightclick-menu). In addition it's possible to change the command executed and
41confirm it separately. You can also set a user under which the command should 45​confirm it separately. You can also set a user under which the command should
42be executed. 46​be executed.
43 47​
44There are basicly two kinds of placeholders: 48​There are basically two kinds of placeholders:
451) those who access internal functions of Krusader 49​1) those which access internal functions of Krusader
462) those who are replaced by a string. 50​2) those which are replaced by a string.
47 51​
48it's important to know that the first category is performed at expansion-time, 52​It's important to know that the first category is performed at expansion-time,
49meaning that the extra confirmation has only effect on programms which are 53​meaning that the extra confirmation has only effect on programs which are
50executed, not on internal functions (which aree called earlyer) 54​executed, not on internal functions (which are called earlier.)
51 55​
52The list of placeholders is accessable via the 'add' button. 56​The list of placeholders is accessible via the 'add' button.
53Some Placeholders can get parameters, for those is also a GUI provided. 57​Some Placeholders can get parameters, for which a GUI is also provided.
54The following list is already implemented: 58​The following list is already implemented:
55 Path replaced by the panels path 59​ Path replaced by the panels path
56 Count replaced by the number of <first parameter> 60​ Count replaced by the number of <first parameter>
57 Filter replaced by the panels filter-mask 61​ Filter replaced by the panels filter-mask
58 Current replaced by the current item 62​ Current replaced by the current item
59 List replaced by a list of all <first paremeter> 63​ List replaced by a list of all <first parameter>
60 Select manipulates the selection in a panel 64​ Select manipulates the selection in a panel
61 Goto changes the panels's path to <first parameter> 65​ Goto changes the panel's path to <first parameter>
62 Ask asks the user for a some text and is replaced by the answer 66​ Ask asks the user for a some text and is replaced by the answer
yurchorUnsubmitted
Not Done

for a some -> for some

yurchor: for a some -> for some
63 Clipboard manipulates the clipboard 67​ Clipboard manipulates the clipboard
64 Copy copies a file, useful for quick, local, backups 68​ Copy copies a file, useful for quick, local, backups
65 Sync opens the Synchronizer with a given profile 69​ Sync opens the Synchronizer with a given profile
66 NewSearch opens the search-windows with a given profile 70​ NewSearch opens the search-windows with a given profile
67 Profile loads a given panel-profile 71​ Profile loads a given panel-profile
68 72​
69Enjoy, 73​Enjoy,
70 74​