Warning, /utilities/krusader/doc/handbook/bookmarks.docbook is written in an unsupported language. File is not indexed.

0001 <!--
0002     SPDX-FileCopyrightText: 2000-2003 Shie Erlich <erlich@users.sourceforge.net>
0003     SPDX-FileCopyrightText: 2000-2003 Rafi Yanai <yanai@users.sourceforge.net>
0004     SPDX-FileCopyrightText: 2004-2010 Frank Schoolmeesters <codeknight@users.sourceforge.net>
0005     SPDX-FileCopyrightText: 2000-2022 Krusader Krew <https://krusader.org>
0006 -->
0007 <sect1 id="bookman">
0008   <title>BookMan: Organize your Bookmarks</title>
0009   <indexterm>
0010     <primary>Bookmarks</primary>
0011   </indexterm>
0012   <para>BookMan is &krusader;'s Bookmark tool for
0013   bookmarking folders, local and 
0014   <link linkend="remote-connections">remote &URL;s</link>, and later
0015   returning to them in a click of a button. The Bookman menu is
0016   divided into four sections: 
0017   <itemizedlist>
0018     <listitem>
0019       <para>Your personal bookmarks</para>
0020     </listitem>
0021     <listitem>
0022       <para>Popular &URL;s</para>
0023     </listitem>
0024     <listitem>
0025       <para>Permanent bookmarks</para>
0026     </listitem>
0027     <listitem>
0028       <para>Manage bookmarks</para>
0029     </listitem>
0030   </itemizedlist></para>
0031   <note>
0032     <para>You can bookmark inside a remote file system
0033     (&FTP; or SAMBA) and later use the bookmark to
0034     quickly connect to the remote machine, but you cannot bookmark
0035     inside an archive.</para>
0036   </note>
0037   <figure id="screenshot-bookmanadd" float="1">
0038     <title>Bookmark menu</title>
0039     <mediaobject>
0040       <imageobject>
0041         <imagedata fileref="bookmanadd.png"></imagedata>
0042       </imageobject>
0043       <textobject>
0044         <phrase>Bookmark menu</phrase>
0045       </textobject>
0046     </mediaobject>
0047   </figure>
0048   <sect2 id="using_bookmarks">
0049     <title>Using Bookmarks</title>
0050     <para>Usually, you click on the 
0051     <guibutton>BookMan II</guibutton> button (the rightmost button to the right of
0052     the address bar at the top of the active panel) when you are in the target
0053     folder. For example, to bookmark 
0054     <filename class="directory">/usr/tmp</filename>, navigate
0055     &krusader; there and click the 
0056     <guibutton>BookMan II</guibutton> button and select 
0057     <guimenuitem>Bookmark Current</guimenuitem>. When the 
0058     <guilabel>Add Bookmark</guilabel> dialog box appears, the
0059     &URL; line will say 
0060     <filename class="directory">/usr/tmp</filename>. 
0061     <guilabel>Name</guilabel> is for the name you would like to give
0062     to the bookmark (&eg;: temporary folder). Hotkeys are supported
0063     by adding 
0064     <literal>&amp;</literal> to the bookmark name
0065     &eg;
0066     <literal>&amp;sourceforge, &amp;home,
0067     down&amp;loads</literal> &etc;, so you can
0068     quickly call the bookmark name with 
0069     <keycombo action="simul">&Alt;
0070     <keycap>foo</keycap></keycombo>. If you add the bookmark
0071     without entering a name, the bookmarks name will be the same as
0072     its target. 
0073     <guilabel>&URL;</guilabel>
0074     is where the bookmark points to. 
0075     <guilabel>Create in</guilabel> creates bookmark folders for
0076     organizing your bookmarks.</para>
0077     <para>To use your bookmarks, click the 
0078     <guibutton>BookMan II</guibutton> button and choose a bookmark.
0079     You may also use the <link linkend="key_bindings">Key-Bindings</link>: 
0080     <keycombo action="simul">&Ctrl;
0081     <keycap>B</keycap></keycombo> to bookmark the current item,
0082     <keycombo action="simul">&Alt;
0083     <keycap>right/left arrow</keycap></keycombo> to 
0084     open right/left panel bookmarks list and
0085     <keycombo action="simul">&Ctrl;
0086     <keycap>D</keycap></keycombo> to open the bookmarks of the
0087     active panel. From the context menu of the bookmark (&RMB; click)
0088     you can open it in a new 
0089     <link linkend="folder-tabs">Folder tab</link>.</para>
0090     <para>There is a quick search bar at the top of the <guibutton>BookMan II</guibutton> menu.</para>
0091     <note>
0092       <para>
0093         The search bar will always be visible in the bookmarks menu if you check the
0094         corresponding item on the <link linkend="konfig-panel-general">Panel Konfigurator's page</link>.
0095       </para>
0096     </note>
0097     <para>Below are the rules to handle bookmarks:</para>
0098     <itemizedlist>
0099         <listitem>
0100             <para>Just type letters to search: bookmarks are matched by name prefix</para>
0101         </listitem>
0102         <listitem>
0103             <para>If multiple bookmarks are matched by the prefix, they are highlighted and the first one is selected - hit &Enter; to activate the bookmark</para>
0104         </listitem>
0105         <listitem>
0106             <para>Once a single bookmark is matched, it is immediately triggered. That is when you type <literal>'h'</literal> and only one bookmark starts with <literal>'h'</literal>, it is executed immediately - no &Enter; needed</para>
0107         </listitem>
0108         <listitem>
0109             <para>Accelerators work only if the keystroke is the first one</para>
0110         </listitem>
0111         <listitem>
0112             <para>&Backspace; is supported</para>
0113         </listitem>
0114         <listitem>
0115             <para>Search is case insensitive unless you type a capital letter. That is typing <literal>HamBurglar</literal> will only match <literal>HamBurglar</literal> but not <literal>hamburglar</literal> or <literal>Hamburglar</literal>.</para>
0116         </listitem>
0117         <listitem>
0118             <para>Search bar is intentionally a read-only field</para>
0119         </listitem>
0120     </itemizedlist>
0121   </sect2>
0122   <sect2 id="password_handling">
0123     <title>Password handling</title>
0124     <para>One of the benefits of the 
0125     <link linkend="bookman">bookmark manager</link> is that the
0126     passwords are saved using &plasma;'s services - where
0127     &eg; your &konqueror;/&kmail;
0128     password are saved. If you have a wallet, &plasma; will
0129     save the passwords there. By clicking the bookmarks, a dialog
0130     will open and ask for your username and password. Supply them
0131     and click <guibutton>Save password</guibutton>. The passwords and usernames will be
0132     saved securely by &plasma;'s wallet (make sure it is
0133     enabled by your distro). The downside here is that if the system
0134     was reinstalled and you do not backup your passwords from the wallet as
0135     well as &krusader;'s bookmark file, something will
0136     be lost.</para>
0137   </sect2>
0138   <sect2 id="popular-urls">
0139     <title>Popular &URL;s</title>
0140     <indexterm>
0141       <primary>Popular &URL;s</primary>
0142     </indexterm>
0143     <para>The submenu 
0144     <guilabel>Popular &URL;s</guilabel>
0145     holds persistent the most popular visited &URL;s
0146     (local or remote). This submenu displays the top 15 popular
0147     &URL;s, sorted by ranking, so that the top &URL; is
0148     the most popular. This is easy for when you need to visit
0149     &URL;s often, but do not want to create
0150     <link linkend="bookman">Bookmarks</link>, it serves as a temporary bookmark
0151     list for the most visited links. 
0152     Quicksearch in <guilabel>Popular &URL;s</guilabel> is a fast way to
0153     browse/select the popular &URL;s: 
0154     <itemizedlist>
0155       <listitem>
0156         <para>Open the 
0157         <guilabel>Popular &URL;s</guilabel>
0158         or use 
0159         <keycombo action="simul">&Ctrl;
0160         <keycap>Z</keycap></keycombo></para>
0161       </listitem>
0162       <listitem>
0163         <para>Type a few letters to narrow the search</para>
0164       </listitem>
0165       <listitem>
0166         <para>Press &Enter; (you will go to the &URL; from
0167         list)</para>
0168       </listitem>
0169     </itemizedlist></para>
0170   </sect2>
0171   <sect2 id="permanent_bookmarks">
0172     <title>Permanent bookmarks</title>
0173     <para>These are hardcoded bookmarks to the top bookmark menu;
0174     there is no need for them to be saved to the file. With the
0175     <link linkend="context-menu">Context Menu</link> you can enable/disable these
0176     permanent bookmarks. The following permanent bookmarks are
0177     available: 
0178     <itemizedlist>
0179       <listitem>
0180         <para>
0181         <guilabel>Trash bin</guilabel> uses &plasma;'s 
0182         <filename>trash:/</filename> protocol.</para>
0183       </listitem>
0184       <listitem>
0185         <para>
0186         <guilabel>Local Network</guilabel> uses &plasma;'s 
0187         <filename>remote:/</filename> protocol.</para>
0188       </listitem>
0189       <listitem>
0190         <para>
0191         <guilabel>Virtual Filesystem</guilabel> <link linkend="vfs">Virtual file systems (VFS)</link>
0192         
0193         <filename>virt:/</filename> is not a virtual folder, but a
0194         container for &URL;s from different file
0195         systems. It is used for &eg; the 
0196         <guilabel>Feed to Listbox</guilabel> feature of the search
0197         module and the synchronizer. The location toolbar will
0198         display &eg;
0199         <filename>virt:/Search results 1</filename> or 
0200         <filename>virt:/Synchronise results 1</filename>.</para>
0201       </listitem>
0202       <listitem id="jump_back">
0203         <para>
0204         <guilabel>Jump back</guilabel> or 
0205         <keycombo action="simul">&Ctrl;
0206         <keycap>J</keycap></keycombo> brings you back to your
0207         starting position when you did create a new tab in the
0208         panel window. This feature is very handy if you go deep
0209         into a folder tree, then you can return with one action
0210         to the starting point. With 
0211         <guilabel>Set jump back point here</guilabel> or 
0212         <keycombo action="simul">
0213         &Ctrl;&Shift;
0214         <keycap>J</keycap></keycombo> sets the current folder as
0215         a jump back point.</para>
0216       </listitem>
0217     </itemizedlist></para>
0218   </sect2>
0219   <sect2 id="manage_bookmarks">
0220     <title>Manage bookmarks</title>
0221     <para>To edit and organize your bookmarks, by clicking the 
0222     <guibutton>BookMan II</guibutton> button and selecting the 
0223     <guimenuitem>Manage Bookmarks</guimenuitem>,
0224     <application>KeditBookmarks</application> will be displayed. This is where
0225     you can edit/remove and rearrange the bookmarks.
0226     <application>KeditBookmarks</application> is a
0227     bookmark editor for &konqueror;,
0228     &krusader; and other applications, which use the
0229     <ulink url="http://grail.sourceforge.net/info/xbel.html">XBEL standard</ulink> for the bookmark format. The
0230     bookmarks are stored in 
0231     <filename>
0232     ~/.local/share/krusader/krbookmarks.xml</filename>.</para>
0233     <note>
0234         <para>
0235             The default folder for the bookmarks file <filename>krusader/krbookmarks.xml</filename> is <filename class="directory">~/.local/share</filename>. You can determine the needed folder in your system using the <userinput>qtpaths --paths GenericDataLocation</userinput> command in terminal.
0236         </para>
0237         <para>
0238             This local file exists only if you have edited &krusader; bookmarks. It will be created after the first run of <application>KeditBookmarks</application> from &krusader;.
0239         </para>
0240         <para>
0241             The default system bookmarks are stored in the <filename>kfileplaces/bookmarks.xml</filename> file in the folder which can be determined using the <userinput>qtpaths --paths GenericDataLocation</userinput> command.
0242         </para>
0243     </note>
0244     <para>
0245     <application>KeditBookmarks</application> is easy to use, however, if you
0246     need more information, please read the
0247     <ulink url="help:/keditbookmarks/index.html">KeditBookmarks handbook</ulink>.</para>
0248     <figure id="screenshot-bookmanedit" float="1">
0249       <title><application>KeditBookmarks</application> Bookmark Manager</title>
0250       <mediaobject>
0251         <imageobject>
0252           <imagedata fileref="bookmanedit.png"></imagedata>
0253         </imageobject>
0254         <textobject>
0255           <phrase><application>KeditBookmarks</application> Bookmark
0256           Manager</phrase>
0257         </textobject>
0258       </mediaobject>
0259     </figure>
0260   </sect2>
0261   <sect2 id="bookmark_buttons">
0262     <title>Bookmarks as action buttons on the Toolbar</title>
0263     <para>Bookmarks can be placed as buttons on the
0264     <link linkend="mainwindow">Main Toolbar</link> or the
0265     <link linkend="actions_toolbar">Actions Toolbar</link>. You can even make a
0266     key-binding for them: 
0267     <itemizedlist>
0268       <listitem>
0269         <para>Create your <link linkend="bookman">Bookmarks</link>.</para>
0270       </listitem>
0271       <listitem>
0272         <para>If you want, create keybindings for the bookmarks in
0273         the <link linkend="key_bindings">Configure Shortcuts</link> window (<menuchoice><guimenu>Settings</guimenu> 
0274       <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>).</para>
0275       </listitem>
0276       <listitem>
0277         <para>Add your bookmarks as action buttons on the
0278         <link linkend="mainwindow">Main Toolbar</link> or the
0279         <link linkend="actions_toolbar">Actions Toolbar</link> with the 
0280         <guilabel>Configure Toolbars...</guilabel> window 
0281         (<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure Toolbars...</guimenuitem></menuchoice>).</para>
0282       </listitem>
0283     </itemizedlist></para>
0284   </sect2>
0285 </sect1>