[plasma/plasma-workspace/Plasma/5.27] /: kcms/lookandfeel: add docbook
Natalie Clarius
null at kde.org
Mon Jan 30 19:31:59 GMT 2023
Git commit ed65b3396678f021cd0956c3950122dd5004847d by Natalie Clarius.
Committed on 30/01/2023 at 19:31.
Pushed by nclarius into branch 'Plasma/5.27'.
kcms/lookandfeel: add docbook
M +1 -0 doc/kcontrol/CMakeLists.txt
A +3 -0 doc/kcontrol/lookandfeel/CMakeLists.txt
A +- -- doc/kcontrol/lookandfeel/component-chooser_1.png
A +- -- doc/kcontrol/lookandfeel/component-chooser_2.png
A +- -- doc/kcontrol/lookandfeel/get-new-stuff.png
A +161 -0 doc/kcontrol/lookandfeel/index.docbook
A +- -- doc/kcontrol/lookandfeel/main.png
M +1 -1 kcms/lookandfeel/kcm.cpp
M +1 -0 kcms/lookandfeel/kcm_lookandfeel.json
https://invent.kde.org/plasma/plasma-workspace/commit/ed65b3396678f021cd0956c3950122dd5004847d
diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt
index 5867bea673..a0768cd40a 100644
--- a/doc/kcontrol/CMakeLists.txt
+++ b/doc/kcontrol/CMakeLists.txt
@@ -1,3 +1,4 @@
+ecm_optional_add_subdirectory(lookandfeel)
ecm_optional_add_subdirectory(desktopthemedetails)
ecm_optional_add_subdirectory(formats)
ecm_optional_add_subdirectory(icons)
diff --git a/doc/kcontrol/lookandfeel/CMakeLists.txt b/doc/kcontrol/lookandfeel/CMakeLists.txt
new file mode 100644
index 0000000000..08c110ac67
--- /dev/null
+++ b/doc/kcontrol/lookandfeel/CMakeLists.txt
@@ -0,0 +1,3 @@
+########### install files ###############
+#
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/lookandfeel)
diff --git a/doc/kcontrol/lookandfeel/component-chooser_1.png b/doc/kcontrol/lookandfeel/component-chooser_1.png
new file mode 100644
index 0000000000..1b8b111fc1
Binary files /dev/null and b/doc/kcontrol/lookandfeel/component-chooser_1.png differ
diff --git a/doc/kcontrol/lookandfeel/component-chooser_2.png b/doc/kcontrol/lookandfeel/component-chooser_2.png
new file mode 100644
index 0000000000..205e7be754
Binary files /dev/null and b/doc/kcontrol/lookandfeel/component-chooser_2.png differ
diff --git a/doc/kcontrol/lookandfeel/get-new-stuff.png b/doc/kcontrol/lookandfeel/get-new-stuff.png
new file mode 100644
index 0000000000..d5ec89bad4
Binary files /dev/null and b/doc/kcontrol/lookandfeel/get-new-stuff.png differ
diff --git a/doc/kcontrol/lookandfeel/index.docbook b/doc/kcontrol/lookandfeel/index.docbook
new file mode 100644
index 0000000000..71e60b2eb4
--- /dev/null
+++ b/doc/kcontrol/lookandfeel/index.docbook
@@ -0,0 +1,161 @@
+<?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">
+]>
+<article id="lookandfeel" lang="&language;">
+<articleinfo>
+<title>Global Theme</title>
+<authorgroup>
+<author>
+ <firstname>Natalie</firstname>
+ <surname>Clarius</surname>
+ <email>natalie_clarius at yahoo.de</email>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2023-01-26</date>
+<releaseinfo>Plasma 5.27</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>System Settings</keyword>
+<keyword>appearance</keyword>
+<keyword>Global Theme</keyword>
+<keyword>style</keyword>
+<keyword>theme</keyword>
+<keyword>look</keyword>
+<keyword>feel</keyword>
+<keyword>global</keyword>
+<keyword>desktop</keyword>
+<keyword>skin</keyword>
+<keyword>design</keyword>
+<keyword>UI</keyword>
+</keywordset>
+</articleinfo>
+
+<sect1 id="globaltheme">
+<title>Global Themes</title>
+
+<para>
+ Global Themes provide a common look and feel for many components at once:
+</para>
+<itemizedlist>
+ <listitem><para>Desktop Layout: An arrangement of panels and widgets - for example a bottom panel with a task manager and application launcher, or a top panel with global menu and system tray</para></listitem>
+ <listitem><para>Color Scheme: Color palette used throughout &plasma; and applications</para></listitem>
+ <listitem><para>Application Style: Appearance of user interface elements such as buttons, menus, and scroll bars</para></listitem>
+ <listitem><para>Plasma Style: Appearance of panels and widgets</para></listitem>
+ <listitem><para>Window Decoration: Window borders and titlebar buttons</para></listitem>
+ <listitem><para>Icons: Icons used throughout &plasma; and applications</para></listitem>
+ <listitem><para>Cusors: Mouse pointers</para></listitem>
+ <listitem><para>Task Switcher: Overlay for switching between open windows, typically invoked with the keyboard shortcut Alt+Tab</para></listitem>
+ <listitem><para>Splash Screen: Loading screen shown during &plasma; startup</para></listitem>
+ <listitem><para>Login Screen: Screen with a user selector and password prompt shown when the computer is started up</para></listitem>
+ <listitem><para>Lock Screen: Screen with a user password prompt shown when the computer is locked</para></listitem>
+ <listitem><para>Wallpaper: A desktop background image</para></listitem>
+</itemizedlist>
+
+<para>
+ By appling a Global Theme, you can change all of the above together. You can also apply only some components of a Global Theme, such as a color scheme or a window decoration. You can choose which components to change either when applying a Global Theme, or apply individual components by using the other System Settings subsections.
+</para>
+
+<sect2 id="globaltheme-manage">
+<title>Manage Global Themes</title>
+
+<para>
+ In this module you can:
+ <itemizedlist>
+ <listitem><para>apply Global Themes</para></listitem>
+ <listitem><para>install new Global Themes, and remove installed Global Themes</para></listitem>
+ </itemizedlist>
+ <screenshot>
+ <screeninfo>Screenshot of the Global Theme manager</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="main.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+</sect2>
+
+<sect2 id="globaltheme-apply">
+<title>Apply Global Themes</title>
+
+<para>
+ You can see a preview of each theme by clicking on the image icon that appears when hovering over a theme thumbnail.
+</para>
+
+<para>
+ When clicking on a Global Theme, a dialog will show up asking you which components of the theme you would like to apply. You can select from various appearance settings and the desktop layout.
+ <screenshot>
+ <screeninfo>Screenshot of the Global Theme component chooser</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="component-chooser_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <screenshot>
+ <screeninfo>Screenshot of the Global Theme component chooser</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="component-chooser_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ After making your selection, click the <guibutton>Apply</guibutton> button to confirm your choice.
+</para>
+
+</sect2>
+
+<sect2 id="globaltheme-install">
+<title>Install Global Themes</title>
+
+<para>
+ With the button <guilabel>Get New Global Themes...</guilabel>, you can install new Global Themes by third-party providers. You need to be connected to the internet in order to access these themes. Clicking on <guibutton>Install</guibutton> in one of the themes in the dialog will install the chosen Global Theme, and after you close the dialog, your new theme is immediately available.
+ <screenshot>
+ <screeninfo>Get New Global Themes...</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="get-new-stuff.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Get New Global Themes...</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ To remove an installed Global Theme, click on the button with the thrash icon that appears when hovering over a theme thumbnail. Note that you can only remove Global Themes that you have downloaded yourself.
+</para>
+
+<para>
+ If you are interested in creating your own theme, you can learn more about the various components <ulink url="https://develop.kde.org/docs/extend/plasma/">here</ulink>.
+</para>
+
+</sect2>
+
+</sect1>
+
+</article>
+
+<!--
+Local Variables:
+mode: xml
+sgml-minimize-attributes:nil
+sgml-general-insert-case:lower
+sgml-indent-step:0
+sgml-indent-data:nil
+End:
+
+vim:tabstop=2:shiftwidth=2:expandtab
+kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
+-->
diff --git a/doc/kcontrol/lookandfeel/main.png b/doc/kcontrol/lookandfeel/main.png
new file mode 100644
index 0000000000..cffc5efa54
Binary files /dev/null and b/doc/kcontrol/lookandfeel/main.png differ
diff --git a/kcms/lookandfeel/kcm.cpp b/kcms/lookandfeel/kcm.cpp
index 77459617c3..0f1e6af89e 100644
--- a/kcms/lookandfeel/kcm.cpp
+++ b/kcms/lookandfeel/kcm.cpp
@@ -66,7 +66,7 @@ KCMLookandFeel::KCMLookandFeel(QObject *parent, const KPluginMetaData &data, con
qmlRegisterUncreatableType<KCMLookandFeel>(uri, 1, 0, "KCMLookandFeel", "Can't create KCMLookandFeel");
qmlRegisterUncreatableType<LookAndFeelManager>(uri, 1, 0, "LookandFeelManager", "Can't create LookandFeelManager");
- setButtons(Default);
+ setButtons(Default | Help);
m_model = new QStandardItemModel(this);
QHash<int, QByteArray> roles = m_model->roleNames();
diff --git a/kcms/lookandfeel/kcm_lookandfeel.json b/kcms/lookandfeel/kcm_lookandfeel.json
index 7d85447e0d..472b27c486 100644
--- a/kcms/lookandfeel/kcm_lookandfeel.json
+++ b/kcms/lookandfeel/kcm_lookandfeel.json
@@ -121,6 +121,7 @@
"X-KDE-Keywords[vi]": "theme,look,feel,global theme,desktop,appearance,skin, global,presentation,themes,design,UI,chủ đề,nhìn,cảm,chủ đề toàn cục,bàn làm việc,diện mạo,da,toàn cục,thể hiện,thiết kế,giao diện người dùng",
"X-KDE-Keywords[x-test]": "xxthemexx,xxlookxx,xxfeelxx,xxglobal themexx,xxdesktopxx,xxappearancexx,xxskinxx,xx globalxx,xxpresentationxx,xxthemesxx,xxdesignxx,xxUIxx",
"X-KDE-Keywords[zh_CN]": "theme,look,feel,global theme,desktop,appearance,skin, global,presentation,themes,design,UI,主题,视觉效果,观感,视效,全局主题,桌面,外观,桌面外观,皮肤,全局,呈现,表现,设计,界面,用户界面",
+ "X-DocPath": "kcontrol/lookandfeel/index.html",
"X-KDE-System-Settings-Parent-Category": "appearance",
"X-KDE-Weight": 1
}
More information about the kde-doc-english
mailing list