~ubuntu-branches/ubuntu/vivid/krusader/vivid-proposed

« back to all changes in this revision

Viewing changes to doc/bookmarks.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2010-05-05 22:26:37 UTC
  • mfrom: (3.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505222637-ydv3cwjwy365on2r
Tags: 1:2.1.0~beta1-1ubuntu1
* Merge from Debian Unstable.  Remaining changes:
  - Retain Kubuntu doc path

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<sect1 id="bookman">
 
2
  <title>BookMan: Organize your Bookmarks</title>
 
3
  <indexterm>
 
4
    <primary>Bookmarks</primary>
 
5
  </indexterm>
 
6
  <para>BookMan is &krusader;'s Bookmark tool for
 
7
  bookmarking folders, local- and 
 
8
  <link linkend="remote-connections">remote URL's</link>, and later
 
9
  returning to them in a click of a button. The Bookman menu is
 
10
  divided into four sections: 
 
11
  <itemizedlist>
 
12
    <listitem>
 
13
      <para>Your personal bookmarks</para>
 
14
    </listitem>
 
15
    <listitem>
 
16
      <para>Popular &URL;'s</para>
 
17
    </listitem>
 
18
    <listitem>
 
19
      <para>Permanent bookmarks</para>
 
20
    </listitem>
 
21
    <listitem>
 
22
      <para>Manage bookmarks</para>
 
23
    </listitem>
 
24
  </itemizedlist></para>
 
25
  <note>
 
26
    <para>You can bookmark inside a remote file system
 
27
    (&FTP; or SAMBA) and later use the bookmark to
 
28
    quickly connect to the remote machine, but you cannot bookmark
 
29
    inside an archive.</para>
 
30
  </note>
 
31
  <!-- OLD
 
32
<screenshot>
 
33
  <screeninfo>Bookmark menu</screeninfo>
 
34
  <mediaobject>
 
35
  <imageobject><imagedata fileref="bookmanadd.png" format="PNG"/></imageobject>
 
36
  <imageobject><imagedata fileref="bookmanadd.png" format="EPS"/></imageobject>
 
37
  <textobject><phrase>BookMan: the Bookmark menu</phrase></textobject>
 
38
  <caption><para>Bookmark menu</para></caption>
 
39
  </mediaobject>
 
40
</screenshot>
 
41
-->
 
42
  <figure id="screenshot-bookmanadd" float="1">
 
43
    <title>Bookmark menu</title>
 
44
    <mediaobject>
 
45
      <imageobject>
 
46
        <imagedata fileref="bookmanadd.png"></imagedata>
 
47
      </imageobject>
 
48
      <textobject>
 
49
        <phrase>Bookmark menu</phrase>
 
50
      </textobject>
 
51
    </mediaobject>
 
52
  </figure>
 
53
  <sect2 id="using_bookmarks">
 
54
    <title>Using Bookmarks</title>
 
55
    <para>Usually, you click on the 
 
56
    <guibutton>Bookmark</guibutton> button when you are in the target
 
57
    folder. For example, to bookmark 
 
58
    <filename class="directory">/usr/tmp</filename>, navigate
 
59
    &krusader; there and click the 
 
60
    <guibutton>Bookmark</guibutton> button and select 
 
61
    <guimenuitem>Bookmark Current</guimenuitem>. When the 
 
62
    <guilabel>Bookmark Current</guilabel> dialog box appears, the
 
63
    &URL; line will say 
 
64
    <filename class="directory">/usr/tmp</filename>. 
 
65
    <guilabel>Name</guilabel> is for the name you would like to give
 
66
    to the bookmark (e.g.: temporary folder). Hotkeys are supported
 
67
    by adding 
 
68
    <literal>&amp;</literal> to the bookmark name
 
69
    e.g. 
 
70
    <literal>&amp;sourceforge, &amp;home,
 
71
    down&amp;loads</literal> &etc;, so you can
 
72
    quickly call the bookmark name with 
 
73
    <keycombo action="simul">&Alt;
 
74
    <keycap>foo</keycap></keycombo>. If you add the bookmark
 
75
    without entering a name, the bookmarks name will be the same as
 
76
    its target. 
 
77
    <guilabel>URL</guilabel>
 
78
    <!-- Openjade does not like an acronym element for "URL" here -->
 
79
    is where the bookmark points to. 
 
80
    <guilabel>Create in</guilabel> creates bookmark folders for
 
81
    organizing your bookmarks.</para>
 
82
    <para>To use your bookmarks, click the 
 
83
    <guibutton>Bookmark</guibutton> button and choose a bookmark.
 
84
    You may also use the <link linkend="key_bindings">Key-Bindings</link> : 
 
85
    <keycombo action="simul">&Ctrl;&Shift;
 
86
    <keycap>D</keycap></keycombo> to bookmark the current item, 
 
87
    <keycombo action="simul">&Alt;
 
88
    <keycap>right/left arrow</keycap></keycombo> to 
 
89
    <keycap>open right/left panel bookmarks list</keycap> and 
 
90
    <keycombo action="simul">&Ctrl;
 
91
    <keycap>D</keycap></keycombo> to open the bookmarks of the
 
92
    active panel. A Middle Mouse Button click on bookmarks opens them
 
93
    in a new 
 
94
    <link linkend="folder-tabs">Folder tab</link>.</para>
 
95
    <para>Navigation in bookmarks: 
 
96
    <orderedlist>
 
97
      <listitem>
 
98
        <para>Start typing letters</para>
 
99
      </listitem>
 
100
      <listitem>
 
101
        <para>e.g. when you type 
 
102
        <literal>'h'</literal> and only one bookmark starts with 
 
103
        <literal>'h'</literal>, it is executed immediately - no
 
104
        enter needed</para>
 
105
      </listitem>
 
106
      <listitem>
 
107
        <para>If more than one bookmarks begins with 
 
108
        <literal>'h'</literal>, you will have to continue adding
 
109
        letters, until you have specified enough and again, the
 
110
        bookmark is executed.</para>
 
111
      </listitem>
 
112
    </orderedlist></para>
 
113
  </sect2>
 
114
  <sect2 id="password_handling">
 
115
    <title>Password handling</title>
 
116
    <para>One of the benefits of the 
 
117
    <link linkend="bookman">bookmark manager</link> is that the
 
118
    passwords are saved using &kde;'s services - where
 
119
    e.g. your &konqueror;/&kmail;
 
120
    password are saved. If you have a wallet, &kde; will
 
121
    save the passwords there. By clicking the bookmarks, a dialog
 
122
    will open and ask for your username and password. Supply them
 
123
    and click 'save password'. The passwords and usernames will be
 
124
    saved securely by &kde;'s wallet (make sure it is
 
125
    enabled by your distro). The downside here is that if you
 
126
    reinstall and do not backup your passwords from the wallet as
 
127
    well as &krusader;'s bookmark file, something will
 
128
    be lost.</para>
 
129
  </sect2>
 
130
  <sect2 id="popular-urls">
 
131
    <title>Popular URL's</title>
 
132
    <indexterm>
 
133
      <primary>Popular URL's</primary>
 
134
    </indexterm>
 
135
    <para>The submenu 
 
136
    <guilabel>Popular URL's</guilabel>
 
137
    <!-- Openjade does not like an acronym element for "URL" here -->
 
138
    holds persistent the most popular visited &URL;'s
 
139
    (local or remote). This submenu displays the top 15 popular
 
140
    URLs, sorted by ranking, so that the top &URL; is
 
141
    the most popular. This is easy for when you need to visit
 
142
    &URL;s often, but do not want to create
 
143
    <link linkend="bookman">Bookmarks</link>, it serves as a temporary bookmark
 
144
    list for the most visited links. 
 
145
    <guilabel>Quicksearch Popular URL's</guilabel> is a fast way to
 
146
    browse/select the popular &URL;s: 
 
147
    <itemizedlist>
 
148
      <listitem>
 
149
        <para>Open the 
 
150
        <guilabel>Popular URL's</guilabel>
 
151
        <!-- Openjade does not like an acronym element for "URL" here -->
 
152
        or use 
 
153
        <keycombo action="simul">&Ctrl;
 
154
        <keycap>Z</keycap></keycombo></para>
 
155
      </listitem>
 
156
      <listitem>
 
157
        <para>Type a few letters to narrow the search</para>
 
158
      </listitem>
 
159
      <listitem>
 
160
        <para>Press enter (you will go to the &URL;
 
161
        list)</para>
 
162
      </listitem>
 
163
      <listitem>
 
164
        <para>Press enter again and the panel is refreshed</para>
 
165
      </listitem>
 
166
    </itemizedlist></para>
 
167
  </sect2>
 
168
  <sect2 id="permanent_bookmarks">
 
169
    <title>Permanent bookmarks</title>
 
170
    <para>These are hardcoded bookmarks to the top bookmark menu;
 
171
    there is no need for them to be saved to the file. With the
 
172
    <link linkend="context-menu">Context Menu</link> you can enable/disable these
 
173
    permanent bookmarks. The following permanent bookmarks are
 
174
    available: 
 
175
    <itemizedlist>
 
176
      <listitem>
 
177
        <para>
 
178
        <guilabel>Media</guilabel> uses &kde;'s 
 
179
        <link linkend="konfig-advanced">Media protocol</link> 
 
180
        <filename>media:/</filename></para>
 
181
      </listitem>
 
182
      <listitem>
 
183
        <para>
 
184
        <guilabel>Local Network</guilabel> uses &kde;'s 
 
185
        <filename>lan:/</filename> protocol.</para>
 
186
      </listitem>
 
187
      <listitem>
 
188
        <para>
 
189
        <guilabel>Virtual Filesystem</guilabel> <link linkend="vfs">Virtual file systems (VFS)</link>
 
190
        
 
191
        <filename>virt:/</filename> is not a virtual folder, but a
 
192
        container for &URL;'s from different file
 
193
        systems. It is used for e.g. the 
 
194
        <guilabel>Feed to Listbox</guilabel> feature of the search
 
195
        module and the synchronizer. The location toolbar will
 
196
        display e.g. 
 
197
        <filename>virt:/Search results 1</filename> or 
 
198
        <filename>virt:/Synchronise results 1</filename>.</para>
 
199
      </listitem>
 
200
      <listitem id="jump_back">
 
201
        <para>
 
202
        <guilabel>Jump back</guilabel> or 
 
203
        <keycombo action="simul">&Ctrl;
 
204
        <keycap>J</keycap></keycombo> brings you back to your
 
205
        starting position when you did create a new tab in the
 
206
        panel window. This feature is very handy if you go deep
 
207
        into a directory tree, then you can return with one action
 
208
        to the starting point. With 
 
209
        <guilabel>Set jump back point here</guilabel> or 
 
210
        <keycombo action="simul">
 
211
        &Ctrl;&Shift;
 
212
        <keycap>J</keycap></keycombo> sets the current directory as
 
213
        a jump back point.</para>
 
214
      </listitem>
 
215
    </itemizedlist></para>
 
216
  </sect2>
 
217
  <sect2 id="manage_bookmarks">
 
218
    <title>Manage bookmarks</title>
 
219
    <para>To edit and organize your bookmarks, by clicking the 
 
220
    <guibutton>Bookmark</guibutton> button and selecting the 
 
221
    <guimenuitem>Manage Bookmarks</guimenuitem>,
 
222
    <application>KeditBookmarks</application> will be displayed. This is where
 
223
    you can edit/remove and rearrange the bookmarks.
 
224
    <application>KeditBookmarks</application> (part of the kdebase package) is a
 
225
    bookmark editor for &konqueror;,
 
226
    &krusader; and other applications, which use the
 
227
    <ulink url="http://grail.sourceforge.net/info/xbel.html">XBEL standard</ulink> for the bookmark format. The
 
228
    bookmarks are stored in 
 
229
    <filename>
 
230
    ~/.kde/share/apps/krusader/krbookmarks.xml</filename>.</para>
 
231
    <para>You can import bookmarks from 
 
232
    <application>IE</application>, 
 
233
    <application>Opera</application>, 
 
234
    <application>Galeon</application>, &kde;, 
 
235
    <application>Mozilla</application>, &Netscape;.
 
236
    <application>KeditBookmarks</application> is easy to use, however, if you
 
237
    need more information, please read the
 
238
    <application>KeditBookmarks</application> or the &konqueror;
 
239
    handbook.</para>
 
240
    <!-- OLD
 
241
<screenshot>
 
242
  <screeninfo><application>KeditBookmarks</application> Bookmark Manager</screeninfo>
 
243
  <mediaobject>
 
244
  <imageobject><imagedata fileref="bookmanedit.png" format="PNG"/></imageobject>
 
245
  <imageobject><imagedata fileref="bookmanedit.png" format="EPS"/></imageobject>
 
246
  <textobject><phrase><application>KeditBookmarks</application> edit and organize your Bookmarks</phrase></textobject>
 
247
  <caption><para><application>KeditBookmarks</application>: Bookmark Manager.</para></caption>
 
248
  </mediaobject>
 
249
</screenshot>
 
250
-->
 
251
    <figure id="screenshot-bookmanedit" float="1">
 
252
      <title><application>KeditBookmarks</application> Bookmark Manager</title>
 
253
      <mediaobject>
 
254
        <imageobject>
 
255
          <imagedata fileref="bookmanedit.png"></imagedata>
 
256
        </imageobject>
 
257
        <textobject>
 
258
          <phrase><application>KeditBookmarks</application> Bookmark
 
259
          Manager</phrase>
 
260
        </textobject>
 
261
      </mediaobject>
 
262
    </figure>
 
263
  </sect2>
 
264
  <sect2 id="bookmark_buttons">
 
265
    <title>Bookmarks as action buttons on the Toolbar</title>
 
266
    <para>Bookmarks can be placed as buttons on the
 
267
    <link linkend="mainwindow">Main Toolbar</link> or the
 
268
    <link linkend="actions_toolbar">Actions Toolbar</link>. You can even make a
 
269
    key-binding for them: 
 
270
    <itemizedlist>
 
271
      <listitem>
 
272
        <para>Create your <link linkend="bookman">Bookmarks</link>.</para>
 
273
      </listitem>
 
274
      <listitem>
 
275
        <para>If you want, create keybindings for the bookmarks in
 
276
        the 
 
277
        <guilabel>Key-bindings</guilabel> section of the
 
278
        <link linkend="konfig-looknfeel">Konfigurator Look &amp; Feel page</link>.</para>
 
279
      </listitem>
 
280
      <listitem>
 
281
        <para>Add your bookmarks as action buttons on the
 
282
        <link linkend="mainwindow">Main Toolbar</link> or the
 
283
        <link linkend="actions_toolbar">Actions Toolbar</link> with the 
 
284
        <guilabel>Toolbar</guilabel> section of the
 
285
        <link linkend="konfig-looknfeel">Konfigurator Look &amp; Feel page</link>.</para>
 
286
      </listitem>
 
287
    </itemizedlist></para>
 
288
  </sect2>
 
289
</sect1>