runtime/doc/userguide/standard-menu-entries.docbook

   1 <chapter id="menus">
   2 <chapterinfo>
   3 <authorgroup>
   4 <author>
   5 &Philip.Rodrigues;
   6 </author>
   7 </authorgroup>
   8 </chapterinfo>
   9
  10
  11 <title>The Standard Menu Entries</title>
  12
  13 <!-- FIXME: The text is immensely repetitive. Fix that. -->
  14
  15 <para>One of the main ways that you'll control programs in &kde; is
  16 via the program's menus. They provide access to nearly everything
  17 you'll need to do with that program. So that you can more easily
  18 remember where things are in the menus, and to help you learn new
  19 programs more easily, the menus have a standard layout. This means
  20 that once you know how to open a file in one program, you know how to
  21 open a file in any &kde; program. Let's take a look at the standard
  22 menus:</para> <!-- TODO: Note that programs have other menu entries as well-->
  23
  24 <!-- Probably a good place for a screenie, but we'd need one showing
  25 *only* the standard entries -->
  26
  27 <variablelist>
  28 <title>The <guimenu>File</guimenu> Menu</title>
  29 <varlistentry>
  30 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap>
  31 </keycombo>
  32 </shortcut><guimenuitem>New</guimenuitem>
  33 </menuchoice></term>
  34 <listitem><para>This entry will start a new, blank document that's
  35 appropriate to the program you're using. For example, in &kate; (the
  36 &kde; Advanced Text Editor) this entry creates a new text file.</para>
  37 </listitem>
  38 </varlistentry>
  39
  40 <varlistentry>
  41 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap>
  42 </keycombo>
  43 </shortcut><guimenuitem>Open...</guimenuitem>
  44 </menuchoice></term>
  45 <listitem><para>The <guimenuitem>Open...</guimenuitem> menu entry
  46 displays the &kde; <quote>Open File</quote> dialog box, where you can
  47 choose a file to open in the program you're using. The <quote>Open
  48 File</quote> dialog is also standardized, so it's the same for all
  49 &kde; programs. You can find out more about using this dialog
  50 somewhere else in this guide <!-- FIXME: real link -->.</para>
  51 <para>You probably noticed that this menu entry had an ellipsis (...)
  52 after the name of the entry. This means that clicking on the entry
  53 will open a dialog box of some kind. If you make any changes in the
  54 dialog box that appears, they won't take effect until you click on the
  55 <guibutton>OK</guibutton> button in the dialog. You can always ignore
  56 any changes you made, and close the dialog, by clicking on the
  57 <guibutton>Cancel</guibutton> button.</para>
  58 </listitem>
  59 </varlistentry>
  60
  61 <varlistentry>
  62 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap>
  63 </keycombo>
  64 </shortcut><guimenuitem>Save</guimenuitem>
  65 </menuchoice></term>
  66 <listitem><para>This menu entry will save any changes you've made to
  67 the file that you are currently working on. If this is the first time
  68 that you've saved the file, the &kde; <quote>Save File</quote> dialog
  69 will appear, and ask you for a name and location for the file. <!-- TODO: Point to another section for more info --></para>
  70 </listitem>
  71 </varlistentry>
  72
  73
  74
  75 <varlistentry>
  76 <term><menuchoice><guimenuitem>Save As...</guimenuitem>
  77 </menuchoice></term>
  78 <listitem><para>The <guimenuitem>Save As...</guimenuitem> menu entry
  79 will save the file you're working on with a different name. The
  80 <quote>Save File</quote> dialog appears, and you can choose a name and
  81 location as usual. Note that after you save the file with
  82 <guimenuitem>Save As..</guimenuitem>, you will be working on the
  83 <emphasis>new</emphasis> file. If you save changes, they will be saved
  84 under the new filename. To make this a bit clearer, let's take an
  85 example:
  86
  87 <orderedlist>
  88 <listitem><para>You are working on a file called
  89 <filename>hello.txt</filename> that contains the text <quote>Hello
  90 World!</quote> </para>
  91 </listitem>
  92
  93 <listitem><para>You use the <guimenuitem>Save As...</guimenuitem> menu
  94 entry to save the file with the new name
  95 <filename>newhello.txt</filename>. </para>
  96 </listitem>
  97
  98 <listitem><para>You add the text <quote>Nice to see you!</quote> to
  99 the file, and use the <guimenuitem>Save</guimenuitem> menu entry to
 100 save these changes.</para>
 101 </listitem>
 102 </orderedlist>
 103
 104
 105
 106 Now, the file <filename>newhello.txt</filename> contains the text
 107 <quote>Hello World! Nice to see you!</quote>, while the file
 108 <filename>hello.txt</filename> contains only the text <quote>Hello
 109 World!</quote>.
 110 </para>
 111 </listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap>
 116 </keycombo>
 117 </shortcut><guimenuitem>Print...</guimenuitem>
 118 </menuchoice></term>
 119 <listitem><para>This menu entry displays the &kde;
 120 <quote>Print</quote> dialog, read to print the current
 121 document. Youcan find more information about the options available in
 122 this dialog in <xref linkend="printing-from-apps"/>.</para>
 123 </listitem>
 124 </varlistentry>
 125
 126 <varlistentry>
 127 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>W</keycap>
 128 </keycombo>
 129 </shortcut><guimenuitem>Close</guimenuitem>
 130 </menuchoice></term>
 131 <listitem><para>This menu entry closes the current document. If you
 132 have made any changes since you last saved the document, you will be
 133 asked whether you want to save those changes. You can choose to
 134 <guibutton>Save</guibutton> or <guibutton>Discard</guibutton> those
 135 changes. If you didn't really want to close the file, just click
 136 <guibutton>Cancel</guibutton>.</para>
 137 </listitem>
 138 </varlistentry>
 139
 140 <varlistentry>
 141 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap>
 142 </keycombo>
 143 </shortcut><guimenuitem>Quit</guimenuitem>
 144 </menuchoice></term>
 145 <listitem><para>Use this entry to close the program you're using. If
 146 you have unsaved changes in any files, you will be asked whether you
 147 want to
 148 save them.</para>
 149 </listitem>
 150 </varlistentry>
 151
 152
 153
 154 </variablelist>
 155
 156 <variablelist>
 157 <title>The <guimenu>Edit</guimenu> Menu</title>
 158
 159 <varlistentry>
 160 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap>
 161 </keycombo>
 162 </shortcut><guimenuitem>Undo</guimenuitem>
 163 </menuchoice></term>
 164 <listitem><para>Use this entry to remove the effect of the last
 165 action you performed in the application. For example, if you deleted a
 166 line of text, the <guimenuitem>Undo</guimenuitem> menu entry will
 167 replace that line.</para>
 168 </listitem>
 169 </varlistentry>
 170
 171 <varlistentry>
 172 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap>
 173 </keycombo>
 174 </shortcut><guimenuitem>Redo</guimenuitem>
 175 </menuchoice></term>
 176 <listitem><para>Use this menu entry to perform the last action that
 177 you removed with the <guimenuitem>Undo</guimenuitem> menu entry. For
 178 example, if, as in the example above, you had replaced a deleted line
 179 of text with <guimenuitem>Undo</guimenuitem>, the
 180 <guimenuitem>Redo</guimenuitem> entry would redo the action of
 181 deleting the line.</para>
 182 </listitem>
 183 </varlistentry>
 184
 185 <varlistentry>
 186 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>X</keycap>
 187 </keycombo>
 188 </shortcut><guimenuitem>Cut</guimenuitem>
 189 </menuchoice></term>
 190 <listitem><para>This menu entry cuts the contents of the current
 191 selection to the clipboard. See <xref linkend="using-the-clipboard"/>
 192 for more information.
 193 </para>
 194 </listitem>
 195 </varlistentry>
 196
 197 <varlistentry>
 198 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap>
 199 </keycombo>
 200 </shortcut><guimenuitem>Copy</guimenuitem>
 201 </menuchoice></term>
 202 <listitem><para>This menu entry copies the contents of the current
 203 selection to the clipboard. See <xref linkend="using-the-clipboard"/>
 204 for more information.
 205 </para>
 206 </listitem>
 207 </varlistentry>
 208
 209 <varlistentry>
 210 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap>
 211 </keycombo>
 212 </shortcut><guimenuitem>Paste</guimenuitem>
 213 </menuchoice></term>
 214 <listitem><para>This menu entry inserts the contents of the clipboard
 215 in the current document. The clipboard contents are inserted where the
 216 cursor is currently positioned.</para>
 217 </listitem>
 218 </varlistentry>
 219
 220 <varlistentry>
 221 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap>
 222 </keycombo>
 223 </shortcut><guimenuitem>Select All</guimenuitem>
 224 </menuchoice></term>
 225 <listitem><para>Use this item to select the whole of the current
 226 document.</para>
 227 </listitem>
 228 </varlistentry>
 229
 230 <varlistentry>
 231 <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap>
 232 </keycombo>
 233 </shortcut><guimenuitem>Find...</guimenuitem>
 234 </menuchoice></term>
 235 <listitem><para>This menu entry displays the <guilabel>Find
 236 Text</guilabel> dialog, which you can use to search for a particular
 237 word or phrase in the current document.
 238 </para>
 239 </listitem>
 240 </varlistentry>
 241
 242 <varlistentry>
 243 <term><menuchoice><shortcut><keycombo action="simul"><keycap>F3</keycap>
 244 </keycombo>
 245 </shortcut><guimenuitem>Find Next</guimenuitem>
 246 </menuchoice></term>
 247 <listitem><para>Use this item to find the next occurrence of the most
 248 recent text you searched for using <guimenuitem>Find...</guimenuitem>.
 249 </para>
 250 </listitem>
 251 </varlistentry>
 252
 253 </variablelist>
 254
 255 <variablelist>
 256 <title>The <guimenu>Settings</guimenu> Menu</title>
 257
 258 <varlistentry>
 259 <term><menuchoice><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term>
 260 <listitem><para>In the dialog displayed by this menu entry, you can
 261 change the keyboard shortcuts used by the application. See <xref
 262 linkend="configure-shortcuts"/>.
 263 </para>
 264 </listitem>
 265 </varlistentry>
 266
 267 <varlistentry>
 268 <term><menuchoice><guimenuitem>Configure
 269 Toolbars...</guimenuitem></menuchoice></term>
 270
 271 <listitem><para>In the dialog displayed by this menu entry, you can
 272 change which buttons appear on the application's toolbars. See <xref
 273 linkend="configuring-toolbars"/>.
 274 </para>
 275 </listitem>
 276 </varlistentry>
 277
 278 <varlistentry>
 279 <term><menuchoice><guimenuitem>Configure Notifications...</guimenuitem></menuchoice></term>
 280 <listitem><para>In the dialog displayed by this menu entry, you can
 281 change the notifications (sounds, error messages, &etc;)  used by the
 282 application. See <xref
 283 linkend="configure-notifications"/>.
 284 </para>
 285 </listitem>
 286 </varlistentry>
 287
 288 <varlistentry>
 289 <term><menuchoice><guimenuitem>Configure <replaceable>Application</replaceable></guimenuitem></menuchoice></term>
 290 <listitem><para>In the dialog displayed by this menu entry, you can
 291 change settings relating to how the application works in general.
 292 </para>
 293 </listitem>
 294 </varlistentry>
 295
 296 </variablelist>
 297
 298
 299 &help.menu.documentation;
 300
 301 </chapter>
 302
 303 <!-- Keep this comment at the end of the file
 304 Local variables:
 305 mode: xml
 306 sgml-omittag:nil
 307 sgml-shorttag:nil
 308 sgml-namecase-general:nil
 309 sgml-general-insert-case:lower
 310 sgml-minimize-attributes:nil
 311 sgml-always-quote-attributes:t
 312 sgml-indent-step:0
 313 sgml-indent-data:true
 314 sgml-parent-document:("index.docbook" "book" "chapter")
 315 sgml-exposed-tags:nil
 316 sgml-local-catalogs:nil
 317 sgml-local-ecat-files:nil
 318 End:
 319 -->