2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
4
<!ENTITY kappname "&kde; Menu Editor">
5
<!ENTITY package "kdebase">
6
<!ENTITY firefox "<application>Firefox</application>">
7
<!ENTITY % addindex "IGNORE">
8
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
11
<book id="kmenuedit" lang="&language;">
15
<title>The &kde; Menu Editor Handbook</title>
18
<author>&Milos.Prudek; &Milos.Prudek.mail;</author>
19
<author>&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;</author>
20
<othercredit role="reviewer">
21
&Lauri.Watts; &Lauri.Watts.mail;
22
<!-- <contrib>Reviewer</contrib> -->
24
<!-- TRANS:ROLES_OF_TRANSLATORS -->
29
<holder>&Milos.Prudek;</holder>
33
<holder>&Anne-Marie.Mahfouf;</holder>
36
<legalnotice>&FDLNotice;</legalnotice>
38
<date>2013-09-07</date>
39
<releaseinfo>0.9 (&kde; 4.11)</releaseinfo>
41
<abstract><para>&kmenuedit; allows editing one of the &kde; application launchers: &kickoff;, the classic &kmenu; or Lancelot Launcher.
45
<keyword>KDE</keyword>
46
<keyword>KDE Menu Editor</keyword>
47
<keyword>kmenuedit</keyword>
48
<keyword>application</keyword>
49
<keyword>program</keyword>
50
<keyword>menu</keyword>
51
<keyword>kickoff</keyword>
52
<keyword>Lancelot</keyword>
56
<chapter id="introduction">
57
<title>Introduction</title>
59
<para>&kmenuedit; allows editing the menu of &kde; application launchers: &kickoff;, classic &kmenu; or Lancelot Launcher.</para>
61
<para>&kmenuedit; can be started either by &RMB; clicking the application launcher
62
button on the panel and choosing <guimenuitem>Edit
63
Applications...</guimenuitem>, or
64
by typing <userinput>kmenuedit</userinput> in the &krunner; line.</para>
66
<para>&kmenuedit; allows you to:</para>
69
<listitem><para>View and edit the menu used by the current application launcher (&kickoff;, classic menu or Lancelot Launcher)</para></listitem>
70
<listitem><para><guimenuitem>Cut</guimenuitem>, <guimenuitem>Copy</guimenuitem>
71
and <guimenuitem>Paste</guimenuitem> submenus and items</para></listitem>
72
<listitem><para>Create and delete submenus and items</para></listitem>
73
<listitem><para>Change the order of submenus and items</para></listitem>
74
<listitem><para>Hide items and add new submenus and items</para></listitem>
77
<para>By default all applications installed on the computer appear in the application launchers menu of all users.
78
Applications may appear more than once in several different menus.
79
Empty submenu categories defined in the desktop menu specification will show up as well,
80
but are not visible in application launchers unless you install applications belonging to these categories.
83
<para>The tree view has three different entry types:</para>
85
<listitem><para>Submenu: Only <guilabel>Name</guilabel>, <guilabel>Comment</guilabel> and
86
<guilabel>Description</guilabel> fields and the button to select an icon
87
are enabled, the <guilabel>Advanced</guilabel> tab is disabled.
88
Any submenu can hold additional submenus and/or items.
90
<listitem><para>Items: Use this entry to enter the data for the application you want to add.
91
For detailed information see <link linkend="using-kmenuedit">Using &kmenuedit;</link>.
93
<listitem><para>Separator: A visual entry to structure the menu. It cannot be modified
94
and all editing actions are disabled.
98
<para>&kmenuedit; has two tree view modes - normal and with hidden entries. To see the latter check the option
99
<guilabel>Show hidden entries</guilabel> in the configuration dialog on the <guilabel>General options</guilabel> page.
101
<para>Many additional entries appear in hidden view mode in the tree. Several hidden entries seem to be just duplicates
102
but have different command options. Usually you should never change these hidden entries or you risk to break some
103
functionality of the system.
105
<para>In hidden mode you will have a special submenu <guilabel>.hidden [Hidden]</guilabel> as top level
106
item in the tree. This special submenu is not editable. In this submenu all deleted items will be shown at the next
107
start of &kmenuedit;.</para>
108
<para>It is not possible to delete entries using the &GUI; in this special submenu. They will reappear at the
109
next start of &kmenuedit;.
112
<sect1 id="use-cases">
113
<title>Use Cases</title>
115
<sect2 id="use-cases-adapt">
116
<title>Adapt the Menu for a User</title>
118
<sect3 id="use-cases-adapt-order">
119
<title>Reorder Items</title>
121
<para>This should be done in hidden view mode where only the submenus and items visible in the application
122
launcher menu are displayed.
124
<para>By default the menu is sorted alphabetically using the English names or descriptions. Using another language
125
than English some submenus and items therefore will appear in an unsorted order.
127
<para>Use the options in <menuchoice><guimenu>Edit</guimenu><guimenuitem>Sort</guimenuitem></menuchoice>
128
to sort either by name or description. If you use the classic application launcher you have to select the
129
corresponding <guilabel>Format</guilabel> option in the settings dialog. In the &kickoff; launcher check
130
<guilabel>Show applications by name</guilabel> if you sort them by name here.
132
<para>Grouping your frequently used submenus or items together ⪚ at the top of the menu makes selecting them easier.
133
To change the order of particular items or submenus in the tree use the <guibutton>Move Up</guibutton> or
134
<guibutton>Move Down</guibutton> button in the toolbar or these actions in the menu.
136
<para>All application launchers will use the order of submenus defined in &kmenuedit;.
140
<sect3 id="use-cases-adapt-hide">
141
<title>Remove Items from the Menu View</title>
143
<para>Having shown all applications installed on a computer may be confusing for some users so you may
144
want to hide some less frequently used items or submenus. There are two different ways to do that:
147
<para>Switch to normal view mode without hidden entries. If you delete items they are moved to the
148
<guilabel>.hidden [Hidden]</guilabel> submenu. You can move them back into the tree to have them in the menu again.
150
<para>If you delete a submenu it will be really deleted with all its submenus and items.
151
To recreate them you can use <menuchoice><guimenu>Edit</guimenu><guimenuitem>Restore to System
152
Menu</guimenuitem></menuchoice>, but this will remove all your custom submenus and items
153
and the corresponding <filename class="extension">.desktop</filename> files are deleted too. This action cannot be reverted.
156
<para>The preferred way to remove submenus and items in the menu of an application launcher is to check <guilabel>Hidden
157
entry</guilabel> on the <guilabel>General</guilabel> tab and switch to the hidden view mode.
158
In this mode it is easy to revert changes without destroying the menu structure.
159
The only drawback is that you have to hide all entries in a submenu manually to
160
hide the whole submenu from the view.
166
<sect2 id="use-cases-additems">
167
<title>Adding Custom Items</title>
169
<para>To add custom items (submenu, item or separator) use the actions in the menu or toolbar.
170
Items need a Name and a Command, without a command entry an item will not be saved and your addition gets lost.
172
<para>If you add an entry it is inserted as sub entry at the actual highlighted position in the tree.
173
Move an entry by dragging it with the mouse or using the <guibutton>Move Down</guibutton> button
174
to the bottom of the tree to make it a top level entry.
179
<sect2 id="use-cases-transfer">
180
<title>Transfer application launcher settings</title>
182
<para>There is no way to transfer menu settings using the &GUI;, you have to do that manually
183
and copy the following files to the target user:</para>
184
<para>&kmenuedit; stores the menu hierarchy in
185
<filename>$<envar>HOME</envar>/.config/menus/applications-kmenuedit.menu</filename>
186
and <filename class="directory">$<envar>HOME</envar>/.local/share/desktop-directories</filename>
187
contains desktop files for submenus you created.
188
In <filename class="directory">$<envar>HOME</envar>/.local/share/applications/</filename> you
189
find the desktop files for the custom items you created.
191
<para>The shortcuts for each application are stored in <filename>~/.kde/share/config/kglobalshortcutsrc</filename>,
192
but export/import does not work because the UUIDs of the shortcuts do not match up between systems, even though the
193
<filename class="extension">.desktop</filename> files are the same. You have to assign all shortcuts manually again.
201
<chapter id="quickstart">
204
<author>&Virgil.J.Nisly; &Virgil.J.Nisly.mail;</author>
207
<title>Adding a Menu Entry</title>
209
<para>In this example, we will add &firefox; to the <guisubmenu>Internet</guisubmenu> submenu.</para>
210
<para>To start off, we need to open &kmenuedit;, so &RMB; on the application
211
launcher menu, click <guimenuitem>Edit Applications...</guimenuitem> to start
212
&kmenuedit;. After &kmenuedit; has started, select <guisubmenu>Internet</guisubmenu> as shown in picture below.
214
<screeninfo>Select <guisubmenu>Internet</guisubmenu></screeninfo>
217
<imagedata fileref="selectinternet.png" format="PNG" />
220
<phrase>Select <guisubmenu>Internet</guisubmenu></phrase>
225
Once you have selected <guisubmenu>Internet</guisubmenu>, click on <menuchoice><guimenu>File</guimenu><guimenuitem>New Item...</guimenuitem></menuchoice>, opening the <guilabel>New Item</guilabel> dialog, as shown below. Type the name of the program you want to add, in this case, type <userinput>firefox</userinput>.
227
<screeninfo><guilabel>New Item</guilabel> dialog</screeninfo>
230
<imagedata fileref="itemname.png" format="PNG" />
233
<phrase>The <guilabel>New Item</guilabel> dialog.</phrase>
239
Press return, and you should see something like the picture below in the main window.
241
<screeninfo>New Item</screeninfo>
244
<imagedata fileref="new.png" format="PNG" />
247
<phrase>The new item created.</phrase>
253
Now lets fill in the <guilabel>Description:</guilabel>, in this case type <userinput>Web Browser</userinput>.
254
<note><para>The appearance how description and name will be displayed depends on the settings in the application
255
launcher ⪚ <quote>Web Browser (Firefox)</quote> or <quote>Firefox (Web Browser)</quote>.</para></note>
256
We will need to fill in the executable name in the <guilabel>Command:</guilabel> field, in this instance we will type <userinput><command>firefox</command></userinput>.</para>
257
<para>The command has to be in your <envar>PATH</envar> variable or you have to specify the full path to the executable.
258
If you do not know the executable name of an application use the <userinput><command>locate</command></userinput>
259
command to search for the desktop file and enter the string from the Exec line as command here.
261
<note><para>Following the command, you can have several place holders which will be replaced with actual values when the program is run:
263
<member>%f - a single file name</member>
264
<member>%F - a list of files; use for applications that can open several local files at once</member>
265
<member>%u - a single &URL;</member>
266
<member>%U - a list of &URL;s</member>
267
<member>%d - the folder of a file to open</member>
268
<member>%D - a list of folders</member>
269
<member>%i - the icon</member>
270
<member>%m - the mini icon</member>
271
<member>%c - the caption</member>
273
<informalexample><para>For example: if you want to firefox to start your web browsing at www.kde.org - instead of <command>firefox</command> you would type <command>firefox %u www.kde.org</command>.</para></informalexample></note>
274
<para>Most applications accept additional options ⪚ the name of a defined profile like &konqueror; or &konsole;.
275
To see all options for an application launch <userinput><command><replaceable>applicationname</replaceable></command> <option>--help</option></userinput> in &konsole;.</para>
276
<para>We would like to have a more creative icon, so we will click the generic icon sitting beside <guilabel>Name:</guilabel> (note, the default icon may be blank, in which case click in the area to the right of the name entry box.) It will bring the <guilabel>Select Icon</guilabel> dialog which will let us choose the new icon, as shown below.
278
<screeninfo><guilabel>Select Icon</guilabel> dialog</screeninfo>
281
<imagedata fileref="selecticon.png" format="PNG" />
284
<phrase>The <guilabel>Select Icon</guilabel> dialog.</phrase>
289
<para>We choose the firefox icon from the list, and press &Enter;. Your finished screen should probably look something like the screenshot below.
291
<screeninfo>Done screenshot</screeninfo>
294
<imagedata fileref="done.png" format="PNG" />
297
<phrase>This is what the completed menu item should looks like.</phrase>
302
<para>The place of the new menu item can now be changed using <guibutton>Move Up</guibutton> and <guibutton>Move Down</guibutton> buttons on the &kmenuedit; toolbar or by dragging with the mouse.</para>
303
<para>The submenu items can be sorted using <guibutton>Sort</guibutton> button on the &kmenuedit; toolbar or <menuchoice><guimenu>Edit</guimenu><guisubmenu>Sort</guisubmenu></menuchoice> submenu items.</para>
305
<para>Click <menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice>, wait for the <guilabel>Updating System Configuration</guilabel> dialog to get finished, you should find &firefox; in the application launcher <guisubmenu>Internet</guisubmenu> submenu.</para>
309
<chapter id="using-kmenuedit">
310
<title>Using &kmenuedit;</title>
312
<para>The left application panel shows the application launcher structure. When
313
you browse items in the left panel, the right panel shows detailed
314
information for the highlighted menu item.</para>
316
<sect1 id="details-general">
317
<title>General tab</title>
321
<term><guilabel>Name:</guilabel></term>
322
<listitem><para>This is the name of your program as it appears in the
323
application launcher menu. It can be different from the real executable
324
name. For instance the name of <command>mc</command> executable is
325
"<application>Midnight Commander</application>".</para></listitem>
328
<term><guilabel>Description:</guilabel></term>
329
<listitem><para>The description will be displayed together with the name in the application launcher. This is entirely optional.</para></listitem>
332
<term><guilabel>Comment:</guilabel></term>
333
<listitem><para>Describe the program in greater detail in this field. This is
334
entirely optional.</para></listitem>
337
<term><guilabel>Command:</guilabel></term>
338
<listitem><para>This is the name of the executable program. Make sure that you
339
have permission to run the program.</para></listitem>
342
<term><guilabel>Enable launch feedback</guilabel></term>
343
<listitem><para>If this box is checked, this will display feedback when an application is started.
347
<term><guilabel>Place in system tray</guilabel></term>
348
<listitem><para>When checked, the application's icon will show up in the panel system tray.
349
You will then be able to hide or show the application by clicking on the system
350
tray icon. Clicking on it using the &RMB; will allow also you to undock, or quit the
355
<term><guilabel>Only show in &kde;</guilabel></term>
356
<listitem><para>When checked, the application entry will only be visible in all &kde; application launchers but not in other desktops environments.
360
<term><guilabel>Hidden entry</guilabel></term>
361
<listitem><para>Remove an entry from the menu view in the application launcher. </para></listitem>
366
<sect1 id="details-advanced">
367
<title>Advanced tab</title>
371
<term><guilabel>Work path:</guilabel></term>
372
<listitem><para>Specify the work path of the program. This will be the current
373
path when the program launches. It does not need to be the same as the
374
executable location.</para></listitem>
377
<term><guilabel>Run in terminal</guilabel></term>
378
<listitem><para>You must check this if your program requires terminal emulator
379
in order to run. This mainly applies to <link
380
linkend="gloss-console-application">console
381
applications</link>.</para></listitem>
384
<term><guilabel>Terminal options:</guilabel></term>
385
<listitem><para>Put all terminal options in this field.</para></listitem>
388
<term><guilabel>Run as a different user</guilabel></term>
389
<listitem><para>If you want to run this program as a different user (not you),
390
check this checkbox, and provide the username in the
391
<guilabel>Username:</guilabel> field.</para></listitem>
395
<term><guilabel>Current shortcut key:</guilabel></term>
396
<listitem><para>You can assign a special keyboard shortcut to launch your program.</para>
398
<para>Click the <guibutton>None</guibutton> button to the right of the <guilabel>Current
399
shortcut key:</guilabel> checkbox.</para>
401
<para>The button text will change to <guilabel>Input...</guilabel>
402
and you can press the key combination on your keyboard that you want to be assigned to your program.
404
<para>You can reset the shortcut to <guilabel>None</guilabel> by using this button: <inlinemediaobject><imageobject> <imagedata
405
fileref="reset.png" format="PNG"/></imageobject></inlinemediaobject>.
408
<para>Don't forget to save your setting by clicking the toolbar <guiicon>Save</guiicon> icon or using the <menuchoice>
409
<guimenu>File</guimenu><guimenuitem>Save</guimenuitem>
410
</menuchoice> menu item.</para>
419
<chapter id="menu-reference">
420
<title>Menu Reference</title>
422
<para>Most actions in the menubar are also available in the context menu opened with a &RMB;
423
click on an item in the tree view.</para>
426
<varlistentry id="file-new-item">
429
action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
430
<guimenu>File</guimenu> <guimenuitem>New Item...</guimenuitem>
431
</menuchoice></term> <listitem><para><action>Adds new menu
432
item.</action></para></listitem>
435
<varlistentry id="file-new-submenu">
437
<guimenu>File</guimenu>
438
<guimenuitem>New Submenu...</guimenuitem>
440
<listitem><para><action>Adds new submenu.</action></para></listitem>
443
<varlistentry id="file-new-separator">
444
<term><menuchoice><guimenu>File</guimenu><guimenuitem>New
445
Separator</guimenuitem></menuchoice></term>
447
<para><action>Adds a new separator to the menu.</action></para>
451
<varlistentry id="file-save">
454
action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
455
<guimenu>File</guimenu><guimenuitem>Save</guimenuitem>
458
<para><action>Saves the menu</action></para>
462
<varlistentry id="file-quit">
465
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
467
<guimenu>File</guimenu>
468
<guimenuitem>Quit</guimenuitem>
470
<listitem><para><action>Quits</action> &kmenuedit;.</para></listitem>
473
<varlistentry id="edit-move-up">
475
<guimenu>Edit</guimenu>
476
<guimenuitem>Move Up</guimenuitem>
478
<listitem><para><action>Moves</action> the selected item up in its submenu.</para></listitem>
481
<varlistentry id="edit-move-down">
483
<guimenu>Edit</guimenu>
484
<guimenuitem>Move Down</guimenuitem>
486
<listitem><para><action>Moves</action> the selected item down in its submenu.</para></listitem>
490
<varlistentry id="edit-cut">
493
<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
496
Edit</guimenu> <guimenuitem>Cut</guimenuitem>
498
<listitem><para><action>Cuts the current menu item to the clipboard.</action> If
499
you want to move menu item, you should first cut it to the clipboard, move to
500
the destination place using the left panel, and use the
501
<guimenuitem>Paste</guimenuitem> function to paste the menu item from the
502
clipboard.</para></listitem>
505
<varlistentry id="edit-copy">
508
<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
511
Edit</guimenu> <guimenuitem>Copy</guimenuitem>
513
<listitem><para><action>Copies the current menu item to the
514
clipboard</action>. You can later use the <guimenuitem>Paste</guimenuitem>
515
function to paste the copied menu item from the clipboard to its destination. You
516
can paste the same item many times.</para></listitem>
519
<varlistentry id="edit-paste">
522
<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
524
<guimenu>Edit</guimenu>
525
<guimenuitem>Paste</guimenuitem> </menuchoice></term>
526
<listitem><para><action>Paste menu item from the clipboard</action> to currently
527
selected place in the main menu. You must first use
528
<guimenuitem>Cut</guimenuitem> or <guimenuitem>Copy</guimenuitem> before you can
529
<guimenuitem>Paste</guimenuitem>.</para></listitem>
532
<varlistentry id="edit-delete">
534
<shortcut><keycap>Del</keycap></shortcut>
535
<guimenu>Edit</guimenu> <guimenuitem>Delete</guimenuitem>
537
<listitem><para><action>Deletes currently selected menu
538
item.</action></para></listitem>
541
<varlistentry id="edit-sort">
543
<guimenu>Edit</guimenu>
544
<guisubmenu>Sort</guisubmenu>
546
<listitem><para><action>Opens</action> submenu to sort selected submenu or all menu tree. There are two sorting methods implemented, namely, by the name and by the description.</para></listitem>
549
<varlistentry id="edit-restore">
551
<guimenu>Edit</guimenu> <guimenuitem>Restore to System Menu</guimenuitem>
553
<listitem><para><action>This will restore the application launcher as it was as default and remove all your custom settings. A message box will ask you if you really want to do that.</action></para></listitem>
559
&kmenuedit; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
560
menu items, for more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings"
561
>Settings Menu</ulink> and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
562
of the &kde; Fundamentals.
567
<chapter id="credits">
569
<title>Credits and License</title>
574
<para>Program copyright © 2002, &Raffaele.Sandrini;</para>
576
<para>Contributors:</para>
578
<listitem><para>&Matthias.Elter; &Matthias.Elter.mail; - Original
581
<listitem><para>&Matthias.Ettrich; &Matthias.Ettrich.mail;</para>
583
<listitem><para>&Daniel.M.Duley; &Daniel.M.Duley.mail;</para>
585
<listitem><para>&Preston.Brown; &Preston.Brown.mail;</para>
589
<para>Documentation copyright © 2000 &Milos.Prudek;</para>
590
<para>Documentation copyright © 2008 &Anne-Marie.Mahfouf;</para>
591
<para>Updated for &kde; 3.0 by &Lauri.Watts; &Lauri.Watts.mail;
594
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
601
<glossary id="glossary">
602
<title>Glossary</title>
604
<glossentry id="gloss-console-application">
605
<glossterm>Console Application</glossterm>
608
<para>Application originally written for non-graphic, text oriented
609
environment. Such applications run fine in &kde;. They must run within
610
console emulator, like &konsole;. They are not warned automatically
611
when you shut down your &kde; session. You therefore must not forget
612
to save documents open in these applications before you log out from
615
<para>Console applications support copying and pasting from
616
&kde;-compliant applications.Simply mark the text in the console
617
application with your mouse, switch to the &kde;-compliant application
618
and press <keycombo action="simul">&Ctrl;
619
<keycap>V</keycap></keycombo> to paste the text. If you want to copy
620
from &kde; application to a console application, first mark the text
621
with your mouse, press <keycombo action="simul">&Ctrl;
622
<keycap>C</keycap></keycombo>, switch to the console application and
623
press the middle button on your mouse<footnote><para>If your mouse
624
does not have a middle button, you must press
625
<mousebutton>left</mousebutton> and <mousebutton>right</mousebutton>
626
button at the same time. This is called <quote>middle button
627
emulation</quote> and it must be supported by your operating system to
628
work.</para></footnote>.</para>
635
&documentation.index;
641
sgml-minimize-attributes: nil
642
sgml-general-insert-case: lower