workspace/doc/kmenuedit/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   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 -->
   9 ]>
  10
  11 <book lang="&language;">
  12
  13 <bookinfo>
  14
  15 <title>The KDE Menu Editor Handbook</title>
  16
  17 <authorgroup>
  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> -->
  23 </othercredit>
  24 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  25 </authorgroup>
  26
  27 <copyright>
  28 <year>2000</year>
  29 <holder>&Milos.Prudek;</holder>
  30 </copyright>
  31 <copyright>
  32 <year>2008</year>
  33 <holder>&Anne-Marie.Mahfouf;</holder>
  34 </copyright>
  35
  36 <legalnotice>&FDLNotice;</legalnotice>
  37
  38 <date>2008-09-15</date>
  39 <releaseinfo>0.8</releaseinfo>
  40
  41 <abstract><para>&kmenuedit; allows editing one of the &kde; application launchers: &kickoff;, the classic &kmenu; or Lancelot Launcher.
  42 </para></abstract>
  43
  44 <keywordset>
  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>
  53 </keywordset>
  54
  55 </bookinfo>
  56
  57 <chapter id="introduction">
  58 <title>Introduction</title>
  59
  60 <para>&kmenuedit; allows editing of &kde; application launchers: &kickoff;, classic &kmenu; or Lancelot Launcher.</para>
  61
  62 <para>&kmenuedit; can be started either by &RMB; clicking the
  63 application lancher button on the panel and choosing
  64 <guimenuitem>Menu Editor</guimenuitem>, or by choosing
  65 <guimenuitem>Menu Editor</guimenuitem> from the
  66 <guisubmenu>Settings</guisubmenu> submenu of the application launcher or by typing <userinput>kmenuedit
  67 </userinput> in the &krunner; line.</para>
  68
  69 <para>&kmenuedit; allows you to:</para>
  70
  71 <itemizedlist>
  72 <listitem><para>View and edit the current application launcher (&kickoff;, classic menu or Lancelot Launcher)</para></listitem>
  73 <listitem><para><guimenuitem>Cut</guimenuitem>, <guimenuitem>Copy</guimenuitem>
  74 and <guimenuitem>Paste</guimenuitem> menu items</para></listitem>
  75 <listitem><para>Create and delete submenus</para></listitem>
  76 </itemizedlist>
  77
  78 </chapter>
  79
  80 <chapter id="quickstart">
  81 <chapterinfo>
  82 <authorgroup>
  83 <author>&Virgil.J.Nisly; &Virgil.J.Nisly.mail;</author>
  84 </authorgroup>
  85 </chapterinfo>
  86 <title>A Quick Start Guide to Adding an Entry to the application launcher</title>
  87
  88   <para>In this example, we will add &firefox; to the <guisubmenu>Internet</guisubmenu> submenu. <note><para>Most applications can be added with &kappfinder;, &firefox; can usually be added that way, but was used for lack of a better example.</para></note></para>
  89   <para>To start off, we need to open &kmenuedit;, so &RMB; on the application launcher menu, click <guimenuitem>Menu Editor</guimenuitem> to start &kmenuedit;. After &kmenuedit; has started, select <guisubmenu>Internet</guisubmenu> as shown in picture below.
  90 <screenshot>
  91 <screeninfo>Select <guisubmenu>Internet</guisubmenu></screeninfo>
  92 <mediaobject>
  93 <imageobject>
  94 <imagedata fileref="selectinternet.png" format="PNG" />
  95 </imageobject>
  96 <textobject>
  97 <phrase>Select <guisubmenu>Internet</guisubmenu></phrase>
  98 </textobject>
  99 </mediaobject>
 100 </screenshot></para>
 101   <para>
 102     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>.
 103 <screenshot>
 104 <screeninfo><guilabel>New Item</guilabel> dialog</screeninfo>
 105 <mediaobject>
 106 <imageobject>
 107 <imagedata fileref="itemname.png" format="PNG" />
 108 </imageobject>
 109 <textobject>
 110 <phrase>The <guilabel>New Item</guilabel> dialog.</phrase>
 111 </textobject>
 112 </mediaobject>
 113 </screenshot>
 114 </para>
 115 <para>
 116 Press return, and you should see something like the picture below in the main window.
 117 <screenshot>
 118 <screeninfo>New Item</screeninfo>
 119 <mediaobject>
 120 <imageobject>
 121 <imagedata fileref="new.png" format="PNG" />
 122 </imageobject>
 123 <textobject>
 124 <phrase>The new item created.</phrase>
 125 </textobject>
 126 </mediaobject>
 127 </screenshot></para>
 128
 129 <para>
 130     Now lets fill in the <guilabel>Description:</guilabel>, in this case type <userinput>Web Browser</userinput>. <note><para>The description and name will be displayed on the application launcher as <quote>Web Browser (Firefox)</quote>.</para></note> 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>
 131 <note><para>Following the command, you can have several place holders which will be replaced with actual values when the program is run:
 132 <simplelist>
 133 <member>%f - a single file name</member>
 134 <member>%F - a list of files; use for applications that can open several local files at once</member>
 135 <member>%u - a single &URL;</member>
 136 <member>%U - a list of &URL;s</member>
 137 <member>%d - the folder of a file to open</member>
 138 <member>%D - a list of folders</member>
 139 <member>%i - the icon</member>
 140 <member>%m - the mini icon</member>
 141 <member>%c - the caption</member>
 142 </simplelist></para>
 143 <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>
 144 <para>We would like to have a more creative icon, so we will click the generic icon sitting beside <guilabel>Name:</guilabel>. It will bring the <guilabel>Select Icon</guilabel> dialog which will let us choose the new icon, as shown below.
 145 <screenshot>
 146 <screeninfo><guilabel>Select Icon</guilabel> dialog</screeninfo>
 147 <mediaobject>
 148 <imageobject>
 149 <imagedata fileref="selecticon.png" format="PNG" />
 150 </imageobject>
 151 <textobject>
 152 <phrase>The <guilabel>Select Icon</guilabel> dialog.</phrase>
 153 </textobject>
 154 </mediaobject>
 155 </screenshot></para>
 156
 157   <para>We choose the firefox icon from the list, and press return. Your finished screen should probably look something like the screenshot below.
 158 <screenshot>
 159 <screeninfo>Done screenshot</screeninfo>
 160 <mediaobject>
 161 <imageobject>
 162 <imagedata fileref="done.png" format="PNG" />
 163 </imageobject>
 164 <textobject>
 165 <phrase>This is what the completed menu item should looks like.</phrase>
 166 </textobject>
 167 </mediaobject>
 168 </screenshot></para>
 169
 170 <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>
 171
 172
 173
 174 </chapter>
 175
 176 <chapter id="using-kmenuedit">
 177 <title>Using &kmenuedit;</title>
 178
 179 <para>The left application panel shows the application launcher structure. When
 180 you browse items in the left panel, the right panel shows detailed
 181 information for the highlighted menu item.</para>
 182
 183 <sect1 id="details-general">
 184 <title>General tab</title>
 185
 186 <variablelist>
 187 <varlistentry>
 188 <term><guilabel>Name:</guilabel></term>
 189 <listitem><para>This is the name of your program as it appears in the
 190 application launcher menu. It can be different from the real executable
 191 name. For instance the name of <command>mc</command> executable is
 192 "<application>Midnight Commander</application>".</para></listitem>
 193 </varlistentry>
 194 <varlistentry>
 195 <term><guilabel>Description:</guilabel></term>
 196 <listitem><para>The description will be displayed together with the name in the application launcher. This is entirely optional.</para></listitem>
 197 </varlistentry>
 198 <varlistentry>
 199 <term><guilabel>Comment:</guilabel></term>
 200 <listitem><para>Describe the program in greater detail in this field. This is
 201 entirely optional.</para></listitem>
 202 </varlistentry>
 203 <varlistentry>
 204 <term><guilabel>Command:</guilabel></term>
 205 <listitem><para>This is the name of the executable program. Make sure that you
 206 have permission to run the program.</para></listitem>
 207 </varlistentry>
 208 <varlistentry>
 209 <term><guilabel>Enable launch feedback</guilabel></term>
 210 <listitem><para>If this box is checked, this will display feedback when an application is started.
 211 </para></listitem>
 212 </varlistentry>
 213 <varlistentry>
 214 <term><guilabel>Place in system tray</guilabel></term>
 215 <listitem><para>When checked, the application's icon will show up in the panel system tray.
 216 You will then be able to hide or show the application by clicking on the system
 217 tray icon. Clicking on it using the &RMB; will allow also you to undock, or quit the
 218 application.
 219 </para></listitem>
 220 </varlistentry>
 221 <varlistentry>
 222 <term><guilabel>Only show in &kde;</guilabel></term>
 223 <listitem><para>When checked, the application entry will only be visible in all &kde; application launchers but not in other desktops environments.
 224 </para></listitem>
 225 </varlistentry>
 226 </variablelist>
 227 </sect1>
 228
 229 <sect1 id="details-advanced">
 230 <title>Advanced tab</title>
 231
 232 <variablelist>
 233 <varlistentry>
 234 <term><guilabel>Work path:</guilabel></term>
 235 <listitem><para>Specify the work path of the program. This will be the current
 236 path when the program launches. It does not need to be the same as the
 237 executable location.</para></listitem>
 238 </varlistentry>
 239 <varlistentry>
 240 <term><guilabel>Run in terminal</guilabel></term>
 241 <listitem><para>You must check this if your program requires terminal emulator
 242 in order to run. This mainly applies to <link
 243 linkend="gloss-console-application">console
 244 applications</link>.</para></listitem>
 245 </varlistentry>
 246 <varlistentry>
 247 <term><guilabel>Terminal options:</guilabel></term>
 248 <listitem><para>Put all terminal options in this field.</para></listitem>
 249 </varlistentry>
 250 <varlistentry>
 251 <term><guilabel>Run as a different user</guilabel></term>
 252 <listitem><para>If you want to run this program as a different user (not you),
 253 check this checkbox, and provide the username in the
 254 <guilabel>Username:</guilabel> field.</para></listitem>
 255 </varlistentry>
 256
 257 <varlistentry>
 258 <term><guilabel>Current shortcut key:</guilabel></term>
 259 <listitem><para>You can assign a special keyboard shortcut to launch your program.</para>
 260
 261 <para>Click the <guibutton>None</guibutton> button to the right of the <guilabel>Current
 262 shortcut key:</guilabel> checkbox.</para>
 263
 264 <para>The button text will change to <guilabel>Input...</guilabel>
 265 and you can press the key combination on your keyboard that you want to be assigned to your program.
 266 </para>
 267 <para>You can reset the shortcut to <guilabel>None</guilabel> by using this button: <inlinemediaobject><imageobject> <imagedata
 268 fileref="reset.png" format="PNG"/></imageobject></inlinemediaobject>.
 269 </para>
 270
 271 <para>Don't forget to save your setting by clicking the toolbar <guiicon>Save</guiicon> icon or using the <menuchoice>
 272 <guimenu>File</guimenu><guimenuitem>Save</guimenuitem>
 273 </menuchoice> menu item.</para>
 274
 275 </listitem>
 276 </varlistentry>
 277 </variablelist>
 278 </sect1>
 279
 280 </chapter>
 281
 282 <chapter id="menu-reference">
 283 <title>Menu Reference</title>
 284
 285 <variablelist>
 286 <varlistentry id="file-new-item">
 287 <term><menuchoice>
 288 <shortcut><keycombo
 289 action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
 290 <guimenu>File</guimenu> <guimenuitem>New Item...</guimenuitem>
 291 </menuchoice></term> <listitem><para><action>Adds new menu
 292 item.</action></para></listitem>
 293 </varlistentry>
 294
 295 <varlistentry id="file-new-submenu">
 296 <term><menuchoice>
 297 <guimenu>File</guimenu>
 298 <guimenuitem>New Submenu...</guimenuitem>
 299 </menuchoice></term>
 300 <listitem><para><action>Adds new submenu.</action></para></listitem>
 301 </varlistentry>
 302
 303 <varlistentry id="file-new-separator">
 304 <term><menuchoice><guimenu>File</guimenu><guimenuitem>New
 305 Separator</guimenuitem></menuchoice></term>
 306 <listitem>
 307 <para><action>Adds a new separator to the menu.</action></para>
 308 </listitem>
 309 </varlistentry>
 310
 311 <varlistentry id="file-save">
 312 <term><menuchoice>
 313 <shortcut><keycombo
 314 action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
 315 <guimenu>File</guimenu><guimenuitem>Save</guimenuitem>
 316 </menuchoice></term>
 317 <listitem>
 318 <para><action>Saves the menu</action></para>
 319 </listitem>
 320 </varlistentry>
 321
 322 <varlistentry id="file-quit">
 323 <term><menuchoice>
 324 <shortcut>
 325 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 326 </shortcut>
 327 <guimenu>File</guimenu>
 328 <guimenuitem>Quit</guimenuitem>
 329 </menuchoice></term>
 330 <listitem><para><action>Quits</action> &kmenuedit;.</para></listitem>
 331 </varlistentry>
 332
 333 <varlistentry id="edit-cut">
 334 <term><menuchoice>
 335 <shortcut>
 336 <keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
 337 </shortcut>
 338 <guimenu>
 339 Edit</guimenu> <guimenuitem>Cut</guimenuitem>
 340 </menuchoice></term>
 341 <listitem><para><action>Cuts the current menu item to the clipboard.</action> If
 342 you want to move menu item, you should first cut it to the clipboard, move to
 343 the destination place using the left panel, and use the
 344 <guimenuitem>Paste</guimenuitem> function to paste the menu item from the
 345 clipboard.</para></listitem>
 346 </varlistentry>
 347
 348 <varlistentry id="edit-copy">
 349 <term><menuchoice>
 350 <shortcut>
 351 <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
 352 </shortcut>
 353 <guimenu>
 354 Edit</guimenu> <guimenuitem>Copy</guimenuitem>
 355 </menuchoice></term>
 356 <listitem><para><action>Copies the current menu item to the
 357 clipboard</action>. You can later use the <guimenuitem>Paste</guimenuitem>
 358 function to paste the copied menu itemfrom the clipboard to its destination. You
 359 can paste the same item many times.</para></listitem>
 360 </varlistentry>
 361
 362 <varlistentry id="edit-paste">
 363 <term><menuchoice>
 364 <shortcut>
 365 <keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
 366 </shortcut>
 367 <guimenu>Edit</guimenu>
 368 <guimenuitem>Paste</guimenuitem> </menuchoice></term>
 369 <listitem><para><action>Paste menu item from the clipboard</action> to currently
 370 selected place in the <guimenu>Main</guimenu> menu. You must first use
 371 <guimenuitem>Cut</guimenuitem> or <guimenuitem>Copy</guimenuitem> before you can
 372 <guimenuitem>Paste</guimenuitem>.</para></listitem>
 373 </varlistentry>
 374
 375 <varlistentry id="edit-delete">
 376 <term><menuchoice>
 377 <shortcut><keycap>Delete</keycap></shortcut>
 378 <guimenu>Edit</guimenu> <guimenuitem>Delete</guimenuitem>
 379 </menuchoice></term>
 380 <listitem><para><action>Deletes currently selected menu
 381 item.</action></para></listitem>
 382 </varlistentry>
 383
 384 <varlistentry id="edit-restore">
 385 <term><menuchoice>
 386 <guimenu>Edit</guimenu> <guimenuitem>Restore to system menu</guimenuitem>
 387 </menuchoice></term>
 388 <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>
 389 </varlistentry>
 390
 391 <varlistentry id="settings-hide-toolbar">
 392 <term><menuchoice>
 393 <guimenu>Settings</guimenu>
 394 <guimenuitem>Show Toolbar</guimenuitem>
 395 </menuchoice></term>
 396 <listitem><para><action>Show or hide the toolbar</action></para></listitem>
 397 </varlistentry>
 398
 399 <varlistentry id="settings-configure-shortcuts">
 400 <term><menuchoice>
 401 <guimenu>Settings</guimenu><guimenuitem>Configure
 402 Shortcuts...</guimenuitem></menuchoice></term>
 403 <listitem>
 404 <para><action>Customize the keyboard shortcuts</action></para>
 405 </listitem>
 406 </varlistentry>
 407
 408 <varlistentry id="settings-configure-toolbars">
 409 <term><menuchoice>
 410 <guimenu>Settings</guimenu><guimenuitem>Configure
 411 Toolbars...</guimenuitem></menuchoice></term>
 412 <listitem>
 413 <para><action>Customize the toolbar icons.</action></para>
 414 </listitem>
 415 </varlistentry>
 416
 417 <varlistentry id="settings-configure-kmenuedit">
 418 <term><menuchoice>
 419 <guimenu>Settings</guimenu><guimenuitem>Configure
 420 &kde; Menu Editor...</guimenuitem></menuchoice></term>
 421 <listitem>
 422 <para><action>Open the Menu Editor settings dialog.</action></para>
 423 </listitem>
 424 </varlistentry>
 425 </variablelist>
 426
 427 &help.menu.documentation;
 428
 429 </chapter>
 430
 431 <chapter id="credits">
 432
 433 <title>Credits and License</title>
 434
 435 <para>
 436 &kmenuedit;
 437 </para>
 438 <para>Program copyright &copy; 2002, &Raffaele.Sandrini;</para>
 439
 440 <para>Contributors:</para>
 441 <itemizedlist>
 442 <listitem><para>&Matthias.Elter; &Matthias.Elter.mail; - Original
 443 Author</para>
 444 </listitem>
 445 <listitem><para>&Matthias.Ettrich; &Matthias.Ettrich.mail;</para>
 446 </listitem>
 447 <listitem><para>&Daniel.M.Duley; &Daniel.M.Duley.mail;</para>
 448 </listitem>
 449 <listitem><para>&Preston.Brown; &Preston.Brown.mail;</para>
 450 </listitem>
 451 </itemizedlist>
 452
 453 <para>Documentation copyright &copy; 2000 &Milos.Prudek;</para>
 454 <para>Documentation copyright &copy; 2008 &Anne-Marie.Mahfouf;</para>
 455 <para>Updated for &kde; 3.0 by &Lauri.Watts; &Lauri.Watts.mail;
 456 2002</para>
 457
 458 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 459
 460 &underFDL;
 461 &underGPL;
 462
 463 </chapter>
 464
 465 <glossary id="glossary">
 466 <title>Glossary</title>
 467
 468 <glossentry id="gloss-terminal-emulator">
 469 <glossterm>Terminal emulator</glossterm>
 470 <glossdef>
 471 <para>Terminal emulator is simply a windowed shell; this is known as
 472 <quote>command line window</quote> in some other environments. If you
 473 want to use the shell, you should know at least a few of the
 474 system-level commands for your operating system.</para>
 475 </glossdef>
 476 </glossentry>
 477
 478 <glossentry id="gloss-applet">
 479 <glossterm>Applet</glossterm>
 480 <glossdef><para>A small application that occupies very little memory
 481 and screen space, and at the same time gives you some useful
 482 information or provides a control shortcut. For instance the
 483 <application>Clock</application> applet shows current time and date
 484 (and even a month diary if you click it), and <application>System
 485 Monitor</application> applet shows how busy your machine currently is
 486 in real-time.</para> </glossdef>
 487 </glossentry>
 488
 489 <glossentry id="gloss-legacy-application">
 490 <glossterm>Legacy Application</glossterm>
 491 <glossdef>
 492
 493 <para>An X-window application which was not written with &kde; in
 494 mind. Such applications run fine in &kde;. However, they are not
 495 warned automatically when you shut down your &kde; session. You
 496 therefore must not forget to save documents open in these applications
 497 before you log out from &kde;. </para> <para>Additionally, many of
 498 these applications do not support copying and pasting from
 499 &kde; compliant applications. &Netscape; 4.x browser is a prominent
 500 example of such application <footnote><para>Some <ulink
 501 url="http://www.gnome.org">GNOME</ulink> applications may provide
 502 limited interoperability with the &kde;.</para></footnote>.</para>
 503 </glossdef>
 504 </glossentry>
 505
 506 <glossentry id="gloss-console-application">
 507 <glossterm>Console Application</glossterm>
 508 <glossdef>
 509
 510 <para>Application originally written for non-graphic, text oriented
 511 environment. Such applications run fine in &kde;. They must run within
 512 console emulator, like &konsole;. They are not warned automatically
 513 when you shut down your &kde; session. You therefore must not forget
 514 to save documents open in these applications before you log out from
 515 the &kde;.</para>
 516
 517 <para>Console applications support copying and pasting from
 518 &kde;-compliant applications.Simply mark the text in the console
 519 application with your mouse, switch to the &kde;-compliant application
 520 and press <keycombo action="simul">&Ctrl;
 521 <keycap>V</keycap></keycombo> to paste the text. If you want to copy
 522 from &kde; application to a console application, first mark the text
 523 with your mouse, press <keycombo action="simul">&Ctrl;
 524 <keycap>C</keycap></keycombo>, switch to the console application and
 525 press the middle button on your mouse<footnote><para>If your mouse
 526 does not have a middle button, you must press
 527 <mousebutton>left</mousebutton> and <mousebutton>right</mousebutton>
 528 button at the same time. This is called <quote>middle button
 529 emulation</quote> and it must be supported by your operating system to
 530 work.</para></footnote>.</para>
 531
 532 </glossdef>
 533 </glossentry>
 534
 535 </glossary>
 536
 537 &documentation.index;
 538
 539 </book>
 540 <!--
 541 Local Variables:
 542 mode: sgml
 543 sgml-minimize-attributes: nil
 544 sgml-general-insert-case: lower
 545 End:
 546 -->
 547