[network/smb4k/4.0] /: Merged handbook from master.
Alexander Reinholdt
null at kde.org
Mon Dec 30 14:59:17 GMT 2024
Git commit 7f87a15ce893df263e87d0fd57fba52b6053806b by Alexander Reinholdt.
Committed on 30/12/2024 at 14:58.
Pushed by areinholdt into branch '4.0'.
Merged handbook from master.
M +- -- doc/bookmarks_editor.png
A +- -- doc/bookmarks_editor_with_input_widget.png
M +- -- doc/bookmarks_popup_menu.png
M +- -- doc/custom_settings_editor.png
M +11 -41 doc/index.docbook
M +- -- doc/notification_missing_program.png
M +- -- doc/notification_share_mounted.png
M +6 -6 smb4k/smb4ksystemtray.cpp
https://invent.kde.org/network/smb4k/-/commit/7f87a15ce893df263e87d0fd57fba52b6053806b
diff --git a/doc/bookmarks_editor.png b/doc/bookmarks_editor.png
index b42a330dc..fd88bdff3 100644
Binary files a/doc/bookmarks_editor.png and b/doc/bookmarks_editor.png differ
diff --git a/doc/bookmarks_editor_with_input_widget.png b/doc/bookmarks_editor_with_input_widget.png
new file mode 100644
index 000000000..b688279e5
Binary files /dev/null and b/doc/bookmarks_editor_with_input_widget.png differ
diff --git a/doc/bookmarks_popup_menu.png b/doc/bookmarks_popup_menu.png
index 73ab5b76b..d2059bcf8 100644
Binary files a/doc/bookmarks_popup_menu.png and b/doc/bookmarks_popup_menu.png differ
diff --git a/doc/custom_settings_editor.png b/doc/custom_settings_editor.png
index ea7ceff30..47809625b 100644
Binary files a/doc/custom_settings_editor.png and b/doc/custom_settings_editor.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 5f0b03322..1c4512363 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1079,7 +1079,7 @@
<sect2 id="bookmarks_adding">
<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 main window, this is done by selecting one or more 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 assign the bookmark to a category.</para>
+ <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 main window, this is done by selecting one or more 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 assign the bookmark to a category. Double-click a bookmark to open the input widget.</para>
<screenshot>
<screeninfo>Screenshot of the bookmarks addition dialog</screeninfo>
@@ -1110,7 +1110,7 @@
</mediaobject>
</screenshot>
- <para>There are two static items available in the menu:</para>
+ <para>There are two static items in the menu:</para>
<variablelist>
<varlistentry>
@@ -1142,13 +1142,13 @@
<menuchoice><guimenuitem>Mount Bookmarks</guimenuitem></menuchoice>
</term>
<listitem>
- <para>Mount all top level bookmarks at once. This entry is disabled if all bookmarked shares are aready mounted.</para>
+ <para>Mount all top level bookmarks at once. This entry is disabled if all bookmarked shares are already mounted.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The following entries are category submenus and bookmarks that do not belong to any category. The entries are listed alphabetically and the bookmarks may appear either with their location or a descriptive label. If you click a bookmark, the respective share will be mounted. In case a bookmarked share is already mounted, the entry is disabled.</para>
- <para>The category submenus contain the assigned bookmarks, and in each case a <guimenuitem>Mount Bookmarks</guimenuitem> menu item is also present. It can be used to mount all bookmarks in that category at once.</para>
+ <para>The category submenus contain the assigned bookmarks as well as a <guimenuitem>Mount Bookmarks</guimenuitem> menu item. It can be used to mount all bookmarks in that category at once.</para>
<para>In the system tray widget, there is a similar <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> which, however, does not come with the <guilabel>Add Bookmark</guilabel> entry.</para>
<para>The &plasmoid; provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar manner as in the bookmark menu. For further details read <link linkend="plasmoid_bookmarks">this section</link>.</para>
</sect2>
@@ -1160,8 +1160,7 @@
<sect2 id="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>
-
+ <para>The bookmarks may be edited or removed via the bookmark editor or the <guilabel>Bookmarks</guilabel> page in the <link linkend="configuration_page_bookmarks">configuration dialog</link>. The bookmark editor 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>
@@ -1169,46 +1168,17 @@
<textobject><phrase>Bookmark editor</phrase></textobject>
</mediaobject>
</screenshot>
-
<para>In the tree view, the bookmarks are arranged according to the categories they belong to. Bookmarks without a category are located at the top level. To rearrange bookmarks, the tree view offers drag and drop capabilities, so you can move bookmarks around with 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 category 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; stores the correct values at the time you bookmark 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 location, but this can be changed in the <link linkend="configuration_page_user_interface_main_window">configuration dialog</link>. Finally,the category entry helps you to organize your bookmarks. For instance, if you use your notebook at home and also 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 categorize the bookmarks accordingly.</para>
- <para>The tree view also offers a popup menu containing the following three actions. They can be used to add categories or to remove groups and bookmarks.</para>
-
+ <para>If you want to edit a bookmark, you can do so by either double-clicking or selecting it and pressing the <guibutton>Edit</guibutton>button. The input widget will then be shown. Here you can edit the label, category name, login, workgroup or domain name and the IP address.</para>
<screenshot>
- <screeninfo>Screenshot of the popup menu of the bookmark editor</screeninfo>
+ <screeninfo>Screenshot of the bookmark editor with opened input widget</screeninfo>
<mediaobject>
- <imageobject><imagedata fileref="bookmarks_editor_popup_menu.png" format="PNG" /></imageobject>
- <textobject><phrase>Popup menu of the bookmark editor</phrase></textobject>
+ <imageobject><imagedata fileref="bookmarks_editor_with_input_widget.png" format="PNG" /></imageobject>
+ <textobject><phrase>Bookmark editor with opened input widget</phrase></textobject>
</mediaobject>
</screenshot>
-
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice><guimenuitem>Add Category</guimenuitem></menuchoice>
- </term>
- <listitem>
- <para>Add a bookmark category. After you create a category, you can move bookmarks to it.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guimenuitem>Remove</guimenuitem></menuchoice>
- </term>
- <listitem>
- <para>Remove a selected bookmark or category. In the case of a category, all the bookmarks stored in that group are also removed.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guimenuitem>Clear</guimenuitem></menuchoice>
- </term>
- <listitem>
- <para>Remove all bookmarks and categories from the tree view.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>After you have finished editing, the changes can be saved by clicking the <guibutton>OK</guibutton> button.</para>
+ <para>In most cases, you do not need to touch the IP address and the login, because &smb4k; stores the correct values at the time you bookmark 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. You also should adjust the workgroup or domain name, if its name was discovered by DNS-SD (and is most likely called <emphasis>LOCAL</emphasis>). With the label you can give each bookmark a custom description. It will be used for display <emphasis>instead</emphasis> of the location, but this can be changed in the <link linkend="configuration_page_user_interface_main_window">configuration dialog</link>. Finally,the category entry helps you to organize your bookmarks. For instance, if you use your notebook at home and also at work, and you do not want to use <link linkend="profiles">profiles</link>, it might be a good idea to create two categories, "Home" and "Work", and categorize the bookmarks accordingly.</para>
+ <para>With the <guibutton>Add Category</guibutton> button, you can add a category. The <guibutton>Remove</guibutton> button removes the selected bookmark and the <guibutton>Clear List</guibutton> button clears the whole list of bookmarks. As long as you have not saved the changes by clicking the <guibutton>Save</guibutton> button, you can reset all your changes with the <guibutton>Reset</guibutton> button.</para>
</sect2>
</sect1>
diff --git a/doc/notification_missing_program.png b/doc/notification_missing_program.png
index 682efac64..43700424b 100644
Binary files a/doc/notification_missing_program.png and b/doc/notification_missing_program.png differ
diff --git a/doc/notification_share_mounted.png b/doc/notification_share_mounted.png
index 50a16ecfc..ca44f8336 100644
Binary files a/doc/notification_share_mounted.png and b/doc/notification_share_mounted.png differ
diff --git a/smb4k/smb4ksystemtray.cpp b/smb4k/smb4ksystemtray.cpp
index 00e788bfc..d2593e8a5 100644
--- a/smb4k/smb4ksystemtray.cpp
+++ b/smb4k/smb4ksystemtray.cpp
@@ -37,13 +37,13 @@ using namespace Smb4KGlobal;
Smb4KSystemTray::Smb4KSystemTray(QWidget *parent)
: KStatusNotifierItem(QStringLiteral("org.kde.smb4k.statusnotifieritem"), parent)
{
- QString iconName;
+ QString iconName = QStringLiteral("smb4k");
- if (KIconLoader::global()->hasIcon(QStringLiteral("network-workgroup-symbolic"))) {
- iconName = QStringLiteral("network-workgroup-symbolic");
- } else {
- iconName = QStringLiteral("network-workgroup");
- }
+ // if (KIconLoader::global()->hasIcon(QStringLiteral("network-workgroup-symbolic"))) {
+ // iconName = QStringLiteral("network-workgroup-symbolic");
+ // } else {
+ // iconName = QStringLiteral("network-workgroup");
+ // }
setIconByName(iconName);
setToolTip(iconName, i18n("Smb4K"), KAboutData::applicationData().shortDescription());
More information about the kde-doc-english
mailing list