[network/smb4k] doc: Updated handbook.

Wed Nov 6 05:38:05 GMT 2024

Git commit 68ad038ae9d105d66aac5b2849a72812eacc3173 by Alexander Reinholdt.
Committed on 06/11/2024 at 05:37.
Pushed by areinholdt into branch 'master'.

Updated handbook.

M  +-    --    doc/custom_settings_editor.png
M  +15   -8    doc/index.docbook
M  +-    --    doc/main_window.png
M  +-    --    doc/network_neighborhood_browser.png
M  +-    --    doc/network_neighborhood_browser_authentication_dialog.png
M  +-    --    doc/network_neighborhood_browser_mount_dialog.png
M  +-    --    doc/network_neighborhood_browser_preview_dialog.png
M  +-    --    doc/network_neighborhood_browser_searching.png
M  +-    --    doc/shares_view_icon_view.png
M  +-    --    doc/shares_view_list_view.png

https://invent.kde.org/network/smb4k/-/commit/68ad038ae9d105d66aac5b2849a72812eacc3173

diff --git a/doc/custom_settings_editor.png b/doc/custom_settings_editor.png
index c9605f59..7ebcba07 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 289199a3..3a60e1ba 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -4,8 +4,6 @@
   <!ENTITY smb4k "<application>Smb4K</application>">
   <!ENTITY % addindex "IGNORE">
   <!ENTITY % English "INCLUDE">
-  <!-- Entities for use with "older" KF5 versions (before May 2018) -->
-  <!-- FIXME: Can we only include these if needed?                  -->
   <!ENTITY CIFS "<acronym>CIFS</acronym>">
   <!ENTITY SMB3 "<acronym>SMB3</acronym>">
   <!ENTITY Samba "<application>Samba</application>">
@@ -1224,7 +1222,7 @@
 
       <para>Besides the global settings that can be defined in the <link linkend="configuration">configuration dialog</link>, &smb4k; offers the possibility to configure individual settings per server or share. You can make use of these custom settings if you want to</para>
       <itemizedlist>
-        <listitem><para>define individual mount or browse settings for a single server or share that deviate from the values defined in the configuration dialog,</para></listitem>
+        <listitem><para>define individual browse or mount settings for a single server or share that deviate from the values defined in the configuration dialog,</para></listitem>
         <listitem><para>define a server that should be awakened prior to network scans or mount attempts (Wake-On-LAN feature, see <link linkend="configuration_page_network_advanced_settings_wake_on_lan">here</link>),</para></listitem>
         <listitem><para>always mount a particular share on start-up or when the corresponding profile is loaded.</para></listitem>
       </itemizedlist>
@@ -1233,7 +1231,7 @@
     <sect2 id="custom_settings_adding">
       <title>Adding Custom Settings</title>
 
-      <para>In the case you want to define custom settings for a share, in both, the <link linkend="network_neighborhood_browser_actions_popup_menu">network neighborhood browser</link> and the <link linkend="shares_view_actions_popup_menu">shares view</link>, you can open the editor for the custom settings by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut><guimenuitem>Add Custom Settings</guimenuitem></menuchoice> menu entry.</para>
+      <para>To define custom settings, in both, the <link linkend="network_neighborhood_browser_actions_popup_menu">network neighborhood browser</link> and the <link linkend="shares_view_actions_popup_menu">shares view</link>, you can open the editor for the custom settings by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut><guimenuitem>Add Custom Settings</guimenuitem></menuchoice> menu entry.</para>
     
       <screenshot>
         <screeninfo>Screenshot of the custom settings editor for a share</screeninfo>
@@ -1247,17 +1245,25 @@
         </mediaobject>
       </screenshot>
 
-      <!-- FIXME: Custom settings for a server are also applied to its shares. -->
+      <para>Custom settings that you defined for a server will also be applied to its shares.</para>
 
-      <para>Individual settings can be made in the following sections / tabs:</para>
+      <para>The following settings can be made:</para>
       
       <variablelist>
+        <varlistentry>
+          <term>
+            <guilabel>Basic Settings</guilabel>
+          </term>
+          <listitem>
+            <para>You can set the IP address and the workgroup or domain of the server here. If you selected a share, you can also check the <guibutton>Always remount this share</guibutton> button to remount it every time you start &smb4k; or load the respective <link linkend="profiles">profile</link>.</para>
+          </listitem>
+        </varlistentry>
         <varlistentry>
           <term>
             <guilabel>Common Mount Settings</guilabel> (&Linux; only)
           </term>
           <listitem>
-            <para>You can define common settings related to mounting here. Check the <guibutton>Always remount this share</guibutton> button if you want to remount the selected share every time you start &smb4k;. For detailed information about these settings have a look at <link linkend="configuration_page_mounting_common_mount_settings">this section</link>.</para>
+            <para>You can define common settings related to mounting here. For detailed information about these settings have a look at <link linkend="configuration_page_mounting_common_mount_settings">this section</link>.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
@@ -1290,11 +1296,12 @@
           </term>
           <listitem>
             <para>To make the Wake-On-LAN feature work, you must provide the MAC address of the server you selected. Currently, &smb4k; has no way to determine the MAC address, so you need to find it on your own. Afterwards, you can define if the server should be woken up by sending a magic Wake-On-LAN packet before the network neighborhood is scanned and/or one of its shares is mounted.</para>
+            <para>Please note that you need to enable the Wake-On-LAN capabilities in the <link linkend="configuration_page_network_advanced_settings_wake_on_lan">configuration dialog</link> to take advantage of these settings.</para>
           </listitem>
         </varlistentry>
       </variablelist>
       
-      <para>The <guibutton>Defaults</guibutton> button is enabled if the entries in the dialog deviate from the settings you defined in the configuration dialog. By clicking it, you can reset the entries in the dialog to their default values. The <guibutton>OK</guibutton> button is enabled if you changed the settings in the dialog. Clicking it will save the custom settings and close the dialog.</para>
+      <para>The <guibutton>Reset</guibutton> and <guibutton>Save</guibutton> buttons are enabled if you changed some values in the editor. With the <guibutton>Reset</guibutton> button you can reset the entries in the dialog to their initial values. Clicking the <guibutton>Save</guibutton> will save the custom settings and close the dialog. To delete custom settings, use the <link linkend="configuration_page_custom_settings">configuration dialog</link>.</para>
       <para>Please note that under BSD the dialog contains fewer entries than if you run &Linux;, because several of the options are not supported.</para>
     </sect2>
 
diff --git a/doc/main_window.png b/doc/main_window.png
index b02ec37a..14e318c2 100644
Binary files a/doc/main_window.png and b/doc/main_window.png differ
diff --git a/doc/network_neighborhood_browser.png b/doc/network_neighborhood_browser.png
index 538a789f..cb1d1aa9 100644
Binary files a/doc/network_neighborhood_browser.png and b/doc/network_neighborhood_browser.png differ
diff --git a/doc/network_neighborhood_browser_authentication_dialog.png b/doc/network_neighborhood_browser_authentication_dialog.png
index a57d1b65..ccaef84f 100644
Binary files a/doc/network_neighborhood_browser_authentication_dialog.png and b/doc/network_neighborhood_browser_authentication_dialog.png differ
diff --git a/doc/network_neighborhood_browser_mount_dialog.png b/doc/network_neighborhood_browser_mount_dialog.png
index 577ed61e..8732d84e 100644
Binary files a/doc/network_neighborhood_browser_mount_dialog.png and b/doc/network_neighborhood_browser_mount_dialog.png differ
diff --git a/doc/network_neighborhood_browser_preview_dialog.png b/doc/network_neighborhood_browser_preview_dialog.png
index 2172f7fd..38114ece 100644
Binary files a/doc/network_neighborhood_browser_preview_dialog.png and b/doc/network_neighborhood_browser_preview_dialog.png differ
diff --git a/doc/network_neighborhood_browser_searching.png b/doc/network_neighborhood_browser_searching.png
index 6e4dd4b7..1fd16b64 100644
Binary files a/doc/network_neighborhood_browser_searching.png and b/doc/network_neighborhood_browser_searching.png differ
diff --git a/doc/shares_view_icon_view.png b/doc/shares_view_icon_view.png
index 7ad627e2..015aaede 100644
Binary files a/doc/shares_view_icon_view.png and b/doc/shares_view_icon_view.png differ
diff --git a/doc/shares_view_list_view.png b/doc/shares_view_list_view.png
index 4df0e24a..e4d55183 100644
Binary files a/doc/shares_view_list_view.png and b/doc/shares_view_list_view.png differ

