Commit 3fd79139 authored by Bhushan Shah's avatar Bhushan Shah 📱 Committed by Bhushan Shah
Browse files

doc: move the documentation for recently moved kcms here

parent 7d5806ff
......@@ -2,3 +2,7 @@ ecm_optional_add_subdirectory(desktopthemedetails)
ecm_optional_add_subdirectory(icons)
ecm_optional_add_subdirectory(screenlocker)
ecm_optional_add_subdirectory(translations)
ecm_optional_add_subdirectory(colors)
ecm_optional_add_subdirectory(fontinst)
ecm_optional_add_subdirectory(fonts)
ecm_optional_add_subdirectory(kcmstyle)
########### install files ###############
kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/colors)
<?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="colors" lang="&language;">
<articleinfo>
<title>Colors</title>
<authorgroup>
<author>&Matthew.Woehlke; &Matthew.Woehlke.mail;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<date>2018-03-30</date>
<releaseinfo>Plasma 5.12</releaseinfo>
<keywordset>
<keyword>KDE</keyword>
<keyword>KControl</keyword>
<keyword>color</keyword>
<keyword>kcm</keyword>
</keywordset>
</articleinfo>
<sect1 id="color">
<title>Colors</title>
<sect2 id="color-scheme">
<title>Scheme Management</title>
<para>This module lets you manage the color schemes on your machine.
It shows a list of color schemes shipped with &plasma; and a preview at the top.
Only one scheme is active at once, but you may edit schemes.
You can remove schemes using <guibutton>Remove Scheme</guibutton>.
Note that system schemes cannot be removed; the button for this action is
disabled.</para>
<para>If you have an Internet connection,
you can also browse and retrieve user-created schemes using <guibutton>Get
New Color Schemes...</guibutton>.</para>
<para>You can also install schemes from a file that you have downloaded or otherwise
obtained, as well as import &kde; 4 schemes named like &quot;*.colors&quot;.
</para>
<para>If <guilabel>Apply colors to non-Qt applications</guilabel>
is checked, Plasma will attempt to export its color scheme so that
non-Qt applications will use the same colors. Most applications will
honor the exported scheme to varying degrees, though some may have bugs
or otherwise not honor the exported scheme.
</para>
<para>Note: This documentation will sometimes refer to the
&quot;current&quot; scheme, or the &quot;active&quot; scheme.
The &quot;current&quot; scheme is the set of colors and color scheme options
that was most recently applied, &ie; what you would get if you choose
<guibutton>Cancel</guibutton>. The &quot;active&quot; scheme is the set of
colors as has been most recently edited by you, &ie; what you would get if
you choose <guibutton>Apply</guibutton>.</para>
</sect2>
<sect2>
<title>Edit or Create Schemes</title>
<para>To edit or create new schemes select a scheme from the list and press the
<guibutton>Edit Scheme</guibutton> button to open a dialog with three tabs
<guilabel>Options</guilabel>, <guilabel>Colors</guilabel>, <guilabel>Disabled</guilabel>
and <guilabel>Inactive</guilabel>.
When you have created a scheme you like, you can upload it, reset it or save it
under a different name or overwrite the active scheme.
</para>
<sect3 id="color-options">
<title>Color Scheme Options</title>
<para>The <guilabel>Options</guilabel> tab allows you to change some
properties that deal with how the color scheme is used, as well as some
options that change the color scheme that are different from actually
assigning colors.</para>
<itemizedlist>
<listitem><para><guilabel>Apply effects to inactive windows</guilabel>
&mdash; If checked, state effects (see below) will be applied to inactive
windows. This can help visually identify active versus inactive windows,
and may have aesthetic value, depending on your taste. However, some
users feel that it causes distracting &quot;flickering&quot; since
windows must be repainted when they become inactive. Unlike desktop
effects, color state effects do not require compositing support and will
work on all systems, however they will only work on &kde; applications.
</para></listitem>
<listitem><para><guilabel>Use different colors for inactive selections</guilabel>
&mdash; If checked, the current selection in elements which do not have
input focus will be drawn using a different color. This can assist visual
identification of the element with input focus in some applications,
especially those which simultaneously display several lists.
</para></listitem>
<listitem><para><guilabel>Shade sorted column in lists</guilabel>
&mdash; If checked, multi-column lists will use a slightly different
color to paint the column whose information is being used to sort the
items in the list.
</para></listitem>
<listitem><para><guilabel>Contrast</guilabel>
&mdash; This slider controls the contrast of shaded elements, such as
frame borders and the &quot;3D&quot; effects used by most styles. A lower
value gives less contrast and therefore softer edges, while a higher
value makes such edges &quot;stand out&quot; more.
</para></listitem>
</itemizedlist>
</sect3>
<sect3 id="color-colors">
<title>Colors</title>
<para>The <guilabel>Colors</guilabel> tab allows you to change the colors in
the active color scheme.</para>
<para>Creating or changing a scheme is a simple matter of clicking on the
swatch in the color list and selecting a new color. It is suggested
that you save your scheme when you
are done.</para>
<para>The <guilabel>Common Colors</guilabel> set, which is displayed
initially, is not actually a &quot;set&quot; in the sense used by Plasma (see
next section), but presents a number of color roles in a way that makes it
easier to edit the scheme as a whole. When creating a new color scheme, you
will usually change these colors first, and use the other sets to tweak
specific colors if needed.</para>
<para>Note that <guilabel>Common Colors</guilabel> makes available roles from
all sets. For example, &quot;View Background&quot; here is shorthand for the
Normal Background role from the View set. Also, setting colors that do not
refer to a specific set will change that color in <emphasis>all</emphasis>
sets. (As an exception, &quot;Inactive Text&quot; will change the color for
all sets <emphasis>except</emphasis> for Selection; there is a separate
&quot;Selection Inactive Text&quot; for Inactive Text in the Selection set.)
Some roles may not be visible under <guilabel>Common Colors</guilabel> at
all, and can only be changed (if needed) by selecting the appropriate
set.</para>
<sect4>
<title>Color Sets</title>
<para>Plasma breaks the color scheme into several sets based on the type
of user interface element, as follows:</para>
<itemizedlist>
<listitem><para><guilabel>View</guilabel> &mdash;
information presentation elements, such as lists, trees, text input boxes, etc.
</para></listitem>
<listitem><para><guilabel>Window</guilabel> &mdash;
window elements that are not buttons or views.
</para></listitem>
<listitem><para><guilabel>Button</guilabel> &mdash;
buttons and similar elements.
</para></listitem>
<listitem><para><guilabel>Selection</guilabel> &mdash;
selected text and items.
</para></listitem>
<listitem><para><guilabel>Tooltip</guilabel> &mdash;
tool tips, &quot;What's This&quot; tips, and similar elements.
</para></listitem>
<listitem><para><guilabel>Complementary</guilabel> &mdash;
Areas of applications with an alternative color scheme; usually with a dark background for light color schemes. Examples of areas with this inverted color scheme are the logout interface, the lock screen and the fullscreen mode for some applications.
</para></listitem>
</itemizedlist>
<para>Each set contains a number of color roles.
Each set has the same roles. All colors are associated with
one of the above sets.</para>
</sect4>
<sect4>
<title>Color Roles</title>
<para>Each color set is made up of a number of roles which are available in
all other sets. In addition to the obvious Normal Text and Normal
Background, these roles are as follows:</para>
<itemizedlist>
<listitem><para>Alternate Background &mdash;
used when there is a need to subtly change the background to aid in
item association. This might be used &eg; as the background of a
heading, but is mostly used for alternating rows in lists, especially
multi-column lists, to aid in visually tracking rows.
</para></listitem>
<listitem><para>Link Text &mdash;
used for hyperlinks or to otherwise indicate &quot;something which may
be visited&quot;, or to show relationships.
</para></listitem>
<listitem><para>Visited Text &mdash;
used for &quot;something (&eg; a hyperlink) that has been
visited&quot;, or to indicate something that is "old".
</para></listitem>
<listitem><para>Active Text &mdash;
used to indicate an active element or attract attention, &eg; alerts,
notifications; also for hovered hyperlinks.
</para></listitem>
<listitem><para>Inactive Text &mdash;
used for text which should be unobtrusive, &eg; comments,
&quot;subtitles&quot;, unimportant information, etc.
</para></listitem>
<listitem><para>Negative Text &mdash;
used for errors, failure notices, notifications that an action may be
dangerous (&eg; unsafe web page or security context), etc.
</para></listitem>
<listitem><para>Neutral Text &mdash;
used to draw attention when another role is not appropriate; &eg;
warnings, to indicate secure/encrypted content, etc.
</para></listitem>
<listitem><para>Positive Text &mdash;
used for success notices, to indicate trusted content, etc.
</para></listitem>
</itemizedlist>
<para>As well as the text roles, there are a few additional
&quot;decoration&quot; roles that are used for drawing lines or shading
UI elements (while the above may, in appropriate circumstances, also be
used for this purpose, the following are specifically
<emphasis>not</emphasis> meant for drawing text). These are:</para>
<itemizedlist>
<listitem><para>Focus Decoration &mdash;
used to indicate the item which has active input focus.
</para></listitem>
<listitem><para>Hover Decoration &mdash;
used for mouse-over effects, &eg; the "illumination" effects for
buttons.
</para></listitem>
</itemizedlist>
<para>In addition, except for Inactive Text, there is a corresponding
background role for each of the text roles. Currently (except for Normal
and Alternate Background), these colors are not chosen by the user, but are
automatically determined based on Normal Background and the corresponding
Text color. These colors may be previewed by selecting one of the sets
other than &quot;Common Colors&quot;.</para>
<para>The choice of color role is left to the developer; the above are
guidelines intended to represent typical usage.</para>
</sect4>
<sect4>
<title>Window Manager Colors</title>
<para>As previously stated, the Window Manager set has its own roles,
independent of those in other sets. These are (currently) only accessible
via <guilabel>Common Colors</guilabel>, and are as follows:</para>
<itemizedlist>
<listitem><para>Active Titlebar &mdash;
used to draw the title bar background, borders, and/or decorations for
the active window (that is, the one with input focus). Not all window
decorations will use this in the same way, and some may even use the
Normal Background from the Window set to draw the title bar.
</para></listitem>
<listitem><para>Active Titlebar Text &mdash;
used to draw the title bar text when Active Titlebar is used to draw
the title bar background. May also be used for other foreground
elements which use Active Titlebar as the background.
</para></listitem>
</itemizedlist>
<para>The Inactive Titlebar [Text] roles are the same as the above, but for
inactive windows, rather than active windows.</para>
</sect4>
</sect3>
<sect3 id="color-effects">
<title>Color State Effects</title>
<para>Color state effects are applied to interface elements in the inactive
(windows that do not have focus; only if <guilabel>Apply inactive window
color effects</guilabel> is enabled) or disabled states. By changing the
effects, the appearance of elements in these states can be changed. Usually,
inactive elements will have reduced contrast (text fades slightly into the
background) and may have slightly reduced intensity, while disabled elements
will have strongly reduced contrast and are often notably darker or lighter.
</para>
<para>Three types of effect may be applied to each state (with the effects
of the two states being independent). These are Intensity, Color and
Contrast. The first two (Intensity, Color) control the overall color, while
the last (Contrast) deals with the foreground colors relative to the
background.</para>
<sect4>
<title>Intensity</title>
<para>Intensity allows the overall color to be lightened or darkened.
Setting the slider to the middle produces no change. The available effects
are:</para>
<itemizedlist>
<listitem><para>Shade &mdash;
makes everything lighter or darker in a controlled manner. Each
&quot;tick&quot; on the slider increases or decreases the overall
intensity (&ie; perceived brightness) by an absolute amount.
</para></listitem>
<listitem><para>Darken &mdash;
changes the intensity to a percentage of the initial value. A slider
setting halfway between middle and maximum results in a color half as
intense as the original. The minimum gives a color twice as intense as
the original.
</para></listitem>
<listitem><para>Lighten &mdash;
conceptually the opposite of darken; lighten can be thought of as
working with &quot;distance from white&quot;, where darken works with
&quot;distance from black&quot;. The minimum is a color twice as
&quot;far&quot; from white as the original, while halfway between
middle and maximum gives an intensity halfway between the original
color and white.
</para></listitem>
</itemizedlist>
</sect4>
<sect4>
<title>Color</title>
<para>Color also changes the overall color, but is not limited to
intensity. The available effects are:</para>
<itemizedlist>
<listitem><para>Desaturate &mdash;
changes the relative chroma. The middle setting produces no change;
maximum gives a gray whose perceptual intensity equals that of the
original color. Lower settings increase the chroma, giving a color that
is less gray / more &quot;vibrant&quot; than the original.
</para></listitem>
<listitem><para>Fade &mdash;
smoothly blends the original color into a reference color. The minimum
setting on the slider produces no change; maximum gives the reference
color.
</para></listitem>
<listitem><para>Tint &mdash;
similar to Fade, except that the color (hue and chroma) changes more
quickly while the intensity changes more slowly as the slider value is
increased.
</para></listitem>
</itemizedlist>
</sect4>
<sect4>
<title>Contrast</title>
<para>The contrast effects are similar to the color effects, except they
apply to the text, using the background color as the reference color, and
desaturate is not available. Fade produces text that &quot;fades out&quot;
more quickly, but keeps its color longer, while Tint produces text that
changes color to match the background more quickly while keeping a greater
intensity contrast for longer (where &quot;longer&quot; means higher
settings on the slider). For Contrast effects, the minimum setting on the
slider produces no change, while maximum causes the text to completely
disappear into the background.</para>
</sect4>
</sect3>
</sect2>
</sect1>
</article>
<!-- kate: indent-width 2; replace-tabs on; -->
########### install files ###############
kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/fontinst)
<?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="fontinst" lang="&language;">
<title>Font Management</title>
<articleinfo>
<authorgroup>
<author>&Craig.Drummond; &Craig.Drummond.Mail;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<date>2018-03-31</date>
<releaseinfo>Plasma 5.12</releaseinfo>
<keywordset>
<keyword>KDE</keyword>
<keyword>Systemsettings</keyword>
<keyword>fonts</keyword>
</keywordset>
</articleinfo>
<sect1 id="kcm_fontinst">
<title>Font Management</title>
<para>This module is responsible for installing, un-installing, previewing and managing your fonts.</para>
<sect2 id="font-groups">
<title>Font Groups</title>
<para>There are 4 special pre-defined font groups:</para>
<orderedlist>
<listitem><para><quote>All Fonts</quote> This will display all fonts, both personal and system-wide.</para></listitem>
<listitem><para><quote>Personal Fonts</quote> The fonts shown will be your personal fonts, and will not be available to other users.</para></listitem>
<listitem><para><quote>System Fonts</quote> The fonts shown will be those available to all users. Installing a font system-wide, or removing a system-wide font, will require administrator privileges.</para></listitem>
<listitem><para><quote>Unclassified</quote> This will list all fonts that have not been placed into any user-defined groups. This group will only appear if you have some user-defined groups.</para></listitem>
</orderedlist>
<para>To add a font to a group, drag it from the list of fonts onto a group. To remove a font from a group, drag the font onto the <quote>All Fonts</quote> group.</para>
<para>Below this list you find buttons to create a new group, remove a group and enable or disable the fonts in the current group.</para>
<para>In the context menu of this list you have additional menuitems to print font samples and export a font to a zip archive.</para>
<sect3 id="font-hiding">
<title>Enabling and Disabling</title>
<para>Users with many fonts may find it useful to only have certain fonts enabled (or active) at certain times. To facilitate this, this module will allow you to disable individual fonts, or whole groups of fonts. Disabling a font does not remove the font from the system, it simply hides it so that it no longer appears within applications. Re-enabling a font will then allow it to be used.</para>
</sect3>
</sect2>
<sect2 id="font-list">
<title>Font List</title>
<para>
The main display is a list of the installed fonts, grouped via the fonts' family name - the number in square brackets represents the number of installed styles for that family. e.g. The <quote>Times</quote> font may be listed as:
<itemizedlist>
<listitem>
<para>Times [4]</para>
<itemizedlist>
<listitem><para>Regular</para></listitem>
<listitem><para>Italic</para></listitem>
<listitem><para>Bold</para></listitem>
<listitem><para>Bold Italic</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</para>
<para>To install a font, press the <guibutton>Add...</guibutton> button, and select the desired fonts from within the file dialog. The selected font group will control where the fonts will be installed.</para>
<para>To un-install fonts, select the appropriate fonts from the list, and press the <guibutton>Delete...</guibutton> button.</para>
<para>Click with the &RMB; to open a context menu with some additional actions like <guilabel>Enable</guilabel>, <guilabel>Disable</guilabel>, <guilabel>Print</guilabel>, <ulink url="help:/kfontviewer/index.html"><guilabel>Open in Font Viewer</guilabel></ulink> and <guilabel>Reload</guilabel>.</para>
<sect3 id="font-filter">
<title>Font Filtering</title>
<para>A text field on top of the font preview allows you to filter the list of fonts. You can filter fonts based upon different categories:</para>
<orderedlist>
<listitem><para>Family.</para></listitem>
<listitem><para>Style.</para></listitem>
<listitem><para>Foundry.</para></listitem>
<listitem><para>FontConfig match. This allows you to enter a family name, and see the family that fontconfig would actually use.</para></listitem>
<listitem><para>Font file type.</para></listitem>
<listitem><para>Font file name.</para></listitem>
<listitem><para>Font file location.</para></listitem>
<listitem><para>Writing system.</para></listitem>
</orderedlist>
</sect3>
<sect3 id="get-new-fonts">
<title>Get New Fonts</title>
<para>New fonts may be installed from local files, or downloaded using <guilabel>Get Hot New Stuff</guilabel>. The <guilabel>Get New Fonts...</guilabel> entry in the tool button (located above the group list), allows you to install fonts from the Internet. The fonts downloaded in this manner will be installed into your <quote>Personal Fonts</quote> group. To install system-wide, you will need to move them to the <quote>System Fonts</quote> group - this may be achieved by dragging the fonts over the <quote>System Fonts</quote> group entry and will require administrator privileges.</para>
</sect3>
</sect2>
<sect2 id="font-duplicates">
<title>Duplicate Fonts</title>
<para>If you have lots of fonts installed on your system it is possible that you may have duplicates.</para>
<para>Click on the tools icon above the group list and select the <guilabel>Scan For Duplicate Fonts...</guilabel> tool, a simple tool that will scan your system looking for fonts that have multiple files associated with them. For example, if you have <quote>times.ttf</quote> and <quote>times.TTF</quote> installed in <quote>/usr/local/share/fonts</quote> the underlying font mechanism (called <quote>FontConfig</quote>) will only see one of these. So, if you un-installed the font, it would re-appear, as only one of the files would have been removed. Running this tool will produce a dialog listing each font that has multiple files, and the corresponding list of files. To select a file for deletion, click on the column containing the trash can icon.</para>
</sect2>
<sect2 id="font-preview">
<title>Preview</title>
<para>This displays a preview text in different font sizes.</para>
<para>Using the context menu enables you to zoom in and out, select a preview type (<guilabel>Standard Preview</guilabel> or <guilabel>All Characters</guilabel>) and change the preview text.</para>
<para>Launch the application &kfontview; if you need additional preview types for Unicode Blocks.
</para>
</sect2>
</sect1>
</article>
########### install files ###############
kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/fonts)
<?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="fonts" lang="&language;">
<articleinfo>
<title>Fonts</title>
<authorgroup>
<author>&Mike.McBride; &Mike.McBride.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>fonts</keyword>
</keywordset>
</articleinfo>
<sect1 id="kcm_fonts">
<title>Fonts</title>
<para>This module is designed to allow you to easily select different
fonts for different parts of the &kde; Desktop.</para>
<para>
<screenshot>
<screeninfo>Here's a screenshot of the fonts settings module</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="main.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The fonts settings module</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<para>The panel consists of different font groups to give you a lot of
flexibility in configuring your fonts: </para>
<itemizedlist>
<listitem><para><guilabel>General:</guilabel> Used everywhere when the other font
groups do not apply</para></listitem>
<listitem><para><guilabel>Fixed width:</guilabel> Anywhere a
non-proportional font is specified</para></listitem>
<listitem><para><guilabel>Small:</guilabel> When small fonts are used</para></listitem>
<listitem><para><guilabel>Toolbar:</guilabel> Font used in &kde; application
toolbars</para></listitem>
<listitem><para><guilabel>Menu:</guilabel> Font used in &kde; application
menus</para></listitem>
<listitem><para><guilabel>Window title:</guilabel> Font used in the window
title</para></listitem>
<listitem><para><guilabel>Taskbar:</guilabel> Font used in the taskbar
panel applet</para></listitem>
<listitem><para><guilabel>Desktop:</guilabel> Font used on the desktop
to label icons</para></listitem>
</itemizedlist>
<para>Each font has a corresponding <guibutton>Choose...</guibutton>
button. By clicking on this button, a dialog box appears. You can
use this dialog box to choose a new font, a font style and size.
Then press <guibutton>Ok</guibutton>.</para>
<para>An example of the font you have chosen will be displayed in the space
between the font group name and the <guibutton>Choose...</guibutton>
button.</para>
<para>When you are done, simply click <guibutton>OK</guibutton> and
all the necessary components of &kde; will be restarted so your changes
can take affect immediately.</para>
<para>The <guibutton>Adjust All Fonts...</guibutton> button allows you to
quickly set properties for all the fonts selected
above. A font selection dialog similar to the standard one will
appear, but you will notice checkboxes that allow you to change the
<guilabel>Font</guilabel>, <guilabel>Font style</guilabel> or
<guilabel>Size</guilabel> independently of each other. You can
choose any one, two, or three of these options, and they will be
applied to all the font groups.</para>
<para>
<screenshot>
<screeninfo>Adjusting all fonts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="adjust-all.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The Adjust All Fonts... dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<para>For example, if you have selected several different font faces
above, and realize they are all a size too big (this often happens
when you change screen resolution, for instance), you can apply a new
font size to all the fonts, without affecting your customized font
faces and styles.</para>
<sect2 id="fonts-aa">
<title>Anti-aliasing text</title>
<para>Default anti-aliasing settings are those used system wide by your distribution and labelled <guilabel>Vendor Default</guilabel>. You can disable all anti-aliasing by choosing <guilabel>Disabled</guilabel> in the drop down box.</para>