runtime/doc/kcontrol/ebrowsing/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4 <!ENTITY % addindex "IGNORE">
   5 <!ENTITY % English "INCLUDE" > <!-- change language only here -->
   6 ]>
   7
   8 <article lang="&language;">
   9 <articleinfo>
  10
  11 <authorgroup>
  12 <author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author>
  13 <author>&Yves.Arrouye; &Yves.Arrouye.mail;</author>
  14 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  15 </authorgroup>
  16
  17 <date>2002-10-16</date>
  18 <releaseinfo>3.1</releaseinfo>
  19
  20 <keywordset>
  21 <keyword>KDE</keyword>
  22 <keyword>KControl</keyword>
  23 <keyword>enhanced browsing</keyword>
  24 <keyword>web shortcuts</keyword>
  25 <keyword>browsing</keyword>
  26 </keywordset>
  27
  28 </articleinfo>
  29 <sect1 id="ebrowse">
  30
  31 <title>Web Shortcuts</title>
  32
  33 <sect2 id="ebrowse-intro">
  34
  35 <title>Introduction</title>
  36
  37 <para>&konqueror; offers some features to enhance your browsing
  38 experience. One such feature is <emphasis>Web Shortcuts</emphasis>.</para>
  39
  40 <para>You may already have noticed that &kde; is very Internet friendly.
  41 For example, you can click on the <guimenuitem>Run</guimenuitem> menu
  42 item or type the keyboard shortcut assigned to that command (<keycombo
  43 action="simul">&Alt;<keycap>F2</keycap></keycombo>,
  44 unless you have changed it) and type in a <acronym>URI</acronym>.
  45 <footnote><para>Uniform Resource Identifier. A standardized way of
  46 referring to a resource such as a file on your computer, a World Wide
  47 Web address, an email address,
  48 <abbrev>etc...</abbrev>.</para></footnote></para>
  49
  50 <para>Web shortcuts, on the other hand, let you come up with new pseudo
  51 <acronym>URL</acronym> schemes, or shortcuts, that basically let you
  52 <emphasis>parameterize</emphasis> commonly used
  53 <acronym>URI</acronym>s. For example, if you like the Google search
  54 engine, you can configure KDE so that a pseudo <acronym>URL</acronym>
  55 scheme like <emphasis>gg</emphasis> will trigger a search on
  56 Google. This way, typing <userinput>gg:<replaceable>my
  57 query</replaceable></userinput> will search for <replaceable>my
  58 query</replaceable> on Google.</para>
  59
  60 <note><para>One can see why we call these pseudo <acronym>URL</acronym>
  61 schemes. They are used like a <acronym>URL</acronym> scheme, but the
  62 input is not properly <acronym>URL</acronym> encoded, so one will type
  63 <userinput>google:kde apps</userinput> and not
  64 <userinput>google:kde+apps</userinput>.</para></note>
  65
  66 <para>You can use web
  67 shortcuts wherever you would normally use
  68 <acronym>URI</acronym>s. Shortcuts for several search engines should
  69 already be configured on your system, but you can add new keywords, and
  70 change or delete existing ones in the enhanced browsing control
  71 module. </para>
  72
  73 </sect2>
  74
  75 <sect2 id="ebrowse-use">
  76
  77 <title>Use</title>
  78
  79 <para>There is a single tab in this control module. The title of the tab
  80 is <guilabel>Keywords</guilabel>. This tab features two main boxes, one
  81 for Internet Keywords and one for web shortcuts.</para>
  82
  83 <sect3 id="ebrowse-srch-use">
  84
  85 <title>Web Shortcuts</title>
  86
  87 <para>The descriptive names of defined web shortcuts are shown in a
  88 listbox. As with other lists in &kde;, you can click on a column
  89 heading to toggle the sort order between ascending and
  90 descending, and you can resize the columns.</para>
  91
  92 <para>If you double-click on a specific entry in the list of defined
  93 search providers, the details for that entry are shown in a popup
  94 dialog.  In addition to the descriptive name for the item, you can
  95 also see the <acronym>URI</acronym> which is used, as well as the
  96 associated shortcuts which you can type anywhere in &kde; where
  97 <acronym>URI</acronym>s are expected. A given search provider can have
  98 multiple shortcuts, each separated by a comma.</para>
  99
 100 <para> The text boxes are used not only for displaying information
 101 about an item in the list of web shortcuts, but also for modifying or
 102 adding new items.</para>
 103
 104 <para>You can change the contents of either the <guilabel>Search
 105 URI</guilabel> or the <guilabel>URI Shortcuts</guilabel> text box.
 106 Click <guibutton>OK</guibutton> to save your changes or
 107 <guibutton>Cancel</guibutton> to exit the dialog with no
 108 changes.</para>
 109
 110 <para>If you examine the contents of the <guilabel>Search
 111 URI</guilabel> text box, you will find that most, if not all of the
 112 entries have a <option>\{@}</option> in them. This sequence of two
 113 characters acts as a parameter, which is to say that they are replaced
 114 by whatever you happen to type after the colon character that is
 115 between a shortcut and its parameter. Let's consider some examples to
 116 clarify this idea.</para>
 117
 118 <para>Suppose that the <acronym>URI</acronym> is
 119 <userinput>http://www.google.com/search?q=\{@}</userinput>, and
 120 <userinput>gg</userinput> is a shortcut to this
 121 <acronym>URI</acronym>. Then, typing
 122 <userinput>gg:<replaceable>alpha</replaceable></userinput> is
 123 equivalent to
 124 <userinput>http://www.google.com/search?q=<replaceable>alpha</replaceable></userinput>.
 125 You could type anything after the <userinput>:</userinput> character;
 126 whatever you have typed simply replaces the <option>\{@}</option>
 127 characters, after being converted to the appropriate character set for
 128 the search provider and then properly
 129 <acronym>URL</acronym>-encoded. Only the <option>\{@}</option> part of
 130 the search <acronym>URI</acronym> is touched, the rest of it is
 131 supposed to be properly <acronym>URL</acronym>-encoded already and is
 132 left as is.</para>
 133
 134 <para>You can also have shortcuts without parameters. Suppose the
 135 <acronym>URI</acronym> was
 136 <emphasis>file:/home/me/mydocs/kofficefiles/kword</emphasis> and the
 137 shortcut was <emphasis>mykword</emphasis>. Then, typing
 138 <userinput>mykword:</userinput> is the same as typing the complete
 139 <acronym>URI</acronym>. Note that there is nothing after the colon
 140 when typing the shortcut, but the colon is still required in order for
 141 the shortcut to be recognized as such.</para>
 142
 143 <para>By now, you will have understood that even though these shortcuts
 144 are called web shortcuts, they really are shortcuts to parameterized
 145 <acronym>URI</acronym>s, which can point not only to web sites like
 146 search engines but also to anything else that can be pointed to by a
 147 <acronym>URI</acronym>. Web shortcuts are a very powerful feature of
 148 navigation in &kde;.</para>
 149
 150 </sect3>
 151
 152 </sect2>
 153
 154 </sect1>
 155
 156 </article>