[network/smb4k] doc: Updated handbook.
Alexander Reinholdt
null at kde.org
Wed Dec 25 16:55:03 GMT 2024
Git commit 2cf9d3260ba33c701606fb1a9bf49bccc28f5f8e by Alexander Reinholdt.
Committed on 25/12/2024 at 16:53.
Pushed by areinholdt into branch 'master'.
Updated handbook.
M +- -- doc/bookmarks_editor.png
D +- -- doc/bookmarks_editor_popup_menu.png
A +- -- doc/bookmarks_editor_with_input_widget.png
M +6 -36 doc/index.docbook
https://invent.kde.org/network/smb4k/-/commit/2cf9d3260ba33c701606fb1a9bf49bccc28f5f8e
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_popup_menu.png b/doc/bookmarks_editor_popup_menu.png
deleted file mode 100644
index f3a46c4de..000000000
Binary files a/doc/bookmarks_editor_popup_menu.png and /dev/null 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/index.docbook b/doc/index.docbook
index d530352e6..a0a88da93 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1161,7 +1161,6 @@
<title>Editing Bookmarks</title>
<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>, you can add a category. The <guibutton>Remove</guibutton> removes the selected bookmark and the <guibutton>Clear List</guibutton> button removes all 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>
More information about the kde-doc-english
mailing list