Warning, /frameworks/kio/docs/kcontrol5/webshortcuts/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
0003 "dtd/kdedbx45.dtd" [
0004 <!ENTITY % addindex "IGNORE">
0005 <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0006 ]>
0007 
0008 <article id="ebrowsing" lang="&language;">
0009 <articleinfo>
0010 <title>Web Shortcuts</title>
0011 <authorgroup>
0012 <author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author>
0013 <author>&Yves.Arrouye; &Yves.Arrouye.mail;</author>
0014 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0015 </authorgroup>
0016 
0017 <date>2016-11-10</date>
0018 <releaseinfo>Frameworks 5.29</releaseinfo>
0019 
0020 <keywordset>
0021 <keyword>KDE</keyword>
0022 <keyword>Systemsettings</keyword>
0023 <keyword>enhanced browsing</keyword>
0024 <keyword>web shortcuts</keyword>
0025 <keyword>browsing</keyword>
0026 </keywordset>
0027 
0028 </articleinfo>
0029 <sect1 id="ebrowse">
0030 
0031 <title>Web Shortcuts</title>
0032 
0033 <sect2 id="ebrowse-intro">
0034 
0035 <title>Introduction</title>
0036 
0037 <para>&konqueror; offers some features to enhance your browsing
0038 experience. One such feature is <emphasis>Web Shortcuts</emphasis>.</para>
0039 
0040 <para>You may already have noticed that &kde; is very Internet friendly.
0041 For example, you can click on the <guimenuitem>Run</guimenuitem> menu
0042 item or type the keyboard shortcut assigned to that command (<keycombo
0043 action="simul">&Alt;<keycap>F2</keycap></keycombo> or <keycombo
0044 action="simul">&Alt;&Space;</keycombo>,
0045 unless you have changed it) and type in a &URI;.
0046 <footnote><para>Uniform Resource Identifier. A standardized way of
0047 referring to a resource such as a file on your computer, a World Wide
0048 Web address, an email address, &etc;</para></footnote></para>
0049 
0050 <para>Web shortcuts, on the other hand, let you come up with new pseudo
0051 &URL; schemes, or shortcuts, that basically let you
0052 <emphasis>parameterize</emphasis> commonly used
0053 &URI;s. For example, if you like the Google search
0054 engine, you can configure &kde; so that a pseudo &URL;
0055 scheme like <emphasis>gg</emphasis> will trigger a search on
0056 Google. This way, typing <userinput>gg:<replaceable>my
0057 query</replaceable></userinput> will search for <replaceable>my
0058 query</replaceable> on Google.</para>
0059 
0060 <note><para>One can see why we call these pseudo &URL;
0061 schemes. They are used like a &URL; scheme, but the
0062 input is not properly &URL; encoded, so one will type
0063 <userinput>google:kde apps</userinput> and not
0064 <userinput>google:kde+apps</userinput>.</para></note>
0065 
0066 <para>You can use web
0067 shortcuts wherever you would normally use
0068 &URI;s. Shortcuts for several search engines should
0069 already be configured on your system, but you can add new keywords, and
0070 change or delete existing ones in this module.</para>
0071 
0072 </sect2>
0073 
0074 <sect2 id="ebrowse-use">
0075 
0076 <title>Web Search Keywords</title>
0077 
0078 <para>The descriptive names of defined web shortcuts are shown in a
0079 list box. As with other lists in &kde;, you can click on a column
0080 heading to toggle the sort order between ascending and
0081 descending, and you can resize the columns.</para>
0082 
0083 <para>At the bottom of the list the option <guilabel>Enable Web search keywords</guilabel>
0084 has to be checked to enable this feature. Use the buttons on the right to 
0085 create, modify or delete shortcuts.</para>
0086 
0087 <para>If <guilabel>Use preferred keywords only</guilabel> is checked, only
0088 keywords marked as preferred in the second column of the list
0089 are used in places where only a few select 
0090 shortcuts can be shown at one time.
0091 </para>
0092  
0093 <para>Below the list you find two additional options:</para>
0094 <variablelist>
0095 <varlistentry><term><guilabel>Default Web search keyword:</guilabel></term>
0096 <listitem>
0097 <para>Select the search engine to use for input boxes that provide automatic 
0098 lookup services when you type in normal words and phrases instead of a &URL;. 
0099 To disable this feature select <guilabel>None</guilabel> from the list.
0100 </para></listitem>
0101 </varlistentry>
0102 <varlistentry><term><guilabel>Keyword delimiter:</guilabel></term>
0103 <listitem>
0104 <para>Choose the delimiter that separates the keyword from the phrase or word to 
0105 be searched.</para></listitem>
0106 </varlistentry>
0107 </variablelist>
0108 
0109 <para>If you double-click on a specific entry in the list of defined
0110 search providers or click the <guibutton>Change...</guibutton> button,
0111 the details for that entry are shown in a popup
0112 dialog.  In addition to the descriptive name for the item, you can
0113 also see the &URI; which is used, as well as the
0114 associated shortcuts which you can type anywhere in &kde; where
0115 &URI;s are expected. A given search provider can have
0116 multiple shortcuts, each separated by a comma.</para>
0117 
0118 <para> The text boxes are used not only for displaying information
0119 about an item in the list of web shortcuts, but also for modifying or
0120 adding new items.</para>
0121 
0122 <para>You can change the contents of either the <guilabel>Shortcut 
0123 URL:</guilabel> or the <guilabel>Shortcuts:</guilabel> text box.
0124 Click <guibutton>OK</guibutton> to save your changes or
0125 <guibutton>Cancel</guibutton> to exit the dialog with no
0126 changes.</para>
0127 
0128 <para>If you examine the contents of the <guilabel>Shortcut
0129 URL:</guilabel> text box, you will find that most, if not all of the
0130 entries have a <option>\{@}</option> in them. This sequence of four
0131 characters acts as a parameter, which is to say that they are replaced
0132 by whatever you happen to type after the colon character that is
0133 between a shortcut and its parameter. To add this query placeholder 
0134 to a shortcut &URL;, click on the button at the right of the text box.
0135 Let's consider some examples to clarify how to use web shortcuts.</para>
0136 
0137 <para>Suppose that the &URI; is
0138 <userinput>https://www.google.com/search?q=\{@}</userinput>, and
0139 <userinput>gg</userinput> is a shortcut to this
0140 &URI;. Then, typing
0141 <userinput>gg:<replaceable>alpha</replaceable></userinput> is
0142 equivalent to
0143 <userinput>https://www.google.com/search?q=<replaceable>alpha</replaceable></userinput>.
0144 You could type anything after the <userinput>:</userinput> character;
0145 whatever you have typed simply replaces the <option>\{@}</option>
0146 characters, after being converted to the appropriate character set for
0147 the search provider and then properly
0148 &URL;-encoded. Only the <option>\{@}</option> part of
0149 the search &URI; is touched, the rest of it is
0150 supposed to be properly &URL;-encoded already and is
0151 left as is.</para>
0152 
0153 <para>You can also have shortcuts without parameters. Suppose the
0154 &URI; was
0155 <emphasis>file:/home/me/mydocs/calligra/words</emphasis> and the
0156 shortcut was <emphasis>mywords</emphasis>. Then, typing
0157 <userinput>mywords:</userinput> is the same as typing the complete
0158 &URI;. Note that there is nothing after the colon
0159 when typing the shortcut, but the colon is still required in order for
0160 the shortcut to be recognized as such.</para>
0161 
0162 <para>By now, you will have understood that even though these shortcuts
0163 are called web shortcuts, they really are shortcuts to parameterized
0164 &URI;s, which can point not only to web sites like
0165 search engines but also to anything else that can be pointed to by a
0166 &URI;. Web shortcuts are a very powerful feature of
0167 navigation in &kde;.</para>
0168 
0169 </sect2>
0170 
0171 </sect1>
0172 
0173 </article>