runtime/doc/userguide/getting-help.docbook

   1 <sect1 id="getting-help">
   2
   3 <sect1info>
   4 <authorgroup>
   5 <author>&Lauri.Watts;
   6 </author>
   7 </authorgroup>
   8 </sect1info>
   9
  10
  11 <title>Getting Help</title>
  12
  13 <sect2 id="user-manuals">
  14 <title>User Manuals</title>
  15
  16 <indexterm><primary>User Manual</primary></indexterm>
  17 <para>Most applications come with a comprehensive user manual<indexterm><primary>User Manual</primary><secondary>Handbook</secondary></indexterm>, which you can
  18 reach various ways:</para>
  19
  20 <itemizedlist>
  21 <listitem>
  22 <para>By pressing <keycap>F1</keycap> inside the application.</para>
  23 </listitem>
  24 <listitem>
  25 <para>From the menu bar:
  26 <menuchoice><guimenu>Help</guimenu><guimenuitem><replaceable>Application name
  27 </replaceable></guimenuitem></menuchoice></para>
  28 </listitem>
  29 <listitem>
  30 <para>By browsing to it in &khelpcenter;<indexterm><primary>&khelpcenter;</primary></indexterm></para>
  31 </listitem>
  32 <listitem>
  33 <para>By using the help KIOslave in &konqueror;. So, in the Location Toolbar, simply type <userinput>help:/<replaceable>Application name</replaceable></userinput>
  34 </para>
  35 </listitem>
  36 <listitem>
  37 <para>Online at <ulink
  38 url="http://docs.kde.org">http://docs.kde.org</ulink></para>
  39 </listitem>
  40 </itemizedlist>
  41
  42 </sect2>
  43
  44 <sect2 id="context-help">
  45 <title>Context and <quote>What's This</quote> Help</title>
  46
  47 <para>Many applications also provide context help in two forms:
  48 Tooltips, and <quote>What's This</quote> help.</para>
  49
  50 <sect3 id="tooltips">
  51 <title>Tooltips</title>
  52
  53 <indexterm><primary>Tooltips</primary></indexterm>
  54 <para>Tooltips are small informational windows or balloons that display when
  55 you hover the mouse over an item on your screen without clicking.</para>
  56
  57 <para>&kde; uses tooltips in many places to provide brief help or
  58 information about an item on your screen.  For instance, most toolbar buttons
  59 inside applications will display their name in a tooltip if you rest or hover
  60 your mouse over them.</para>
  61
  62 <para>Tooltips have another function, which is not specifically tied to
  63 help.  In the &konqueror; file manager and on your Desktop, tooltips can
  64 provide information about files.  This is commonly referred to as <quote>meta information</quote>.</para>
  65
  66 <para>You can find out more about meta-information tooltips in the section
  67 about <link linkend="file-manager">the &konqueror; file manager</link>.</para>
  68
  69 </sect3>
  70
  71 <sect3 id="whats-this-help">
  72 <title><quote>What's This?</quote></title>
  73
  74 <indexterm><primary>What's This?</primary></indexterm>
  75
  76 <para><quote>What's This?</quote> help is usually more detailed than tooltips.
  77 You can access <quote>What's This?</quote> help in two ways:</para>
  78
  79 <itemizedlist>
  80 <listitem>
  81 <para>By pressing the <guibutton>?</guibutton> button in the titlebar of the
  82 window.</para>
  83 </listitem>
  84 <listitem>
  85 <para>By pressing the key combination
  86 <keycombo>&Shift;<keycap>F1</keycap></keycombo></para>
  87 </listitem>
  88 </itemizedlist>
  89
  90 <para>The cursor will change to a pointer with a question mark next to it.
  91 Click on the item you want to know about, and a small window will
  92 pop up displaying information.</para>
  93
  94 </sect3>
  95 </sect2>
  96
  97 <sect2 id="mailing-lists-newsgroups-and-irc">
  98 <title>Mailing Lists, Newsgroups and <acronym>IRC</acronym></title>
  99
 100 <sect3 id="mailing-lists">
 101 <title>Mailing Lists</title>
 102
 103 <indexterm><primary>Mailing Lists</primary></indexterm>
 104 <para>&kde; provides many mailing lists which can provide you with help
 105 and guidance in using and configuring your Desktop.</para>
 106
 107 <para>Some of the lists you might find useful are:</para>
 108
 109 <variablelist>
 110 <varlistentry>
 111 <term>The &kde; User List
 112 <indexterm><primary>&kde; User Mailing List</primary></indexterm></term>
 113 <listitem>
 114 <para>This mailing list focuses specifically on <acronym>OS</acronym>-independent questions
 115 and discussions regarding using &kde;. Operating-system-specific questions and
 116 discussion are off-topic here. For
 117 example, the question <quote>How do I change the margin size for KWord
 118 documents</quote> is appropriate for this list; whereas <quote>How do I set
 119 up my printer using &kde; under UnixOS X.Y</quote> is not. Questions asked and
 120 discussions here should apply to all &kde; users using the applicable &kde;
 121 software, not just those using the same operating system.</para>
 122 <para>You can subscribe to this list at <ulink
 123 url="https://mail.kde.org/mailman/listinfo/kde">https://mail.kde.org/mailman/listinfo/kde</ulink>.</para>
 124 <para>You can find archives at <ulink
 125 url="http://lists.kde.org/?l=kde">http://lists.kde.org/?l=kde</ulink>.</para>
 126 </listitem>
 127 </varlistentry>
 128
 129 <varlistentry>
 130 <term>The &kde;-&Linux; List
 131 <indexterm><primary>kde-linux Mailing List</primary></indexterm></term>
 132 <listitem>
 133 <para>This mailing list focusses specifically on questions and discussions
 134 regarding using &kde; on &Linux;. Questions and discussions can involve any
 135 issue confronting desktop users who run &kde; on a &Linux; system. Hence,
 136 questions such as <quote>How do I setup a networked printer for printing from
 137 &kde; on LinuxDistro X.Y</quote> are appropriate here. If you prefer a list
 138 limited to <acronym>OS</acronym>-independent questions and discussions
 139 concerning &kde;, please use the general &kde; mailing list.</para>
 140 <para>You can subscribe to this list at <ulink
 141 url="https://mail.kde.org/mailman/listinfo/kde-linux">https://mail.kde.org/mailman/listinfo/kde-linux</ulink>.</para>
 142 <para>You can find archives at <ulink
 143 url="http://lists.kde.org/?l=kde-linux">http://lists.kde.org/?l=kde-linux</ulink>.</para>
 144 </listitem>
 145 </varlistentry>
 146 </variablelist>
 147 </sect3>
 148
 149 <sect3>
 150 <title>IRC</title>
 151
 152 <para>There is a #kde channel on Freenode (irc.freenode.net) for support and other general talk about &kde;. As usual, you can access this channel by using any of &kde;'s popular IRC clients which include <application>konversation</application>, &ksirc;, as well as &kopete;. For more information, check the <xref linkend="irc"/> section.</para>
 153
 154 </sect3>
 155 </sect2>
 156
 157
 158 <sect2 id="more-resources">
 159 <title>More Resources</title>
 160
 161 <para>There are many other resources which you may found useful; some of these are listed below:</para>
 162
 163 <variablelist>
 164 <varlistentry>
 165 <term>dot.kde.org
 166 <indexterm><primary>&kde; News Resource</primary></indexterm></term>
 167 <listitem>
 168 <para>This website has a searchable &kde; news resource where you can find out about a superfluity of innovations in the world of &kde;.</para>
 169 </listitem>
 170 </varlistentry>
 171 </variablelist>
 172
 173 <variablelist>
 174 <varlistentry>
 175 <term>kde-look.org
 176 <indexterm><primary>icandy for &kde;</primary></indexterm></term>
 177 <listitem>
 178 <para>The paramount resource for &kde; icandy, including themes, window decorations, wallpapers, mouse themes and icons for your &kde; desktop. Note also that the site contains a howto section on how to install the most common of these.</para>
 179 </listitem>
 180 </varlistentry>
 181 </variablelist>
 182
 183 <variablelist>
 184 <varlistentry>
 185 <term>wiki.kde.org
 186 <indexterm><primary>&kde; wiki</primary></indexterm></term>
 187 <listitem>
 188 <para>The official &kde; Wiki. From here you can have access to a plethora of information ranging from frequently asked questions and HOWTOs to tips and tricks. The wiki should never, however, be used as a substitute for the respective application's handbook or the official &kde; documentation.</para>
 189 </listitem>
 190 </varlistentry>
 191 </variablelist>
 192
 193 </sect2>
 194
 195 </sect1>
 196
 197 <!-- Keep this comment at the end of the file
 198 Local variables:
 199 mode: xml
 200 sgml-omittag:nil
 201 sgml-shorttag:nil
 202 sgml-namecase-general:nil
 203 sgml-general-insert-case:lower
 204 sgml-minimize-attributes:nil
 205 sgml-always-quote-attributes:t
 206 sgml-indent-step:0
 207 sgml-indent-data:true
 208 sgml-parent-document:("index.docbook" "book" "sect1")
 209 sgml-exposed-tags:nil
 210 sgml-local-catalogs:nil
 211 sgml-local-ecat-files:nil
 212 End:
 213 -->