~ubuntu-branches/ubuntu/gutsy/kdebase-workspace/gutsy-backports

<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>

<para>To start off, we need to open &kmenuedit;, so &RMB; on the &kmenu;, click <guimenuitem>Menu Editor</guimenuitem> to start &kmenuedit;. After &kmenuedit; has started, select <guisubmenu>Internet</guisubmenu> as shown in picture below.

<screeninfo>Select <guisubmenu>Internet</guisubmenu></screeninfo>

</imageobject>

<phrase>Select <guisubmenu>Internet</guisubmenu></phrase>

</textobject>

</mediaobject>

</screenshot></para>

<para>

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>.

<screeninfo><guilabel>New Item</guilabel> dialog</screeninfo>

100

101

102

</imageobject>

103

104

<phrase>The <guilabel>New Item</guilabel> dialog.</phrase>

105

</textobject>

106

</mediaobject>

107

</screenshot>

108

</para>

109

<para>

110

Press return, and you should see something like the picture below in the main window.

111

112

113

114

115

116

</imageobject>

117

118

<phrase>The new item created.</phrase>

119

</textobject>

120

</mediaobject>

121

</screenshot></para>

122

123

<para>

124

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 &kmenu; 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>

125

<note><para>Following the command, you can have several place holders which will be replaced with actual values when the program is run:

126

127

<member>%f - a single file name</member>

128

<member>%F - a list of files; use for applications that can open several local files at once</member>

129

<member>%u - a single &URL;</member>

130

131

<member>%d - the folder of a file to open</member>

132

<member>%D - a list of folders</member>

133

134

135

<member>%c - the caption</member>

136

</simplelist></para>

137

<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>

138

<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.

139

140

<screeninfo><guilabel>Select Icon</guilabel> dialog</screeninfo>

141

142

143

144

</imageobject>

145

146

<phrase>The <guilabel>Select Icon</guilabel> dialog.</phrase>

147

</textobject>

148

</mediaobject>

149

</screenshot></para>

150

151

<para>We choose the firefox icon from the list, and press return. Your finished screen should probably look something like the screenshot below.

152

153

<screeninfo>Done screenshot</screeninfo>

154

155

156

157

</imageobject>

158

159

<phrase>This is what the completed menu item should looks like.</phrase>

160

</textobject>

161

</mediaobject>

162

</screenshot></para>

163

164

<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 &kmenu; <guisubmenu>Internet</guisubmenu> submenu!</para>

165

166

167

168

</chapter>

169

170

171

<title>Using &kmenuedit;</title>

172

173

<para>The left application panel shows the &kmenu; structure. When

174

you browse items in the left panel, the right panel shows detailed

175

information for the highlighted menu item.</para>

176

177

178

<title>General program information</title>

179

180

181

182

183

<listitem><para>This is the name of your program as it appears in the

184

&kmenu; menu. It can be different from the real executable

185

name. For instance the name of <command>mc</command> executable is

186

"<application>Midnight Commander</application>".</para></listitem>

187

</varlistentry>

188

189

<term><guilabel>Description:</guilabel></term>

190

<listitem><para>The description will be displayed together with the name in the &kmenu;. This is

191

entirely optional.</para></listitem>

192

</varlistentry>

193

194

<term><guilabel>Comment:</guilabel></term>

195

<listitem><para>Describe the program in greater detail in this field. This is

196

entirely optional.</para></listitem>

197

</varlistentry>

198

199

<term><guilabel>Command:</guilabel></term>

200

<listitem><para>This is the name of the executable program. Make sure that you

201

have permission to run the program.</para></listitem>

202

</varlistentry>

203

204

<term><guilabel>Enable launch feedback</guilabel></term>

205

<listitem><para>If this box is checked, this will display feedback when an application is started

206

</para></listitem>

207

</varlistentry>

208

209

<term><guilabel>Place in system tray</guilabel></term>

210

<listitem><para>When checked, the application's icon will show up in the panel system tray.

211

You will then be able to hide or show the application by clicking on the system

212

tray icon. Clicking on it using the &RMB; will allow also you to undock, or quit the

213

application.

214

</para></listitem>

215

</varlistentry>

216

217

218

<listitem><para>Click

219

this icon to display a choice of icons. Choose an icon for your

220

program.</para></listitem>

221

</varlistentry>

222

223

224

<listitem><para>Specify the work path of the program. This will be the current

225

path when the program launches. It does not need to be the same as the

226

executable location.</para></listitem>

227

</varlistentry>

228

229

<term><guilabel>Run in terminal</guilabel></term>

230

<listitem><para>You must check this if your program requires terminal emulator

231

in order to run. This mainly applies to <link

232

linkend="gloss-console-application">console

233

applications</link>.</para></listitem>

234

</varlistentry>

235

236

<term><guilabel>Terminal options:</guilabel></term>

237

<listitem><para>Put all terminal options in this field.</para></listitem>

238

</varlistentry>

239

240

<term><guilabel>Run as a different user</guilabel></term>

241

<listitem><para>If you want to run this program as a different user (not you),

242

check this checkbox, and provide the username in the

243

<guilabel>Username:</guilabel> field.</para></listitem>

244

</varlistentry>

245

</variablelist>

246

247

<para>You can assign a special keyboard shortcut to launch your program.</para>

248

249

<para>Click the <guibutton>None</guibutton> button to the right of the <guilabel>Current

250

shortcut key:</guilabel> checkbox.</para>

251

252

<para>A dialog box will pop up, allowing you to assign a <guilabel>Primary shortcut:</guilabel>

253

by pressing the key combination on your keyboard that you want to be assigned to your program.

254

It might be useful to assign a second

255

keybinding to the same item by checking the

256

<guilabel>Alternate shortcut:</guilabel> button, for

257

example, if you often switch keyboard maps, and some shortcuts are not

258

as convenient to type at all times.</para>

259

260

<para>Click the <guiicon>x</guiicon> to clear the shortcut, if you

261

made a mistake. Check the <guilabel>Multi-key mode</guilabel> box if you

262

want to assign a shortcut that uses more than one key.</para>

263

264

<para>The dialog will close when you have selected a keybinding.

265

</para>

266

267

</sect1>

268

269

</chapter>

270

271

272

<title>Menu Reference</title>

273

274

275

276

277

<shortcut><keycombo

278

action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>

279

280

</menuchoice></term> <listitem><para><action>Adds new menu

281

item.</action></para></listitem>

282

</varlistentry>

283

284

285

286

287

<guimenuitem>New Submenu...</guimenuitem>

288

</menuchoice></term>

289

<listitem><para><action>Adds new submenu.</action></para></listitem>

290

</varlistentry>

291

292

293

<term><menuchoice><guimenu>File</guimenu><guimenuitem>New

294

Separator</guimenuitem></menuchoice></term>

295

296

<para><action>Adds a new separator to the menu.</action></para>

297

</listitem>

298

</varlistentry>

299

300

301

302

<shortcut><keycombo

303

action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>

304

305

</menuchoice></term>

306

307

<para><action>Saves the menu</action></para>

308

</listitem>

309

</varlistentry>

310

311

312

313

314

315

</shortcut>

316

317

318

</menuchoice></term>

319

<listitem><para><action>Quits</action> &kmenuedit;.</para></listitem>

320

</varlistentry>

321

322

323

324

325

326

</shortcut>

327

328

Edit</guimenu> <guimenuitem>Cut</guimenuitem>

329

</menuchoice></term>

330

<listitem><para><action>Cuts the current menu item to the clipboard.</action> If

331

you want to move menu item, you should first cut it to the clipboard, move to

332

the destination place using the left panel, and use the

333

<guimenuitem>Paste</guimenuitem> function to paste the menu item from the

334

clipboard.</para></listitem>

335

</varlistentry>

336

337

338

339

340

341

</shortcut>

342

343

Edit</guimenu> <guimenuitem>Copy</guimenuitem>

344

</menuchoice></term>

345

<listitem><para><action>Copies the current menu item to the

346

clipboard</action>. You can later use the <guimenuitem>Paste</guimenuitem>

347

function to paste the copied menu itemfrom the clipboard to its destination. You

348

can paste the same item many times.</para></listitem>

349

</varlistentry>

350

351

352

353

354

355

</shortcut>

356

357

<guimenuitem>Paste</guimenuitem> </menuchoice></term>

358

<listitem><para><action>Paste menu item from the clipboard</action> to currently

359

selected place in the <guimenu>Main</guimenu> menu. You must first use

360

<guimenuitem>Cut</guimenuitem> or <guimenuitem>Copy</guimenuitem> before you can

361

<guimenuitem>Paste</guimenuitem>.</para></listitem>

362

</varlistentry>

363

364

365

366

<shortcut><keycap>Delete</keycap></shortcut>

367

<guimenu>Edit</guimenu> <guimenuitem>Delete</guimenuitem>

368

</menuchoice></term>

369

<listitem><para><action>Deletes currently selected menu

370

item.</action></para></listitem>

371

</varlistentry>

372

373

374

375

<guimenu>Settings</guimenu>

376

<guimenuitem>Show/Hide Toolbar</guimenuitem>

377

</menuchoice></term>

378

<listitem><para><action>Show or hide the toolbar</action></para></listitem>

379

</varlistentry>

380

381

382

383

<guimenu>Settings</guimenu><guimenuitem>Configure

384

Shortcuts...</guimenuitem></menuchoice></term>

385

386

<para><action>Customize the keyboard shortcuts</action></para>

387

</listitem>

388

</varlistentry>

389

390

391

392

<guimenu>Settings</guimenu><guimenuitem>Configure

393

Toolbars...</guimenuitem></menuchoice></term>

394

395

<para><action>Customize the toolbar icons.</action></para>

396

</listitem>

397

</varlistentry>

398

399

</variablelist>

400

401

&help.menu.documentation;

402

403

</chapter>

404

405

406

407

<title>Credits and License</title>

408

409

<para>

410

&kmenuedit;

411

</para>

412

413

414

<para>Contributors:</para>

415

416

<listitem><para>&Matthias.Elter; &Matthias.Elter.mail; - Original

417

Author</para>

418

</listitem>

419

<listitem><para>&Matthias.Ettrich; &Matthias.Ettrich.mail;</para>

420

</listitem>

421

<listitem><para>&Daniel.M.Duley; &Daniel.M.Duley.mail;</para>

422

</listitem>

423

<listitem><para>&Preston.Brown; &Preston.Brown.mail;</para>

424

</listitem>

425

</itemizedlist>

426

427

428

429

<para>Updated for &kde; 3.0 by &Lauri.Watts; &Lauri.Watts.mail;

430

2002</para>

431

432

433

434

&underFDL;

435

&underGPL;

436

437

</chapter>

438

439

440

<title>Glossary</title>

441

442

443

<glossterm>Terminal emulator</glossterm>

444

445

<para>Terminal emulator is simply a windowed shell; this is known as

446

<quote>command line window</quote> in some other environments. If you

447

want to use the shell, you should know at least a few of the

448

system-level commands for your operating system.</para>

449

</glossdef>

450

</glossentry>

451

452

453

<glossterm>Applet</glossterm>

454

<glossdef><para>A small application that occupies very little memory

455

and screen space, and at the same time gives you some useful

456

information or provides a control shortcut. For instance the

457

<application>Clock</application> applet shows current time and date

458

(and even a month diary if you click it), and <application>System

459

Monitor</application> applet shows how busy your machine currently is

460

in real-time.</para> </glossdef>

461

</glossentry>

462

463

464

<glossterm>Legacy Application</glossterm>

465

466

467

<para>An X-window application which was not written with &kde; in

468

mind. Such applications run fine in &kde;. However, they are not

469

warned automatically when you shut down your &kde; session. You

470

therefore must not forget to save documents open in these applications

471

before you log out from &kde;. </para> <para>Additionally, many of

472

these applications do not support copying and pasting from

473

&kde; compliant applications. &Netscape; 4.x browser is a prominent

474

example of such application <footnote><para>Some <ulink

475

url="http://www.gnome.org">GNOME</ulink> applications may provide

476

limited interoperability with the &kde;.</para></footnote>.</para>

477

</glossdef>

478

</glossentry>

479

480

481

<glossterm>Console Application</glossterm>

482

483

484

<para>Application originally written for non-graphic, text oriented

485

environment. Such applications run fine in &kde;. They must run within

486

console emulator, like &konsole;. They are not warned automatically

487

when you shut down your &kde; session. You therefore must not forget

488

to save documents open in these applications before you log out from

489

the &kde;.</para>

490

491

<para>Console applications support copying and pasting from

492

&kde;-compliant applications.Simply mark the text in the console

493

application with your mouse, switch to the &kde;-compliant application

494

and press <keycombo action="simul">&Ctrl;

495

<keycap>V</keycap></keycombo> to paste the text. If you want to copy

496

from &kde; application to a console application, first mark the text

497

with your mouse, press <keycombo action="simul">&Ctrl;

498

<keycap>C</keycap></keycombo>, switch to the console application and

499

press the middle button on your mouse<footnote><para>If your mouse

500

does not have a middle button, you must press

501

<mousebutton>left</mousebutton> and <mousebutton>right</mousebutton>

502

button at the same time. This is called <quote>middle button

503

emulation</quote> and it must be supported by your operating system to

504

work.</para></footnote>.</para>

505

506

</glossdef>

507

</glossentry>

508

509

</glossary>

510

511

&documentation.index;

512

513

</book>

514

<!--

515

Local Variables:

516

mode: sgml

517

sgml-minimize-attributes: nil

518

sgml-general-insert-case: lower

519

End:

520

-->

521

Older »