runtime/doc/knetattach/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4   <!-- Define an entity for your application if it is not part of KDE
   5        CVS -->
   6   <!ENTITY kappname "&knetattach;">
   7   <!ENTITY package "kdebase"><!-- I think this came from kdebase... -->
   8   <!ENTITY % addindex "IGNORE">
   9   <!ENTITY % English "INCLUDE">
  10
  11   <!-- Do not define any other entities; instead, use the entities
  12        from entities/general.entities and $LANG/user.entities. -->
  13 ]>
  14
  15 <book lang="&language;">
  16
  17 <!-- This header contains all of the meta-information for the document such
  18 as Authors, publish date, the abstract, and Keywords -->
  19
  20 <bookinfo>
  21 <title>The &knetattach; Handbook</title>
  22
  23 <authorgroup>
  24 <author>
  25 &Orville.Bennett; &Orville.Bennett.mail;
  26 </author>
  27 </authorgroup>
  28
  29 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  30
  31 <copyright>
  32 <year>2005</year>
  33 <holder>&Orville.Bennett;</holder>
  34 </copyright>
  35 <legalnotice>&FDLNotice;</legalnotice>
  36
  37 <date>2005-02-09</date>
  38 <releaseinfo>1.01.00</releaseinfo>
  39
  40 <abstract>
  41 <para>
  42 &knetattach; is an application which makes it easier to integrate your
  43 network resources with your &kde; Desktop.
  44 </para>
  45 </abstract>
  46
  47 <!-- This is a set of Keywords for indexing by search engines.
  48 Please at least include KDE, the KDE package it is in, the name
  49  of your application, and a few relevant keywords. -->
  50
  51 <keywordset>
  52 <keyword>KDE</keyword>
  53 <keyword>kdebase</keyword>
  54 <keyword>knetattach</keyword>
  55 <keyword>Network Folders</keyword>
  56 <keyword>Network Folder Wizard</keyword>
  57 <keyword>KDE Network Folder Wizard</keyword>
  58 </keywordset>
  59
  60 </bookinfo>
  61
  62 <chapter id="introduction">
  63 <title>Introduction</title>
  64
  65 <para>
  66 The &knetattach; program, affectionately and hereafter known as the
  67 Network Folder Wizard, allows easy addition and integration of various
  68 network folders with your &kde; desktop. Please report any problems or
  69 feature requests for it to the &kde; bugs website.
  70 </para>
  71 </chapter>
  72
  73 <chapter id="using-knetattach">
  74 <title>Using &knetattach;</title>
  75
  76 <para>
  77 As you will see in the screenshot below, the Network Folder Wizard currently
  78 allows
  79 you to add four types of network folders: WebDav, FTP,
  80 <trademark class="registered">Microsoft</trademark>
  81 <trademark class="registered">Windows</trademark> (Samba) network drives and
  82 SSH.
  83
  84 <screenshot>
  85 <screeninfo>Here's a screenshot of &knetattach;</screeninfo>
  86 <mediaobject>
  87 <imageobject>
  88 <imagedata fileref="screenshot.png" format="PNG"/>
  89 </imageobject>
  90 <textobject>
  91 <phrase>Screenshot</phrase>
  92 </textobject>
  93 <caption>
  94 <para>Network Folder Wizard main window</para>
  95 </caption>
  96 </mediaobject>
  97 </screenshot>
  98 </para>
  99
 100
 101 <sect1 id="knetattach-features">
 102 <title>Adding network folders</title>
 103
 104 <para>
 105 Network folders show up in a special location of &konqueror; called a
 106 <emphasis>virtual folder</emphasis>.
 107 This virtual folder is accessed by typing <userinput>remote:/</userinput> in
 108 &konqueror; <interface>Location bar</interface>. You will then be able to see
 109 any folders which have been previously added and you also will be able to use
 110 the wizard to add new ones.
 111 <screenshot>
 112 <screeninfo>Here's a screenshot of &knetattach;</screeninfo>
 113 <mediaobject>
 114 <imageobject>
 115 <imagedata fileref="screenshot1.png" format="PNG"/>
 116 </imageobject>
 117 <textobject>
 118 <phrase>Screenshot</phrase>
 119 </textobject>
 120 <caption>
 121 <para>The virtual folder with the Network Folder wizard</para>
 122 </caption>
 123 </mediaobject>
 124 </screenshot>
 125 </para>
 126
 127 <para>
 128 Speaking of wizards, the Network Folder Wizard aims at being very easy to use.
 129 After opening the wizard you must choose the type of network folder you would
 130 like to access. When you move on to the next screen you will just need to
 131 fill in the requested information. The final step is entering your username and
 132 login password for the network share you've chosen to access.
 133 </para>
 134 <para>
 135 Below is a list of the information needed by the wizard to create the network
 136 folders. If an option is not
 137 available for a particular folder it does not have to be entered. e.g. The Samba
 138 folders do not require a <guilabel>Port</guilabel> entry.
 139 </para>
 140
 141 <para>
 142 <variablelist>
 143 <varlistentry>
 144 <term><guilabel>Name:</guilabel></term>
 145 <listitem>
 146 <para>
 147 This is where you give a name to the network connection. It is limited only by
 148 your imagination (or alphabet).
 149 </para>
 150 </listitem>
 151 </varlistentry>
 152 <varlistentry>
 153 <term>Server:</term>
 154 <listitem>
 155 <para>
 156 This is the address of the server you are attempting to add. It can be an
 157 IP address or domain name.
 158 </para>
 159 </listitem>
 160 </varlistentry>
 161 <varlistentry>
 162 <term><guilabel>Port:</guilabel></term>
 163 <listitem>
 164 <para>
 165 Here you enter the port number you wish to connect to. The defaults are usually
 166 sufficient.
 167 <note>
 168 <para>
 169 Not available for <trademark class="registered">Microsoft</trademark>
 170 <trademark class="registered">Windows</trademark> (Samba) folders.
 171 </para>
 172 </note>
 173 </para>
 174 </listitem>
 175 </varlistentry>
 176 <varlistentry>
 177 <term><guilabel>Folder:</guilabel></term>
 178 <listitem>
 179 <para>
 180 The path to the folder you wish to connect to should go here.
 181 </para>
 182 </listitem>
 183 </varlistentry>
 184 <varlistentry>
 185 <term><guilabel>Create an icon for this remote folder</guilabel></term>
 186 <listitem>
 187 <para>
 188 If this box is checked an icon will be created allowing access through the
 189 remote:/ virtual folder. If it is not checked, a connection will be possible
 190 but it will not be accessible from remote:/.
 191 <note>
 192 <para>
 193 The <guilabel>Recent connection:</guilabel> option allows you to re-connect to
 194 the
 195 last network mount point you connected to using the wizard whether an icon is
 196 created or not.
 197 </para>
 198 </note>
 199 </para>
 200 </listitem>
 201 </varlistentry>
 202 <varlistentry>
 203 <term><guilabel>Use encryption</guilabel></term>
 204 <listitem>
 205 <para>
 206 If checked the ability to make a secure connection will be enabled.
 207 <note>
 208 <para>Available only for WebDav folders.</para>
 209 </note>
 210 </para>
 211 </listitem>
 212 </varlistentry>
 213 </variablelist>
 214 </para>
 215
 216 </sect1>
 217 </chapter>
 218
 219 <chapter id="knetattach-walkthrough">
 220 <title>&knetattach; Walkthrough</title>
 221
 222
 223 <para>
 224 This will be a quick walkthrough of the Network Folder Wizard. Don't
 225 blink or you might miss it.
 226 </para>
 227
 228 <para>
 229 Below you see the main window of the Network Folder Wizard. It is here
 230 that we choose what type of folder we want to add or connect to. For
 231 the purposes of this walkthrough we will be using FTP. It contains most
 232 of the options you will encounter while using the wizard.
 233 </para>
 234
 235 <para>
 236 <screenshot>
 237 <screeninfo>Here's a screenshot of the &knetattach; main window</screeninfo>
 238 <mediaobject>
 239 <imageobject>
 240 <imagedata fileref="screenshot.png" format="PNG"/>
 241 </imageobject>
 242 <textobject>
 243 <phrase>Screenshot</phrase>
 244 </textobject>
 245 </mediaobject>
 246 </screenshot>
 247 </para>
 248
 249 <para>
 250 OK, so we (as in me) have chosen to add an FTP folder. Below you see
 251 an example of the type of information you will need to add for your particular
 252 FTP server. After filling it in we press <guibutton>Save &amp;
 253 Connect</guibutton>
 254 and wait for the magic. Oh yes, if your server requires validation of some kind
 255 you will be prompted at this point before being allowed to connect.
 256 </para>
 257
 258 <para>
 259 <screenshot>
 260 <screeninfo>Screenshot showing addition of FTP Folder
 261 using &knetattach;</screeninfo>
 262 <mediaobject>
 263 <imageobject>
 264 <imagedata fileref="screenshot2.png" format="PNG"/>
 265 </imageobject>
 266 <textobject>
 267 <phrase>Screenshot</phrase>
 268 </textobject>
 269 </mediaobject>
 270 </screenshot>
 271 </para>
 272
 273 <para>
 274 So now we are all connected now and able to navigate our newly added share. Joy!
 275 </para>
 276
 277 <para>
 278 <screenshot>
 279 <screeninfo>Screenshot of the connected FTP folder</screeninfo>
 280 <mediaobject>
 281 <imageobject>
 282 <imagedata fileref="screenshot3.png" format="PNG"/>
 283 </imageobject>
 284 <textobject>
 285 <phrase>Screenshot</phrase>
 286 </textobject>
 287 </mediaobject>
 288 </screenshot>
 289 </para>
 290
 291 <para>
 292 To get back to our network folders all that is necessary is typing
 293 <action>remote:/</action>
 294 in the <guilabel>Location:</guilabel> bar of &konqueror;.
 295 </para>
 296
 297 <para>
 298 <screenshot>
 299 <screeninfo>Screenshot of the remote:/ virtual folder with the
 300 added connection</screeninfo>
 301 <mediaobject>
 302 <imageobject>
 303 <imagedata fileref="screenshot4.png" format="PNG"/>
 304 </imageobject>
 305 <textobject>
 306 <phrase>Screenshot</phrase>
 307 </textobject>
 308 </mediaobject>
 309 </screenshot>
 310 </para>
 311
 312 <para>
 313 You can even add new folders from the same location by using the
 314 <guilabel>Add a Network Folder</guilabel> link. Well that brings us to
 315 the end of our walkthrough (told you it would be quick). I wish you the
 316 best of luck in your own network folder adventures ;-)
 317 </para>
 318 </chapter>
 319
 320 <chapter id="credits">
 321
 322 <title>Credits and License</title>
 323
 324 <para>
 325 &knetattach;
 326 </para>
 327 <para>
 328 Program copyright 2004 &George.Staikos; &George.Staikos.mail;
 329 </para>
 330
 331 <para>
 332 Documentation Copyright &copy; 2005 &Orville.Bennett; &Orville.Bennett.mail;
 333 </para>
 334
 335 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 336
 337 &underFDL;               <!-- FDL: do not remove -->
 338 &underGPL;
 339
 340 </chapter>
 341
 342 &documentation.index;
 343 </book>
 344
 345 <!--
 346 Local Variables:
 347 mode: xml
 348 sgml-minimize-attributes:nil
 349 sgml-general-insert-case:lower
 350 sgml-indent-step:0
 351 sgml-indent-data:nil
 352 End:
 353
 354 vim:tabstop=2:shiftwidth=2:expandtab
 355 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
 356 -->