Differential D15024 Diff 40526 doc/kcontrol/icons/index.docbook

Changeset View

Standalone View

View Options

doc/kcontrol/icons/index.docbook

Context not available.
15<!-- TRANS:ROLES_OF_TRANSLATORS --> 15​<!-- TRANS:ROLES_OF_TRANSLATORS -->
16</authorgroup> 16​</authorgroup>
17 17​
18<date>2017-11-07</date> 18​<date>2018-08-21</date>
19<releaseinfo>Plasma 5.11</releaseinfo> 19​<releaseinfo>Plasma 5.13</releaseinfo>
20 20​
21<keywordset> 21​<keywordset>
22<keyword>KDE</keyword> 22​<keyword>KDE</keyword>
Context not available.
24<keyword>icon</keyword> 24​<keyword>icon</keyword>
25</keywordset> 25​</keywordset>
26</articleinfo> 26​</articleinfo>
27<sect1 id="kcm_icons"> ​
28<title>Icons</title> ​
29 ​
30<sect2 id="icons-intro"> ​
31<title>Introduction</title> ​
32 27​
33<para>&plasma; comes with a full set of icons in several sizes. These icons 28​<para>&plasma; comes with a full set of icons in several sizes. These icons
34are being used all over &plasma;: the desktop, the panel, the &dolphin; file 29​are being used all over &plasma;: the desktop, the panel, the &dolphin; file
35manager, in every toolbar of every &plasma; application, etc. The icons 30​manager, in every toolbar of every &plasma; application, etc. The icons
36control module offers you very flexible ways of customizing the way &plasma; 31​control module offers you very flexible ways of customizing the way &plasma;
37handles icons. </para> 32​handles icons.</para>
38 33​
39<para> 34​<para>
40<screenshot> 35​<screenshot>
pinoUnsubmitted
Not Done

extra empty line

pino: extra empty line
Context not available.
54<itemizedlist> 49​<itemizedlist>
55<listitem><para>install and choose icon themes</para></listitem> 50​<listitem><para>install and choose icon themes</para></listitem>
56<listitem><para>choose different icon sizes</para></listitem> 51​<listitem><para>choose different icon sizes</para></listitem>
57<listitem><para>assign effects to icons (for example make them 52​<listitem><para>remove icon themes</para></listitem>
58semi-transparent or colorize them) </para></listitem> ​
59<listitem><para>configure these settings for each of the different places ​
60icons will be used in: for example the desktop, toolbars &etc; ​
61</para></listitem> ​
62</itemizedlist> 53​</itemizedlist>
63 54​
64<important><para>Please note that some of these settings may depend on 55​<important><para>Please note that some of these settings may depend on
65your selected icon theme. &plasma; comes with several icon themes by default, 56​your selected icon theme. &plasma; comes with several icon themes by default,
66Oxygen, Monochrome and Breeze.</para></important> 57​Breeze, Breeze Dark and Oxygen.</para></important>
67 ​
68<para>There are two pages in this module: <guilabel>Theme</guilabel> and <guilabel>Advanced</guilabel>. <guilabel>Theme</guilabel> manages the icon themes while <guilabel>Advanced</guilabel> lets you configure how icons will be used in &plasma;.</para> ​
69</sect2> ​
70 ​
71<sect2 id="icon-theme"> ​
72<title>Theme</title> ​
73 58​
74<para>At the top is a preview of the current theme icons. Most default 59​<para>At the top is a preview of the current theme icons. Most default
75installations will have only a few icon theme available, amongst them the &plasma; default 60​installations will have only a few icon theme available, amongst them the &plasma; default
76Breeze theme. You can also download more from the Internet from 61​Breeze theme. You can also download more from the Internet from
77<ulink url="https://store.kde.org/">https://store.kde.org/</ulink>.</para> 62​<ulink url="https://store.kde.org/">https://store.kde.org/</ulink> or
63​install a them from a local file.</para>
78 64​
79<variablelist> ​
80<varlistentry><term><guilabel>Get New Themes...</guilabel></term> ​
81<listitem> ​
82<para> 65​<para>
83You 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. 66​On hover an animated preview shows a random selection, common mime types
67​and common folder icons.
84</para> 68​</para>
69​
85<para> 70​<para>
86<screenshot> 71​If you want to remove a theme, use the <inlinemediaobject><imageobject><imagedata
87<screeninfo>Get New Icon Themes</screeninfo> 72​fileref="edit-delete.png" format="PNG"/></imageobject></inlinemediaobject> overlay
88 <mediaobject> 73​icon at the button right of the theme icon. To undo this action click on the
89 <imageobject> 74​<inlinemediaobject><imageobject><imagedata fileref="edit-undo.png"
90 <imagedata fileref="get-new-theme.png" format="PNG"/> 75​format="PNG"/></imageobject></inlinemediaobject> icon.
91 </imageobject> 76​If you hit <guibutton>Apply</guibutton> or <guibutton>OK</guibutton> the themes
92 <textobject> 77​selected for removal are actually deleted, so you can undo individual or all
93 <phrase>Get New Icon Themes</phrase> 78​deletions
94 </textobject> ​
95 </mediaobject> ​
96</screenshot> ​
97</para> 79​</para>
98</listitem> 80​
99</varlistentry> 81​<variablelist>
100<varlistentry><term><guilabel>Install Theme File...</guilabel></term> 82​<varlistentry><term><guilabel>Configure Icon Sizes</guilabel></term>
101<listitem> 83​<listitem>
102<para> 84​<para>
103If you dowloaded new themes from the internet, you can use this to browse to the 85​Select one of the components and use the slider to adapt the corresponding size.
104location of those newly downloaded themes. Clicking on this button will bring you a small dialog to point to the icon theme tarball you have on your disk.</para> 86​</para>
pinoUnsubmitted
Not Done

typo "to"

pino: typo "to"
105<para> 87​<para>
106<screenshot> 88​<screenshot>
107<screeninfo>Installing A New Icon Theme</screeninfo> 89​<screeninfo>Configure Icon Sizes</screeninfo>
108 <mediaobject> 90​ <mediaobject>
109 <imageobject> 91​ <imageobject>
110 <imagedata fileref="install-theme.png" format="PNG"/> 92​ <imagedata fileref="use-of-icons.png" format="PNG"/>
111 </imageobject> 93​ </imageobject>
112 <textobject> 94​ <textobject>
113 <phrase>Installing A New Icon Theme</phrase> 95​ <phrase>Configure Icon Sizes</phrase>
114 </textobject> 96​ </textobject>
115 </mediaobject> 97​ </mediaobject>
116</screenshot> 98​</screenshot>
117</para> 99​</para>
118<para>Clicking <guibutton>OK</guibutton> in this dialog will install the theme you pointed to and make it available in the theme list. ​
119</para> ​
120</listitem> 100​</listitem>
121</varlistentry> 101​</varlistentry>
122<varlistentry><term><guilabel>Remove Theme</guilabel></term> 102​<varlistentry><term><guilabel>Get New Themes...</guilabel></term>
123<listitem> 103​<listitem>
124<para> 104​<para>
125Clicking this button will remove all files for this theme from your system. A confirmation message is displayed and will ask you if you are really sure you want to remove all the files for this theme. 105​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.
126</para> 106​</para>
127<para> 107​<para>
128<screenshot> 108​<screenshot>
129<screeninfo>Removing A Theme</screeninfo> 109​<screeninfo>Get New Icon Themes</screeninfo>
130 <mediaobject> 110​ <mediaobject>
131 <imageobject> 111​ <imageobject>
132 <imagedata fileref="delete-theme.png" format="PNG"/> 112​ <imagedata fileref="get-new-theme.png" format="PNG"/>
133 </imageobject> 113​ </imageobject>
134 <textobject> 114​ <textobject>
135 <phrase>Removing A Theme</phrase> 115​ <phrase>Get New Icon Themes</phrase>
136 </textobject> 116​ </textobject>
137 </mediaobject> 117​ </mediaobject>
138</screenshot> 118​</screenshot>
139</para> 119​</para>
140<para>Clicking <guibutton>Delete</guibutton> will remove the theme files and clicking <guibutton>Cancel</guibutton> will not delete anything and will cancel the remove action. ​
141</para> ​
142</listitem> 120​</listitem>
143</varlistentry> 121​</varlistentry>
144</variablelist> 122​<varlistentry><term><guilabel>Install from File...</guilabel></term>
145 123​<listitem>
146</sect2> ​
147 ​
148<sect2 id="icons-use"> ​
149<title>Advanced</title> ​
150 ​
151<para>Looking at this second page of the icons control module, you ​
152will see two areas:</para> ​
153 ​
154<itemizedlist> ​
155<listitem> ​
156<para>An area labelled <guilabel>Use of Icon</guilabel>. Here you can ​
157choose which particular usage of icons you want to configure, for ​
158example <guilabel>Toolbar</guilabel> or <guilabel>Panel</guilabel>. ​
159</para> ​
160<para> ​
161<screenshot> ​
162<screeninfo>Choosing the icons to configure</screeninfo> ​
163 <mediaobject> ​
164 <imageobject> ​
165 <imagedata fileref="use-of-icons.png" format="PNG"/> ​
166 </imageobject> ​
167 <textobject> ​
168 <phrase>Choosing the icons to configure</phrase> ​
169 </textobject> ​
170 </mediaobject> ​
171</screenshot> ​
172</para> ​
173</listitem> ​
174 ​
175<listitem> <para>A preview area where you can see how ​
176icons of the selected kind will look using the current ​
177settings. Note that the state of this preview also depends on the icon ​
178state selected in the effects below (do not worry ​
179about that now, we will explain that below). </para> </listitem> ​
180</itemizedlist> ​
181 ​
182<para>When you want to configure icons, first select the usage of icons ​
183you want to configure. Change the settings until you like the ​
184preview. You can then choose a different icon usage and configure ​
185that. At the end, if you are satisfied with your settings, click ​
186<guibutton>OK</guibutton> or <guibutton>Apply</guibutton> to take the ​
187changes in effect.</para> ​
188 ​
189<para>There are two further options to consider, ​
190<guilabel>Size</guilabel> and <guilabel>Effects</guilabel>. </para> ​
191 ​
192<sect3 id="icons-use-size"> ​
193<title>Icon Size</title> ​
194 ​
195<para> 124​<para>
196<screenshot> 125​If you dowloaded new themes from the internet, you can use this to browse to the
197<screeninfo>Setting icons sizes</screeninfo> 126​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>
198 <mediaobject> ​
199 <imageobject> ​
200 <imagedata fileref="size.png" format="PNG"/> ​
201 </imageobject> ​
202 <textobject> ​
203 <phrase>Setting icons sizes</phrase> ​
204 </textobject> ​
205 </mediaobject> ​
206</screenshot> ​
207</para> ​
208 ​
209<para>You can choose ​
210from a list of icon sizes. The largest icon sizes are especially useful ​
211for visually impaired people.</para> ​
212 ​
213<para>Which sizes will be offered by the icon size listbox depends on ​
214the icon theme you have selected in the icon themes control module. For ​
215example, the low color icon theme only offers the sizes 16 and 32 for ​
216desktop icons and 16, 22 and 32 for toolbar icons. The HiColor theme ​
217offers icon sizes 16, 32 and 48 as well as sizes from 64 to 128. ​
218However, as &plasma; can not have all these icon sizes in store, icons ​
219using size 64 to 128 will be automatically generated which may result in ​
220a loss of quality.</para> ​
221 ​
222<para>You can also choose animated icons. Many of the icons have ​
223animations associated with them. Enable the checkbox labelled ​
224<guilabel>Enable icon animations</guilabel>, to enable this effect, but note ​
225that it may appear slow or jerky if your graphics card is old or you ​
226are low on memory.</para> ​
227 ​
228</sect3> ​
229 127​
230<sect3 id="icons-use-effects"> 128​<para>Clicking <guibutton>Open</guibutton> in this dialog will install the theme you pointed to and make it available in the theme list.
231<title>Effects</title> ​
232<para> ​
233<screenshot> ​
234<screeninfo>Setting icons effects</screeninfo> ​
235 <mediaobject> ​
236 <imageobject> ​
237 <imagedata fileref="effects.png" format="PNG"/> ​
238 </imageobject> ​
239 <textobject> ​
240 <phrase>Setting icons effects</phrase> ​
241 </textobject> ​
242 </mediaobject> ​
243</screenshot> ​
244</para> 129​</para>
245 ​
246<para>Finally you can configure certain <quote>filters</quote> to be ​
247applied on icons which are in one of three states:</para> ​
248 ​
249<variablelist> ​
250<varlistentry> ​
251<term><guilabel>Default</guilabel></term> ​
252<listitem><para>This is how the icon will look normally.</para></listitem> ​
253</varlistentry> ​
254<varlistentry> ​
255<term><guilabel>Active</guilabel>:</term> ​
256<listitem><para>This is how the icon will look when the mouse cursor is over the icon.</para></listitem> ​
257</varlistentry> ​
258<varlistentry> ​
259<term><guilabel>Disabled</guilabel>:</term> ​
260<listitem><para>This is how the icon will look if its corresponding action is ​
261disabled, &ie; clicking on it will not lead to any ​
262result.</para></listitem> ​
263</varlistentry> ​
264</variablelist> ​
265 ​
266<para>Select one of these states, and press the <guibutton>Set ​
267Effect...</guibutton> button to configure a corresponding icon effect. ​
268Please note that this configuration will only affect icons of the ​
269currently selected <guilabel>Use of Icon</guilabel> category (see ​
270above): configuring an effect for active icons, while ​
271<guilabel>Toolbar</guilabel> icon usage is selected, will ​
272<emphasis>not</emphasis> affect active icons used in other ​
273places.</para> ​
274 ​
275<para>Below the list of icon states there are two options: you can ​
276configure an effect and you can select the ​
277<guilabel>Semi-transparent</guilabel> option, which will make the ​
278background <quote>shine through</quote> the icon. To the right of the ​
279effects list box there is a slider button to pass additional parameters to ​
280a filter for colours and <guilabel>Amount</guilabel>.</para> ​
281<!-- TODO: Figure out what 'amount' really means --> ​
282 ​
283<para>The following effects can be applied to icons:</para> ​
284 ​
285<variablelist> ​
286<varlistentry> ​
287<term><guilabel>No Effect</guilabel>:</term> ​
288<listitem><para>Icons will be used without applying any ​
289effect.</para></listitem> ​
290</varlistentry> ​
291<varlistentry> ​
292<term><guilabel>To Gray</guilabel>:</term> ​
293<listitem><para>This filter will apply a grayish look to the icon. Use the ​
294<guilabel>Amount</guilabel> slider to configure the intensity of this filter. Note ​
295that it is customary for most user interfaces to use this effect for disabled ​
296icons only.</para></listitem> ​
297</varlistentry> ​
298<varlistentry> ​
299<term><guilabel>Colorize</guilabel>:</term> ​
300<listitem><para>Icons will be colorized using a custom color. For example, you ​
301may configure active icons (&ie; the icon the mouse cursor is over) to ​
302shine golden. Use the color buttons and the <guilabel>Amount</guilabel> slider ​
303to configure the used color and the intensity of the colorization.</para></listitem> ​
304</varlistentry> ​
305<varlistentry> ​
306<term><guilabel>Gamma</guilabel>:</term> ​
307<listitem><para>A different gamma value will be applied to all icons. If you're ​
308no photographer and don't know what Gamma is: it's quite similar to what people ​
309call contrast. Just play around with the gamma settings by moving the ​
310<guilabel>Amount</guilabel> slider to get a feeling for this ​
311effect.</para></listitem> ​
312</varlistentry> ​
313<varlistentry> ​
314<term><guilabel>Desaturate</guilabel>:</term> ​
315<listitem><para>Icons will be drawn desaturated. This is quite similar to the ​
316<quote>Color</quote> setting on your television. Use the slider to configure ​
317the amount of desaturation. ​
318</para></listitem> ​
319</varlistentry> ​
320<varlistentry> ​
321<term><guilabel>To Monochrome:</guilabel></term> ​
322<listitem> ​
323<para>Icons will be drawn using only the two colours selected.</para> ​
324</listitem> 130​</listitem>
325</varlistentry> 131​</varlistentry>
326 ​
327</variablelist> 132​</variablelist>
328 133​
329</sect3> ​
330 ​
331</sect2> ​
332 ​
333</sect1> ​
334 ​
335</article> 134​</article>
Context not available.