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 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  28 </authorgroup>
  29
  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 &Microsoft; &Windows; (Samba) network drives and
  81 SSH.
  82
  83 <screenshot>
  84 <screeninfo>Here's a screenshot of &knetattach;</screeninfo>
  85 <mediaobject>
  86 <imageobject>
  87 <imagedata fileref="screenshot.png" format="PNG"/>
  88 </imageobject>
  89 <textobject>
  90 <phrase>Screenshot</phrase>
  91 </textobject>
  92 <caption>
  93 <para>Network Folder Wizard main window</para>
  94 </caption>
  95 </mediaobject>
  96 </screenshot>
  97 </para>
  98
  99
 100 <sect1 id="knetattach-features">
 101 <title>Adding network folders</title>
 102
 103 <para>
 104 Network folders show up in a special location of &konqueror; called a
 105 <emphasis>virtual folder</emphasis>.
 106 This virtual folder is accessed by typing <userinput>remote:/</userinput> in
 107 &konqueror; <interface>Location bar</interface>. You will then be able to see
 108 any folders which have been previously added and you also will be able to use
 109 the wizard to add new ones.
 110 <screenshot>
 111 <screeninfo>Here's a screenshot of &knetattach;</screeninfo>
 112 <mediaobject>
 113 <imageobject>
 114 <imagedata fileref="screenshot1.png" format="PNG"/>
 115 </imageobject>
 116 <textobject>
 117 <phrase>Screenshot</phrase>
 118 </textobject>
 119 <caption>
 120 <para>The virtual folder with the Network Folder wizard</para>
 121 </caption>
 122 </mediaobject>
 123 </screenshot>
 124 </para>
 125
 126 <para>
 127 Speaking of wizards, the Network Folder Wizard aims at being very easy to use.
 128 After opening the wizard you must choose the type of network folder you would
 129 like to access. When you move on to the next screen you will just need to
 130 fill in the requested information. The final step is entering your username and
 131 login password for the network share you've chosen to access.
 132 </para>
 133 <para>
 134 Below is a list of the information needed by the wizard to create the network
 135 folders. If an option is not
 136 available for a particular folder it does not have to be entered. &eg;. The Samba
 137 folders do not require a <guilabel>Port</guilabel> entry.
 138 </para>
 139
 140 <para>
 141 <variablelist>
 142 <varlistentry>
 143 <term><guilabel>Name:</guilabel></term>
 144 <listitem>
 145 <para>
 146 This is where you give a name to the network connection. It is limited only by
 147 your imagination (or alphabet).
 148 </para>
 149 </listitem>
 150 </varlistentry>
 151 <varlistentry>
 152 <term>Server:</term>
 153 <listitem>
 154 <para>
 155 This is the address of the server you are attempting to add. It can be an
 156 IP address or domain name.
 157 </para>
 158 </listitem>
 159 </varlistentry>
 160 <varlistentry>
 161 <term><guilabel>Port:</guilabel></term>
 162 <listitem>
 163 <para>
 164 Here you enter the port number you wish to connect to. The defaults are usually
 165 sufficient.
 166 <note>
 167 <para>
 168 Not available for &Microsoft; &Windows; (Samba) folders.
 169 </para>
 170 </note>
 171 </para>
 172 </listitem>
 173 </varlistentry>
 174 <varlistentry>
 175 <term><guilabel>Folder:</guilabel></term>
 176 <listitem>
 177 <para>
 178 The path to the folder you wish to connect to should go here.
 179 </para>
 180 </listitem>
 181 </varlistentry>
 182 <varlistentry>
 183 <term><guilabel>Create an icon for this remote folder</guilabel></term>
 184 <listitem>
 185 <para>
 186 If this box is checked an icon will be created allowing access through the
 187 remote:/ virtual folder. If it is not checked, a connection will be possible
 188 but it will not be accessible from remote:/.
 189 <note>
 190 <para>
 191 The <guilabel>Recent connection:</guilabel> option allows you to re-connect to
 192 the
 193 last network mount point you connected to using the wizard whether an icon is
 194 created or not.
 195 </para>
 196 </note>
 197 </para>
 198 </listitem>
 199 </varlistentry>
 200 <varlistentry>
 201 <term><guilabel>Use encryption</guilabel></term>
 202 <listitem>
 203 <para>
 204 If checked the ability to make a secure connection will be enabled.
 205 <note>
 206 <para>Available only for WebDav folders.</para>
 207 </note>
 208 </para>
 209 </listitem>
 210 </varlistentry>
 211 </variablelist>
 212 </para>
 213
 214 </sect1>
 215 </chapter>
 216
 217 <chapter id="knetattach-walkthrough">
 218 <title>&knetattach; Walkthrough</title>
 219
 220
 221 <para>
 222 This will be a quick walkthrough of the Network Folder Wizard. Don't
 223 blink or you might miss it.
 224 </para>
 225
 226 <para>
 227 Below you see the main window of the Network Folder Wizard. It is here
 228 that we choose what type of folder we want to add or connect to. For
 229 the purposes of this walkthrough we will be using &FTP;. It contains most
 230 of the options you will encounter while using the wizard.
 231 </para>
 232
 233 <para>
 234 <screenshot>
 235 <screeninfo>Here's a screenshot of the &knetattach; main window</screeninfo>
 236 <mediaobject>
 237 <imageobject>
 238 <imagedata fileref="screenshot.png" format="PNG"/>
 239 </imageobject>
 240 <textobject>
 241 <phrase>Screenshot</phrase>
 242 </textobject>
 243 </mediaobject>
 244 </screenshot>
 245 </para>
 246
 247 <para>
 248 OK, so we (as in me) have chosen to add an &FTP; folder. Below you see
 249 an example of the type of information you will need to add for your particular
 250 &FTP; server. After filling it in we press <guibutton>Save &amp;
 251 Connect</guibutton>
 252 and wait for the magic. Oh yes, if your server requires validation of some kind
 253 you will be prompted at this point before being allowed to connect.
 254 </para>
 255
 256 <para>
 257 <screenshot>
 258 <screeninfo>Screenshot showing addition of &FTP; Folder
 259 using &knetattach;</screeninfo>
 260 <mediaobject>
 261 <imageobject>
 262 <imagedata fileref="screenshot2.png" format="PNG"/>
 263 </imageobject>
 264 <textobject>
 265 <phrase>Screenshot</phrase>
 266 </textobject>
 267 </mediaobject>
 268 </screenshot>
 269 </para>
 270
 271 <para>
 272 So now we are all connected now and able to navigate our newly added share. Joy!
 273 </para>
 274
 275 <para>
 276 <screenshot>
 277 <screeninfo>Screenshot of the connected &FTP; folder</screeninfo>
 278 <mediaobject>
 279 <imageobject>
 280 <imagedata fileref="screenshot3.png" format="PNG"/>
 281 </imageobject>
 282 <textobject>
 283 <phrase>Screenshot</phrase>
 284 </textobject>
 285 </mediaobject>
 286 </screenshot>
 287 </para>
 288
 289 <para>
 290 To get back to our network folders all that is necessary is typing
 291 <action>remote:/</action>
 292 in the <guilabel>Location:</guilabel> bar of &konqueror;.
 293 </para>
 294
 295 <para>
 296 <screenshot>
 297 <screeninfo>Screenshot of the remote:/ virtual folder with the
 298 added connection</screeninfo>
 299 <mediaobject>
 300 <imageobject>
 301 <imagedata fileref="screenshot4.png" format="PNG"/>
 302 </imageobject>
 303 <textobject>
 304 <phrase>Screenshot</phrase>
 305 </textobject>
 306 </mediaobject>
 307 </screenshot>
 308 </para>
 309
 310 <para>
 311 You can even add new folders from the same location by using the
 312 <guilabel>Add a Network Folder</guilabel> link. Well that brings us to
 313 the end of our walkthrough (told you it would be quick). I wish you the
 314 best of luck in your own network folder adventures ;-)
 315 </para>
 316 </chapter>
 317
 318 <chapter id="credits">
 319
 320 <title>Credits and License</title>
 321
 322 <para>
 323 &knetattach;
 324 </para>
 325 <para>
 326 Program copyright 2004 &George.Staikos; &George.Staikos.mail;
 327 </para>
 328
 329 <para>
 330 Documentation Copyright &copy; 2005 &Orville.Bennett; &Orville.Bennett.mail;
 331 </para>
 332
 333 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 334
 335 &underFDL;               <!-- FDL: do not remove -->
 336 &underGPL;
 337
 338 </chapter>
 339
 340 &documentation.index;
 341 </book>
 342
 343 <!--
 344 Local Variables:
 345 mode: xml
 346 sgml-minimize-attributes:nil
 347 sgml-general-insert-case:lower
 348 sgml-indent-step:0
 349 sgml-indent-data:nil
 350 End:
 351
 352 vim:tabstop=2:shiftwidth=2:expandtab
 353 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
 354 -->