Git commit 2fbbff5dafcb030dddc530758ef7488e38ef6385 by Bhushan Shah. Committed on 23/07/2020 at 03:11. Pushed by bshah into branch 'master'.
doc: import the desktop theme and icons kcm docbooks They are imported from plasma-desktop at git commit 668b2f0b254e37197615f1be10197542fc6b1213 M +2 -0 doc/kcontrol/CMakeLists.txt A +3 -0 doc/kcontrol/desktopthemedetails/CMakeLists.txt A +- -- doc/kcontrol/desktopthemedetails/edit-delete.png A +- -- doc/kcontrol/desktopthemedetails/edit-undo.png A +- -- doc/kcontrol/desktopthemedetails/get-new-theme.png A +134 -0 doc/kcontrol/desktopthemedetails/index.docbook A +- -- doc/kcontrol/desktopthemedetails/main.png A +2 -0 doc/kcontrol/icons/CMakeLists.txt A +- -- doc/kcontrol/icons/edit-delete.png A +- -- doc/kcontrol/icons/edit-undo.png A +- -- doc/kcontrol/icons/get-new-theme.png A +134 -0 doc/kcontrol/icons/index.docbook A +- -- doc/kcontrol/icons/main.png A +- -- doc/kcontrol/icons/use-of-icons.png https://invent.kde.org/plasma/plasma-workspace/commit/2fbbff5dafcb030dddc530758ef7488e38ef6385 diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt index 647c43ab4..b69e9b4ff 100644 --- a/doc/kcontrol/CMakeLists.txt +++ b/doc/kcontrol/CMakeLists.txt @@ -1,2 +1,4 @@ +ecm_optional_add_subdirectory(desktopthemedetails) +ecm_optional_add_subdirectory(icons) ecm_optional_add_subdirectory(screenlocker) ecm_optional_add_subdirectory(translations) diff --git a/doc/kcontrol/desktopthemedetails/CMakeLists.txt b/doc/kcontrol/desktopthemedetails/CMakeLists.txt new file mode 100644 index 000000000..862514e80 --- /dev/null +++ b/doc/kcontrol/desktopthemedetails/CMakeLists.txt @@ -0,0 +1,3 @@ +########### install files ############### +# +kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/desktopthemedetails) diff --git a/doc/kcontrol/desktopthemedetails/edit-delete.png b/doc/kcontrol/desktopthemedetails/edit-delete.png new file mode 100644 index 000000000..9be3fb20f Binary files /dev/null and b/doc/kcontrol/desktopthemedetails/edit-delete.png differ diff --git a/doc/kcontrol/desktopthemedetails/edit-undo.png b/doc/kcontrol/desktopthemedetails/edit-undo.png new file mode 100644 index 000000000..6080e7de9 Binary files /dev/null and b/doc/kcontrol/desktopthemedetails/edit-undo.png differ diff --git a/doc/kcontrol/desktopthemedetails/get-new-theme.png b/doc/kcontrol/desktopthemedetails/get-new-theme.png new file mode 100644 index 000000000..2328b1700 Binary files /dev/null and b/doc/kcontrol/desktopthemedetails/get-new-theme.png differ diff --git a/doc/kcontrol/desktopthemedetails/index.docbook b/doc/kcontrol/desktopthemedetails/index.docbook new file mode 100644 index 000000000..a38243cf1 --- /dev/null +++ b/doc/kcontrol/desktopthemedetails/index.docbook @@ -0,0 +1,134 @@ +<?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="desktopthemedetails" lang="&language;"> +<articleinfo> +<title>Plasma Style</title> +<authorgroup> +<author> +<firstname>Andrew</firstname> +<surname>Lake</surname></author> +<author> + <firstname>Carl</firstname> + <surname>Schwan</surname> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2019-03-08</date> +<releaseinfo>Plasma 5.16</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>System Settings</keyword> +<keyword>desktop</keyword> +<keyword>theme</keyword> +<keyword>plasma</keyword> +</keywordset> +</articleinfo> + +<para> + &plasma; comes with multiple themes. The &plasma; theme defines how the different + components of &plasma; are displayed (⪚ Plasmoids, panels, widgets). +</para> + +<para> + <screenshot> + <screeninfo>Here's a screenshot of the &plasma; theme manager</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="main.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Customizing &plasma; theme</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para>In this module you can:</para> +<itemizedlist> + <listitem><para>install and choose &plasma; themes</para></listitem> + <listitem><para>edit &plasma; themes</para></listitem> + <listitem><para>remove &plasma; themes</para></listitem> +</itemizedlist> + +<para> + If you want to remove a theme, use the <inlinemediaobject><imageobject><imagedata + fileref="edit-delete.png" format="PNG"/></imageobject></inlinemediaobject> overlay + icon at the bottom right of the theme icon. To undo this action click on the + <inlinemediaobject><imageobject><imagedata fileref="edit-undo.png" + format="PNG"/></imageobject></inlinemediaobject> icon. + If you hit <guibutton>Apply</guibutton> or <guibutton>OK</guibutton> the themes + selected for removal are actually deleted, so you cannot undo individual or all + deletions. +</para> + +<para> + If the plasma-sdk package is installed on your system, a button appears hovering + a theme preview and lets you start the <application>Plasma Theme Explorer</application>. +</para> +<para> + For more technical information visit <ulink + url="https://techbase.kde.org/Development/Tutorials/Plasma5/ThemeDetails";>this + page</ulink>. +</para> + +<variablelist> + <varlistentry> + <term><guilabel>Get New Plasma Styles...</guilabel></term> + <listitem> + <para> + You need to be connected to the Internet to use it. Clicking on this button will + display a dialog where you can choose a new plasma theme. Clicking on + <guibutton>Install</guibutton> in the dialog will install the chosen &plasma; theme + and after you <guibutton>Close</guibutton> the installer your new theme is + immediately available. + </para> + <para> + <screenshot> + <screeninfo>Get New Plasma Styles...</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="get-new-theme.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Get New Plasma Styles...</phrase> + </textobject> + </mediaobject> + </screenshot> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Install from File...</guilabel></term> + <listitem> + <para> + If you downloaded new themes from the internet, you can use this to browse to the + location of those newly downloaded themes. Clicking on this button will bring you the + file dialog to point to the &plasma; theme tarball you have on your disk.</para> + + <para>Clicking <guibutton>Open</guibutton> in this dialog will install the theme you + pointed to and make it available in the theme list. + </para> + </listitem> + </varlistentry> +</variablelist> + +</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/desktopthemedetails/main.png b/doc/kcontrol/desktopthemedetails/main.png new file mode 100644 index 000000000..fbd99698a Binary files /dev/null and b/doc/kcontrol/desktopthemedetails/main.png differ diff --git a/doc/kcontrol/icons/CMakeLists.txt b/doc/kcontrol/icons/CMakeLists.txt new file mode 100644 index 000000000..ef088d054 --- /dev/null +++ b/doc/kcontrol/icons/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/icons) diff --git a/doc/kcontrol/icons/edit-delete.png b/doc/kcontrol/icons/edit-delete.png new file mode 100644 index 000000000..9be3fb20f Binary files /dev/null and b/doc/kcontrol/icons/edit-delete.png differ diff --git a/doc/kcontrol/icons/edit-undo.png b/doc/kcontrol/icons/edit-undo.png new file mode 100644 index 000000000..6080e7de9 Binary files /dev/null and b/doc/kcontrol/icons/edit-undo.png differ diff --git a/doc/kcontrol/icons/get-new-theme.png b/doc/kcontrol/icons/get-new-theme.png new file mode 100644 index 000000000..2b46cf7d9 Binary files /dev/null and b/doc/kcontrol/icons/get-new-theme.png differ diff --git a/doc/kcontrol/icons/index.docbook b/doc/kcontrol/icons/index.docbook new file mode 100644 index 000000000..6d1516e46 --- /dev/null +++ b/doc/kcontrol/icons/index.docbook @@ -0,0 +1,134 @@ +<?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="icons" lang="&language;"> +<articleinfo> +<title>Icons</title> +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<author>&Jost.Schenck; &Jost.Schenck.mail;</author> +<author>&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2018-12-10</date> +<releaseinfo>Plasma 5.14</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>icon</keyword> +</keywordset> +</articleinfo> + +<para>&plasma; comes with a full set of icons in several sizes. These icons +are being used all over &plasma;: the desktop, the panel, the &dolphin; file +manager, in every toolbar of every &plasma; application, etc. The icons +control module offers you very flexible ways of customizing the way &plasma; +handles icons.</para> + +<para> +<screenshot> +<screeninfo>Here's a screenshot of the icon theme manager</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="main.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Customizing &plasma; icons</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para>In this module you can:</para> +<itemizedlist> +<listitem><para>install and choose icon themes</para></listitem> +<listitem><para>choose different icon sizes</para></listitem> +<listitem><para>remove icon themes</para></listitem> +</itemizedlist> + +<important><para>Please note that some of these settings may depend on +your selected icon theme. &plasma; comes with several icon themes by default, +Breeze, Breeze Dark and Oxygen.</para></important> + +<para>At the top is a preview of the current theme icons. Most default +installations will have only a few icon theme available, amongst them the &plasma; default +Breeze theme. You can also download more from the Internet from +<ulink url="https://store.kde.org/";>https://store.kde.org/</ulink> or +install them from a local file.</para> + +<para> +On hover an animated preview shows a random selection, common mime types +and common folder icons. +</para> + +<para> +If you want to remove a theme, use the <inlinemediaobject><imageobject><imagedata +fileref="edit-delete.png" format="PNG"/></imageobject></inlinemediaobject> overlay +icon at the bottom right of the theme icon. To undo this action click on the +<inlinemediaobject><imageobject><imagedata fileref="edit-undo.png" +format="PNG"/></imageobject></inlinemediaobject> icon. +If you hit <guibutton>Apply</guibutton> or <guibutton>OK</guibutton> the themes +selected for removal are actually deleted, so you cannot undo individual or all +deletions. +</para> + +<variablelist> +<varlistentry><term><guilabel>Configure Icon Sizes</guilabel></term> +<listitem> +<para> +Select one of the components and use the slider to adapt the corresponding size. +</para> +<para> +<screenshot> +<screeninfo>Configure Icon Sizes</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="use-of-icons.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Configure Icon Sizes</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</listitem> +</varlistentry> +<varlistentry><term><guilabel>Get New Icons...</guilabel></term> +<listitem> +<para> +You need to be connected to the Internet to use it. Clicking on this button will display a dialog where you can choose a new icon theme. Clicking on <guibutton>Install</guibutton> in the dialog will install the chosen icon theme and after you <guibutton>Close</guibutton> the installer your new theme is immediately available. +</para> +<para> +<screenshot> +<screeninfo>Get New Icon Themes</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="get-new-theme.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Get New Icon Themes</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</listitem> +</varlistentry> +<varlistentry><term><guilabel>Install from File...</guilabel></term> +<listitem> +<para> +If you downloaded new themes from the internet, you can use this to browse to the +location of those newly downloaded themes. Clicking on this button will bring you the file dialog to point to the icon theme tarball you have on your disk.</para> + +<para>Clicking <guibutton>Open</guibutton> in this dialog will install the theme you pointed to and make it available in the theme list. +</para> +</listitem> +</varlistentry> +</variablelist> + +</article> diff --git a/doc/kcontrol/icons/main.png b/doc/kcontrol/icons/main.png new file mode 100644 index 000000000..bbccb2dfb Binary files /dev/null and b/doc/kcontrol/icons/main.png differ diff --git a/doc/kcontrol/icons/use-of-icons.png b/doc/kcontrol/icons/use-of-icons.png new file mode 100644 index 000000000..5463a6d9c Binary files /dev/null and b/doc/kcontrol/icons/use-of-icons.png differ
