Git commit a26062900b6b71e8709b1f268e243f92537eec73 by Alexander Reinholdt. Committed on 28/12/2016 at 06:10. Pushed by areinholdt into branch 'master'.
Updated handbook. M +212 -227 doc/index.docbook https://commits.kde.org/smb4k/a26062900b6b71e8709b1f268e243f92537eec73 diff --git a/doc/index.docbook b/doc/index.docbook index cee8994..7b1f5f3 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1016,13 +1016,13 @@ </screenshot> <para>Its layout is as described <link linkend="mainwindow_bookmarks_menu">here</link> except that the <guimenuitem>Add Bookmark</guimenuitem> menu item is not present.</para> - <para>In the <guimenuitem>Profiles</guimenuitem> menu, all profiles you <link linkend="profiles">defined</link> are listed:</para> + <para>In the <guimenuitem>Profiles</guimenuitem> menu, all <link linkend="profiles">defined</link> profiles are listed:</para> <screenshot> <screeninfo>Screenshot of the Profiles menu of the system tray widget</screeninfo> <mediaobject> <imageobject><imagedata fileref="systemtray_profiles_menu.png" format="PNG" /></imageobject> - <textobject><phrase>System tray icon's popup menu 3</phrase></textobject> + <textobject><phrase>System tray widget's Profiles menu</phrase></textobject> </mediaobject> </screenshot> @@ -1066,266 +1066,251 @@ </sect2> </sect1> -<!-- Using Smb4K : The Plasmoid --> +<!-- + Using Smb4K : The Plasmoid +--> <sect1 id="plasmoid"> -<title>The &plasmoid;</title> -<para>&smb4k; comes with a &plasmoid; that can be added as a widget to the desktop or the panel. It consists of four views that are arranged as tabs: <guilabel>Network Neighborhood</guilabel>, <guilabel>Mounted Shares</guilabel>, <guilabel>Bookmarks</guilabel>, and <guilabel>Profiles</guilabel>.</para> + <title>The &plasmoid;</title> + + <para>In version 2.0 the &plasmoid; of &smb4k; has not been ported to QtQuick2 and &plasma; yet and is, thus, not available.</para> +</sect1> -<screenshot> - <screeninfo>Screenshot of the plasmoid on the desktop</screeninfo> +<!--<sect1 id="plasmoid"> + <title>The &plasmoid;</title> + + <para>&smb4k; comes with a &plasmoid; that can be added as a widget to the desktop or the panel. It consists of four views that are arranged as tabs: <guilabel>Network Neighborhood</guilabel>, <guilabel>Mounted Shares</guilabel>, <guilabel>Bookmarks</guilabel>, and <guilabel>Profiles</guilabel>.</para> + + <screenshot> + <screeninfo>Screenshot of the plasmoid on the desktop</screeninfo> <mediaobject> - <imageobject> - <imagedata fileref="plasmoid.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Screenshot of the plasmoid</phrase> - </textobject> + <imageobject><imagedata fileref="plasmoid.png" format="PNG" /></imageobject> + <textobject><phrase>Screenshot of the plasmoid</phrase></textobject> </mediaobject> -</screenshot> + </screenshot>--> -<!-- Using Smb4K : The Plasmoid : Network Neighborhood Tab --> +<!-- + Using Smb4K : The Plasmoid : Network Neighborhood Tab +--> -<sect2 id="plasmoid_network_neighborhood"> -<title>Network Neighborhood Tab</title> +<!-- <sect2 id="plasmoid_network_neighborhood"> + <title>Network Neighborhood Tab</title> -<para>On the <guilabel>Network Neighborhood</guilabel> page the network items are arranged in a list view:</para> + <para>On the <guilabel>Network Neighborhood</guilabel> page the network items are arranged in a list view:</para> -<screenshot> - <screeninfo>Screenshot of the plasmoid's network neighborhood tab</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="plasmoid_network_neighborhood_tab.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Bookmarks tab of the plasmoid</phrase> - </textobject> - </mediaobject> -</screenshot> + <screenshot> + <screeninfo>Screenshot of the plasmoid's network neighborhood tab</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="plasmoid_network_neighborhood_tab.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmarks tab of the plasmoid</phrase></textobject> + </mediaobject> + </screenshot> -<para>By clicking an entry you either enter the level below (⪚ clicking a workgroup or domain item will show a list of all hosts belonging to it), mount the selected share or invoke the print dialog. To go one level up again, you need to click the <guibutton>Up</guibutton> button in the toolbar.</para> + <para>By clicking an entry you either enter the level below (⪚ clicking a workgroup or domain item will show a list of all hosts belonging to it), mount the selected share or invoke the print dialog. To go one level up again, you need to click the <guibutton>Up</guibutton> button in the toolbar.</para> + <para>For hosts and shares, to the right of the name of the network item some action buttons are arranged. For hosts, there is one button with that you can open the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog. For shares, there is an additional button with that you can <link linkend="mainwindow_add_bookmarks">add the share to the bookmarks</link>. The action buttons are transparent by default and change to opaque when you move your mouse over them. By left clicking you initiate the respective action.</para> + <para>Besides the already mentioned <guibutton>Up</guibutton> button, the toolbar contains three more entries: <guibutton>Rescan</guibutton>, <guibutton>Abort</guibutton> and <guibutton>Mount Dialog</guibutton>. With them you can do a rescan, abort any running action or open the <link linkend="network_neighborhood_browser_mounting">dialog for "manual" mounts</link>.</para> + <note><para>In the current development state, the &plasmoid; is not able to handle the <link linkend="configuration_network_periodic_scanning">automatic scanning feature</link>, &smb4k; provides. Funny things will happen, if you use it with the &plasmoid; and will probably render it mostly unusable.</para></note> + </sect2>--> -<para>For hosts and shares, to the right of the name of the network item some action buttons are arranged. For hosts, there is one button with that you can open the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog. For shares, there is an additional button with that you can <link linkend="mainwindow_add_bookmarks">add the share to the bookmarks</link>. The action buttons are transparent by default and change to opaque when you move your mouse over them. By left clicking you initiate the respective action.</para> - -<para>Besides the already mentioned <guibutton>Up</guibutton> button, the toolbar contains three more entries: <guibutton>Rescan</guibutton>, <guibutton>Abort</guibutton> and <guibutton>Mount Dialog</guibutton>. With them you can do a rescan, abort any running action or open the <link linkend="network_neighborhood_browser_mounting">dialog for "manual" mounts</link>.</para> +<!-- + Using Smb4K : The Plasmoid : Mounted Shares Tab +--> -<note><para>In the current development state, the &plasmoid; is not able to handle the <link linkend="configuration_network_periodic_scanning">automatic scanning feature</link>, &smb4k; provides. Funny things will happen, if you use it with the &plasmoid; and will probably render it mostly unusable.</para></note> -</sect2> +<!-- <sect2 id="plasmoid_mounted_shares"> + <title>Mounted Shares Tab</title> -<!-- Using Smb4K : The Plasmoid : Mounted Shares Tab --> + <para>On the <guilabel>Mounted Shares</guilabel> page all mounted shares are listed:</para> -<sect2 id="plasmoid_mounted_shares"> -<title>Mounted Shares Tab</title> + <screenshot> + <screeninfo>Screenshot of the plasmoid's mounted shares tab</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="plasmoid_mounted_shares_tab.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmarks tab of the plasmoid</phrase></textobject></mediaobject> + </screenshot> -<para>On the <guilabel>Mounted Shares</guilabel> page all mounted shares are listed:</para> + <para>Right to the name of the share and its host, two action buttons are arranged. The first one is for <link linkend="mainwindow_add_bookmarks">adding a bookmark</link> and the second for unmounting the share. The action buttons are transparent by default and change to opaque when you move your mouse over them. By left clicking you initiate the respective action.</para> + <para>The toolbar only contains the <guibutton>Unmount All</guibutton> action that lets you unmount all shares at once.</para> + </sect2>--> -<screenshot> - <screeninfo>Screenshot of the plasmoid's mounted shares tab</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="plasmoid_mounted_shares_tab.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Bookmarks tab of the plasmoid</phrase> - </textobject> - </mediaobject> -</screenshot> +<!-- + Using Smb4K : The Plasmoid : Bookmarks Tab +--> -<para>Right to the name of the share and its host, two action buttons are arranged. The first one is for <link linkend="mainwindow_add_bookmarks">adding a bookmark</link> and the second for unmounting the share. The action buttons are transparent by default and change to opaque when you move your mouse over them. By left clicking you initiate the respective action.</para> +<!-- <sect2 id="plasmoid_bookmarks"> + <title>Bookmarks Tab</title> -<para>The toolbar only contains the <guibutton>Unmount All</guibutton> action that lets you unmount all shares at once.</para> -</sect2> + <para>On the <guilabel>Bookmarks</guilabel> page, the bookmark groups and bookmarks defined for the currently active profile are listed:</para> + + <screenshot> + <screeninfo>Screenshot of the plasmoid's bookmarks tab</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="plasmoid_bookmarks_tab.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmarks tab of the plasmoid</phrase></textobject> + </mediaobject> + </screenshot> -<!-- Using Smb4K : The Plasmoid : Bookmarks Tab --> + <para>Bookmarked shares can be mounted by left clicking the respective bookmark. Bookmark groups can be entered the same way.</para> + <para>To edit or remove the bookmarks, you can press the <guibutton>Edit</guibutton> action button in the toolbar to open the <link linkend="mainwindow_bookmarks_editor">Bookmark Editor</link>. To get back to the toplevel the <guibutton>Back</guibutton> button is used.</para> + </sect2>--> -<sect2 id="plasmoid_bookmarks"> -<title>Bookmarks Tab</title> +<!-- + Using Smb4K : The Plasmoid : Profiles Tab +--> -<para>On the <guilabel>Bookmarks</guilabel> page, the bookmark groups and bookmarks <!-- defined for the currently active profile -->are listed:</para> -<screenshot> - <screeninfo>Screenshot of the plasmoid's bookmarks tab</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="plasmoid_bookmarks_tab.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Bookmarks tab of the plasmoid</phrase> - </textobject> - </mediaobject> -</screenshot> -<para>Bookmarked shares can be mounted by left clicking the respective bookmark. Bookmark groups can be entered the same way.</para> -<para>To edit or remove the bookmarks, you can press the <guibutton>Edit</guibutton> action button in the toolbar to open the <link linkend="mainwindow_bookmarks_editor">Bookmark Editor</link>. To get back to the toplevel the <guibutton>Back</guibutton> button is used.</para> -</sect2> +<!-- <sect2 id="plasmoid_profiles"> + <title>Profiles Tab</title> + + <para>On the <guilabel>Profiles</guilabel> page, all defined profiles are listed. The currently active one is marked with an appended <guilabel>(active)</guilabel> label.</para> + + <screenshot> + <screeninfo>Screenshot of the plasmoid's profiles tab</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="plasmoid_profiles_tab.png" format="PNG" /></imageobject> + <textobject><phrase>Profiles tab of the plasmoid</phrase></textobject> + </mediaobject> + </screenshot> + + <para>You can activate a certain profile by clicking it.</para> + <para>Profiles can be <link linkend="profiles">managed</link> via the <link linkend="configuration_profiles">configuration dialog</link>.</para> + </sect2> +</sect1>--> -<!-- Using Smb4K : The Plasmoid : Profiles Tab --> +<!-- + Using Smb4K : Bookmarks +--> -<sect2 id="plasmoid_profiles"> - <title>Profiles Tab</title> - <para>On the <guilabel>Profiles</guilabel> page, all defined profiles are listed. The currently active one is marked with an appended <guilabel>(active)</guilabel> label.</para> - <screenshot> - <screeninfo>Screenshot of the plasmoid's profiles tab</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="plasmoid_profiles_tab.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Profiles tab of the plasmoid</phrase> - </textobject> - </mediaobject> - </screenshot> - <para>You can activate a certain profile by clicking it.</para> - <para>Profiles can be <link linkend="profiles">managed</link> via the <link linkend="configuration_profiles">configuration dialog</link>.</para> -</sect2> -</sect1> +<sect1 id="mainwindow_bookmarks"> + <title>Handling Bookmarks</title> -<!-- Using Smb4K : Bookmarks --> +<!-- + Using Bookmarks : Adding Bookmarks +--> + + <sect2 id="mainwindow_add_bookmarks"> + <title>Adding Bookmarks</title> -<sect1 id="mainwindow_bookmarks"> -<title>Handling Bookmarks</title> + <para>You can add bookmarks to your favorite shares from within the <link linkend="network_neighborhood_browser">network neighborhood browser</link>, the <link linkend="shares_view">shares view</link> and the <link linkend="plasmoid">&plasmoid;</link>. In the dock widgets of the main window, this is done by selecting one or multiple shares and clicking the <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> action. In the &plasmoid;, you click the respective bookmark action next to the item's name. A dialog will then pop up where you can add a label and/or assign a group to the bookmark.</para> -<sect2 id="mainwindow_add_bookmarks"> -<title>Adding Bookmarks</title> -<para>You can add bookmarks to your favorite shares from within the <link linkend="network_neighborhood_browser">network neighborhood browser</link>, the <link linkend="shares_view">shares view</link> and the <link linkend="plasmoid">&plasmoid;</link>. In the dock widgets of the main window, this is done by selecting one or multiple shares and clicking the <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> action. In the &plasmoid;, you click the respective bookmark action next to the item's name. A dialog will then pop up where you can add a label and/or assign a group to the bookmark.</para> -<screenshot> -<screeninfo>Screenshot of the bookmarks addition dialog</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="dialog_bookmark_addition.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>Bookmarks addition dialog</phrase> -</textobject> -</mediaobject> -</screenshot> -<para>Especially adding a group may help you to organize the bookmarks. In the bookmark menu, all bookmarks belonging to one group will be arranged in a submenu with the group entry as parent (see <link linkend="mainwindow_bookmarks_menu">below</link>).</para> -<para>The label can be any text describing the share. In case you define a label, it will be displayed in the bookmarks menu instead of the UNC by default. If you want to change this behavior, you can do so in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>.</para> -</sect2> + <screenshot> + <screeninfo>Screenshot of the bookmarks addition dialog</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="dialog_bookmark_addition.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmarks addition dialog</phrase></textobject> + </mediaobject> + </screenshot> -<sect2 id="mainwindow_bookmarks_menu"> -<title>Accessing and Managing Bookmarks</title> -<para>In the main window, the bookmarks can be accessed and managed through the <guilabel>Bookmarks</guilabel> menu:</para> + <para>Especially adding a group may help you to organize the bookmarks. In the bookmark menu, all bookmarks belonging to one group will be arranged in a submenu with the group entry as parent (see <link linkend="mainwindow_bookmarks_menu">below</link>).</para> + <para>The label can be any text describing the share. In case you define a label, it will be displayed in the bookmarks menu instead of the UNC by default. If you want to change this behavior, you can do so in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>.</para> + </sect2> -<screenshot> - <screeninfo>Screenshot of the bookmark popup menu</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="popup_menu_bookmarks.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Bookmark popup menu</phrase> - </textobject> - </mediaobject> -</screenshot> + <sect2 id="mainwindow_bookmarks_menu"> + <title>Accessing and Managing Bookmarks</title> -<para>In the menu there are two static items available:</para> + <para>In the main window, the bookmarks can be accessed and managed through the <guilabel>Bookmarks</guilabel> menu:</para> -<variablelist> - <varlistentry> - <term> - <menuchoice> - <guimenuitem>Edit Bookmarks</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Open the <link linkend="mainwindow_bookmarks_editor">bookmark editor</link>. This action is disabled if there are no bookmarks.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut> - <guimenuitem>Add Bookmark</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Add a bookmark. A share has to be selected to enable this action.</para> - </listitem> - </varlistentry> -</variablelist> + <screenshot> + <screeninfo>Screenshot of the bookmark popup menu</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="popup_menu_bookmarks.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmark popup menu</phrase></textobject> + </mediaobject> + </screenshot> -<para>In case you have not defined any groups, there is a third item:</para> + <para>In the menu there are two static items available:</para> -<variablelist> - <varlistentry> - <term> - <menuchoice> - <guimenuitem>Mount All Bookmarks</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Mount all top-level bookmarks at once. It is disabled if all bookmarked shares are mounted.</para> - </listitem> - </varlistentry> -</variablelist> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Edit Bookmarks</guimenuitem></menuchoice> + </term> + <listitem> + <para>Open the <link linkend="mainwindow_bookmarks_editor">bookmark editor</link>. This action is disabled if there are no bookmarks.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut> + <guimenuitem>Add Bookmark</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Add a bookmark. A share has to be selected to enable this action.</para> + </listitem> + </varlistentry> + </variablelist> -<para>All other entries are either group submenus or shares that do not belong to a group. All entries are listed alphabetically and the bookmarks may either appear with their UNC address or descriptive label. By clicking a bookmark, the respective share is mounted. If a bookmarked share is mounted on the system, the bookmark entry is disabled.</para> -<para>For each group there is a submenu. It contains all bookmarks belonging to the group and a <guimenuitem>Mount All Bookmarks</guimenuitem> menu item. The latter one can be used to mount all bookmarks in that submenu at once.</para> + <para>In case you have not defined any groups, there is a third item:</para> -<para>In the system tray widget, there is an identical <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> except that the <guilabel>Add Bookmark</guilabel> entry is missing. The plasmoid provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar way as in the bookmark menu. The bookmark groups and the bookmarks are listed in the view. Bookmarked shares can be mounted by clicking the respective entry. In the tool bar two actions are present: <guimenuitem>Back</guimenuitem> and <guimenuitem>Edit</guimenuitem>. By clicking <guimenuitem>Back</guimenuitem> you can get back to the top level if you entered a group folder. The <guimenuitem>Edit</guimenuitem> action will open the <link linkend="mainwindow_bookmarks_editor">bookmark editor</link>.</para> -</sect2> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Mount All Bookmarks</guimenuitem></menuchoice> + </term> + <listitem> + <para>Mount all top-level bookmarks at once. It is disabled if all bookmarked shares are mounted.</para> + </listitem> + </varlistentry> + </variablelist> -<sect2 id="mainwindow_bookmarks_editor"> -<title>Editing Bookmarks</title> -<para>The bookmarks may be edited or removed via the bookmark editor. It can be opened by clicking the <guimenuitem>Edit Bookmarks</guimenuitem> entry in the <guilabel>Bookmarks</guilabel> menu or the <guimenuitem>Edit</guimenuitem> action in the <guilabel>Bookmarks</guilabel> tab of the &plasmoid;.</para> -<screenshot> -<screeninfo>Screenshot of the bookmark editor</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="dialog_bookmark_editor.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>Bookmark editor</phrase> -</textobject> -</mediaobject> -</screenshot> -<para>In the tree view, the bookmarks are arranged according to the groups they belong to. Bookmarks without groups are located at the top level. To rearrange bookmarks, the tree view offers drag and drop capabilities, so that you can move bookmarks around using the mouse.</para> -<para>If you want to edit a bookmark, you can do so by selecting it. The stored label, login, IP address and group name appear in the input widgets and become editable. In most cases, you do not need to touch the IP address and the login, because &smb4k; stored the correct values at the time you bookmarked the share. However, if the server got a different IP address (⪚ because DHCP is used on your local network) or your login changed, these entries should be adjusted. With the label you can give each bookmark a custom description. It will be used for display <emphasis>instead</emphasis> of the UNC address, but this can be changed in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>. The group entry, finally, helps you to organize your bookmarks. Especially if you use ⪚ your notebook at home and at work, and you do not want to use <link linkend="profiles">profiles</link>, it might be a good idea to create two groups "Home" and "Work" and save the bookmarks accordingly.</para> -<para>The tree view also offers a popup menu containing the following three actions. They can be used to add groups or remove groups and/or bookmarks.</para> -<screenshot> -<screeninfo>Screenshot of the popup menu of the bookmark editor</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="popup_menu_bookmark_editor.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>Popup menu of the bookmark editor</phrase> -</textobject> -</mediaobject> -</screenshot> -<variablelist> -<varlistentry> -<term> -<menuchoice> -<guimenuitem>Add Group</guimenuitem> -</menuchoice> -</term> -<listitem> -<para>Add a bookmark group. After you created a group, you can move bookmarks to it.</para> -</listitem> -</varlistentry> -<varlistentry> -<term> -<menuchoice> -<guimenuitem>Remove</guimenuitem> -</menuchoice> -</term> -<listitem> -<para>Remove a selected bookmark or group. In case of a group, all bookmarks stored under that group are also removed.</para> -</listitem> -</varlistentry> -<varlistentry> -<term> -<menuchoice> -<guimenuitem>Clear Bookmarks</guimenuitem> -</menuchoice> -</term> -<listitem> -<para>Remove all bookmarks from the tree view including all groups.</para> -</listitem> -</varlistentry> -</variablelist> -<para>After you finished editing, the changes can be committed by clicking the <guibutton>OK</guibutton> button.</para> -</sect2> + <para>All other entries are either group submenus or shares that do not belong to a group. All entries are listed alphabetically and the bookmarks may either appear with their UNC address or descriptive label. By clicking a bookmark, the respective share is mounted. If a bookmarked share is mounted on the system, the bookmark entry is disabled.</para> + <para>For each group there is a submenu. It contains all bookmarks belonging to the group and a <guimenuitem>Mount All Bookmarks</guimenuitem> menu item. The latter one can be used to mount all bookmarks in that submenu at once.</para> + <para>In the system tray widget, there is an identical <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> except that the <guilabel>Add Bookmark</guilabel> entry is missing. <!--The plasmoid provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar way as in the bookmark menu.--> The bookmark groups and the bookmarks are listed in the view. Bookmarked shares can be mounted by clicking the respective entry. In the tool bar two actions are present: <guimenuitem>Back</guimenuitem> and <guimenuitem>Edit</guimenuitem>. By clicking <guimenuitem>Back</guimenuitem> you can get back to the top level if you entered a group folder. The <guimenuitem>Edit</guimenuitem> action will open the <link linkend="mainwindow_bookmarks_editor">bookmark editor</link>.</para> + </sect2> + + <sect2 id="mainwindow_bookmarks_editor"> + <title>Editing Bookmarks</title> + + <para>The bookmarks may be edited or removed via the bookmark editor. It can be opened by clicking the <guimenuitem>Edit Bookmarks</guimenuitem> entry in the <guilabel>Bookmarks</guilabel> menu or the <guimenuitem>Edit</guimenuitem> action in the <guilabel>Bookmarks</guilabel> tab of the &plasmoid;.</para> + + <screenshot> + <screeninfo>Screenshot of the bookmark editor</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="dialog_bookmark_editor.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmark editor</phrase></textobject> + </mediaobject> + </screenshot> + + <para>In the tree view, the bookmarks are arranged according to the groups they belong to. Bookmarks without groups are located at the top level. To rearrange bookmarks, the tree view offers drag and drop capabilities, so that you can move bookmarks around using the mouse.</para> + <para>If you want to edit a bookmark, you can do so by selecting it. The stored label, login, IP address and group name appear in the input widgets and become editable. In most cases, you do not need to touch the IP address and the login, because &smb4k; stored the correct values at the time you bookmarked the share. However, if the server got a different IP address (⪚ because DHCP is used on your local network) or your login changed, these entries should be adjusted. With the label you can give each bookmark a custom description. It will be used for display <emphasis>instead</emphasis> of the UNC address, but this can be changed in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>. The group entry, finally, helps you to organize your bookmarks. Especially if you use ⪚ your notebook at home and at work, and you do not want to use <link linkend="profiles">profiles</link>, it might be a good idea to create two groups "Home" and "Work" and save the bookmarks accordingly.</para> + <para>The tree view also offers a popup menu containing the following three actions. They can be used to add groups or remove groups and/or bookmarks.</para> + + <screenshot> + <screeninfo>Screenshot of the popup menu of the bookmark editor</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="popup_menu_bookmark_editor.png" format="PNG" /></imageobject> + <textobject><phrase>Popup menu of the bookmark editor</phrase></textobject> + </mediaobject> + </screenshot> + + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Add Group</guimenuitem></menuchoice> + </term> + <listitem> + <para>Add a bookmark group. After you created a group, you can move bookmarks to it.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Remove</guimenuitem></menuchoice> + </term> + <listitem> + <para>Remove a selected bookmark or group. In case of a group, all bookmarks stored under that group are also removed.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Clear Bookmarks</guimenuitem></menuchoice> + </term> + <listitem> + <para>Remove all bookmarks from the tree view including all groups.</para> + </listitem> + </varlistentry> + </variablelist> + <para>After you finished editing, the changes can be committed by clicking the <guibutton>OK</guibutton> button.</para> + </sect2> </sect1> <!-- Using Smb4K : Profiles -->
