[plasma/plasma-workspace] doc/kcontrol: kcms/cursortheme: migrate docbook for cursor theme and launch feedback from plasma-desktop

Natalie Clarius null at kde.org
Mon Jan 30 22:09:41 GMT 2023 

Git commit 4beb9510786592046e6c28a43d94d8cb5439d6a7 by Natalie Clarius.
Committed on 30/01/2023 at 21:46.
Pushed by nclarius into branch 'master'.

kcms/cursortheme: migrate docbook for cursor theme and launch feedback from plasma-desktop

M  +1    -0    doc/kcontrol/CMakeLists.txt
A  +2    -0    doc/kcontrol/cursortheme/CMakeLists.txt
A  +-    --    doc/kcontrol/cursortheme/cursor-size.png
A  +-    --    doc/kcontrol/cursortheme/get-new-stuff.png
A  +160  -0    doc/kcontrol/cursortheme/index.docbook
A  +-    --    doc/kcontrol/cursortheme/launch-feedback.png
A  +-    --    doc/kcontrol/cursortheme/main.png

https://invent.kde.org/plasma/plasma-workspace/commit/4beb9510786592046e6c28a43d94d8cb5439d6a7

diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt
index a0768cd40a..09213dfee4 100644
--- a/doc/kcontrol/CMakeLists.txt
+++ b/doc/kcontrol/CMakeLists.txt
@@ -5,6 +5,7 @@ ecm_optional_add_subdirectory(icons)
 ecm_optional_add_subdirectory(screenlocker)
 ecm_optional_add_subdirectory(translations)
 ecm_optional_add_subdirectory(colors)
+ecm_optional_add_subdirectory(cursortheme)
 ecm_optional_add_subdirectory(fontinst)
 ecm_optional_add_subdirectory(fonts)
 ecm_optional_add_subdirectory(kcmstyle)
diff --git a/doc/kcontrol/cursortheme/CMakeLists.txt b/doc/kcontrol/cursortheme/CMakeLists.txt
new file mode 100644
index 0000000000..76b672acc2
--- /dev/null
+++ b/doc/kcontrol/cursortheme/CMakeLists.txt
@@ -0,0 +1,2 @@
+########### install files ###############
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/cursortheme)
diff --git a/doc/kcontrol/cursortheme/cursor-size.png b/doc/kcontrol/cursortheme/cursor-size.png
new file mode 100644
index 0000000000..68d11507c6
Binary files /dev/null and b/doc/kcontrol/cursortheme/cursor-size.png differ
diff --git a/doc/kcontrol/cursortheme/get-new-stuff.png b/doc/kcontrol/cursortheme/get-new-stuff.png
new file mode 100644
index 0000000000..82fe756445
Binary files /dev/null and b/doc/kcontrol/cursortheme/get-new-stuff.png differ
diff --git a/doc/kcontrol/cursortheme/index.docbook b/doc/kcontrol/cursortheme/index.docbook
new file mode 100644
index 0000000000..6a8861b554
--- /dev/null
+++ b/doc/kcontrol/cursortheme/index.docbook
@@ -0,0 +1,160 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
+"dtd/kdedbx45.dtd" [
+<!ENTITY % addindex "IGNORE">
+<!ENTITY % English "INCLUDE" > <!-- change language only here -->
+]>
+
+<article id="cursortheme" lang="&language;">
+<articleinfo>
+<title>Cursor Theme</title>
+<authorgroup>
+<author>&Mike.McBride; &Mike.McBride.mail;</author>
+<author>&Brad.Hards; &Brad.Hards.mail;</author>
+<author>&Lauri.Watts; &Lauri.Watts.mail;</author>
+<author><firstname>Natalie</firstname><surname>Clarius</surname><email>natalie_clarius at yahoo.de</email></author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2023-01-29</date>
+<releaseinfo>Plasma 5.27</releaseinfo>
+
+<abstract>
+<para>This is the documentation for the &systemsettings; module to 
+customize the mouse cursor appearance.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>Systemsettings</keyword>
+<keyword>mouse</keyword>
+<keyword>cursor</keyword>
+<keyword>pointer</keyword>
+<keyword>bouncing</keyword>
+<keyword>blinking</keyword>
+<keyword>animation</keyword>
+<keyword>launch</keyword>
+<keyword>feedback</keyword>
+<keyword>theme</keyword>
+</keywordset>
+</articleinfo>
+
+<sect1 id="cursorthemes">
+<title>Cursor Theme</title>
+
+<para>
+This module allows you to
+<itemizedlist>
+<listitem><para>select a cursor theme</para></listitem>
+<listitem><para>configure a cursor animation for launching applications</para></listitem>
+</itemizedlist>
+</para>
+
+<para>The features provided by this module may not be available on some systems.</para>
+
+<sect2 id="cursorthememanagement">
+<title>Cursor Theme Management</title>
+
+<screenshot>
+<screeninfo>Screenshot of the Cursor Theme manager</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="main.png" format="PNG" />
+</imageobject>
+</mediaobject>
+</screenshot>
+
+<para>To use a cursor theme, simply select it and click the <guilabel>Apply</guilabel> button.</para>
+
+<para>You can remove cursor themes using the trash button that appears when you hover the mouse pointer over the theme item in the list. Note that you can not remove the pre-installed themes.</para>
+
+<para>Use the <guilabel>Get New Cursors...</guilabel> button to launch the <guilabel>Download New Cursors</guilabel> dialog and download additional themes from the internet.</para>
+
+<screenshot>
+<screeninfo>Screenshot of the Get New Cursor Themes</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="get-new-stuff.png" format="PNG" />
+</imageobject>
+</mediaobject>
+</screenshot>
+
+<para>You can also install cursor themes files you have downloaded or otherwise obtained using the <guilabel>Install from File...</guilabel> button.</para>
+
+<para>If you are interested in creating your own cursor theme, you can find information<ulink url="https://userbase.kde.org/Special:MyLanguage/Create_your_own_mouse_cursor_theme">here</ulink>.</para>
+
+</sect2>
+
+<sect2 id="cursorsize">
+<title>Cursor size</title>
+
+<para>Some themes allow choosing the cursor size. Use the <guilabel>Size</guilabel> field to select the appropriate size.</para>
+
+<screenshot>
+<screeninfo>Screenshot of the Cursor Size</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="cursor-size.png" format="PNG" />
+</imageobject>
+</mediaobject>
+</screenshot>
+
+</sect2>
+
+<sect2 id="lauchfeedback">
+<title>Launch feedback</title>
+
+<para>Sometimes it is reassuring to know that your computer didn't just
+ignore your command, and something is happening behind the scenes. In
+this dialog <guilabel>Configure Launch Fedback...</guilabel>, 
+you can configure visible feedback to help you know if you
+really hit that icon or not.</para>
+
+<screenshot>
+<screeninfo>Screenshot of the Launch Feedback</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="launch-feedback.png" format="PNG" />
+</imageobject>
+</mediaobject>
+</screenshot>
+	
+<para>The traditional way to indicate that your computer is busy is to
+modify the cursor, and you can turn this on by choosing a
+<guilabel>Cursor</guilabel>.</para>
+
+<para>With this option enabled, your cursor will have an icon attached
+to it for a short time, when a new application is being launched.  You
+can configure how long this icon is displayed beside your cursor with the
+<guilabel>Stop animation after:</guilabel> spinbox.  The
+default is 5 seconds.</para>
+
+<para>There are several variations of busy cursor available, including
+a <guilabel>No Feedback</guilabel>, a <guilabel>Blinking</guilabel>, a 
+<guilabel>Bouncing</guilabel> or a <guilabel>Static</guilabel> cursor 
+icon with no animation.</para>
+
+<para>Traditional &plasma; launch notification has taken another form,
+which you can also enable and disable here.  Normally when you start an
+application, it gets an immediate entry in the taskbar, with the icon
+replaced by a spinning hourglass to let you know something is
+happening.  You can toggle this behavior on and off with the
+<guilabel>Enable animation</guilabel> checkbox.</para>
+
+<para>Not all applications that you start will eventually show a window, or 
+an entry in the taskbar.  Some of them, for example, are docked into the 
+&plasma; system tray. Alternatively, it might be that you sent it off to a 
+different virtual desktop, and in the <guilabel>Behavior</guilabel> section 
+of the <ulink url="help:/plasma-desktop/panel.html"> <guilabel>Task Manager 
+Settings</guilabel></ulink> the option <guilabel>From the current 
+desktop</guilabel> is checked for the <guilabel>Show only tasks</guilabel> 
+switcher.  Setting a timeout ensures that, even in these cases, you can 
+still get launch feedback, but also that it will go away when the job is 
+done.</para>
+
+</sect2>
+
+</sect1>
+
+</article>
diff --git a/doc/kcontrol/cursortheme/launch-feedback.png b/doc/kcontrol/cursortheme/launch-feedback.png
new file mode 100644
index 0000000000..42ddb78f33
Binary files /dev/null and b/doc/kcontrol/cursortheme/launch-feedback.png differ
diff --git a/doc/kcontrol/cursortheme/main.png b/doc/kcontrol/cursortheme/main.png
new file mode 100644
index 0000000000..d7ffd3e9dd
Binary files /dev/null and b/doc/kcontrol/cursortheme/main.png differ

More information about the kde-doc-english mailing list