[kde-doc-english] KDE/kdebase/workspace/doc/kcontrol/colors
Arturo Silva
jasilva28 at gmail.com
Wed Sep 2 03:45:29 CEST 2009
Wow, since I rarely use this module (even in the 3.x days), I never realized
how flexible this was.
Perhaps I'm using an old edition of the KDE Help Center (the Colors section
refers to a Revision 3.2), but I don't actually see this documentation
anywhere. So either I'm looking in the wrong place, or this revision is
old, or this is a new addition to that document. Either way, I couldn't
compare this to anything preexisting.
Fortunately, I just got done and tried everything as described in the help
document below, and for the most part I understand what is being said. I do
have a few small adjustments I'd like to suggest, if they're not too
unreasonable:
=============================================================================================
=============================================================================================
1 ##################################################################
In the line:
+ a custom scheme.</para>
I would suggest "custom scheme" if possible. The wording "color scheme" as
used in the sentence almost seemed to imply I could take any scheme from the
list (say, Magma), change it to all sorts of wacky colors, and then have
that scheme save permanently with said wacky colors. The reality, however,
is that the color changes will ONLY affect the virtual scheme called
"Current", which will not be permanent unless explicitly saved with the Save
Scheme button.
2 ##################################################################
In the line:
that you save your scheme when you are done.</para>
I would recommend referencing the Scheme tab, as in "save your scheme in the
Scheme tab". It sounds like an obsessive precaution, but it may not be
necessarily obvious to the initiate where the Save Scheme button is.
3 ##################################################################
The entire section from:
+ <para>The <guilabel>Common Colors</guilabel> set, which is displayed
to
+ all, and can only be changed (if needed) by selecting the appropriate
+ set.</para>
...is not technically wrong -- in fact, it's admirably detailed. However,
it does seem like it goes into too great length to explain what Common
Colors is, which, as I would describe it, is merely the "Simple View" of the
Colors tab, whereas the View, Window, Button, Selection and Tooltip combined
make up a kind of "Advanced View".
Perhaps the detail is necessary after all since Common Colors is,
unfortunately, mixed in with the other sets and easy to confuse as one.
Perhaps this is really more of a UI issue, and could be fixed if that color
set dropdown were replaced by a toggle between "Quickly Modify Common
Colors" and "Fine Tune Color Sets", the latter of which would enable the
dropdown with only View, Window, Button, Selection and Tooltip.
But I'm not a dev, so I'll just mention that in passing -- if anything, the
current setup likely has a rhyme-and-reason to it. ^^;
4 ##################################################################
I'm not sure what:
<para>The choice of color role is left to the developer; the above are
guidelines intended to represent typical usage.</para>
...refers to unfortunately. :(
Judging by the symbols, it seems this is only a DIFF from the source
document, so there are likely snippets here and there of unrelated
documentation left over.
5 ##################################################################
In the lines:
+ used to draw the title bar background, borders, and/or
decorations for
+ active window (that is, the one with input focus). Not all
window
I would add the "the" before "active window", so the phrase will read as
"used to draw the title bar background, borders, and/or decorations for the
active window...".
6 ###################################################################
For the section:
+ 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.
I understand what it means, but I can't shake the feeling that "Active
Titlebar" alone sounds a bit broken. But I can't really say that "the
Active Titlebar role" will make it any better. :(
7 ###################################################################
Looking back on the entire section of Window Manager Roles, I can't help but
feel a small contradiction regarding the role of Common Colors, given it
does indeed contain UNIQUE elements not found in View, Window, Button,
Selection, or Tooltip. In reality, there really should be a Window Manager
set too in order for the Common Colors pseudo-set to be true to its name.
But again, this is a dev issue. ;)
=============================================================================================
=============================================================================================
And that concludes my analysis. Sorry for the length, and also for not
actually doing these changes myself, but I don't know how and besides these
are really suggestions only. The last call is yours. ^^b
Thank you for allowing me to use this as my first substantial contribution
to KDE. It's not much, but I hope it's a start. ^___^
Cheers!
--Arturo "C-quel" Silva
On Tue, Sep 1, 2009 at 3:05 PM, Matthew Woehlke <
mw_triad at users.sourceforge.net> wrote:
> SVN commit 1018504 by mwoehlke:
>
> Update color kcm doc based on comments from Burkhard Lück.
>
> Further comments/suggestions welcomed, please send to me and/or k-doc-en.
>
> CCMAIL: kde-doc-english at kde.org
>
>
> M +46 -6 index.docbook
>
>
> --- trunk/KDE/kdebase/workspace/doc/kcontrol/colors/index.docbook
> #1018503:1018504
> @@ -147,18 +147,31 @@
> <title>Colors</title>
>
> <para>The <guilabel>Colors</guilabel> tab allows you to change the colors
> in
> - a color scheme. The <guilabel>Common Colors</guilabel> set, which is
> displayed
> - initially, is not actually a "set" in the sense used by &kde; (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>
> + a 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. You can check your
> changes at any time by pressing <guibutton>Apply</guibutton>. 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 "set" in the sense used by &kde;
> (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, "View Background" 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, "Inactive Text" will change the color
> for
> + all sets <emphasis>except</emphasis> for Selection; there is a separate
> + "Selection Inactive Text" 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>
> +
> <sect3>
> <title>Color Sets</title>
>
> @@ -261,6 +274,32 @@
> <para>The choice of color role is left to the developer; the above are
> guidelines intended to represent typical usage.</para>
> </sect3>
> +
> + <sect3>
> + <title>Window Manager Roles</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 —
> + used to draw the title bar background, borders, and/or decorations
> for
> + 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 —
> + 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>
> + </sect3>
> +
> </sect2>
>
> <sect2 id="color-effects">
> @@ -350,6 +389,7 @@
> slider produces no change, while maximum causes the text to completely
> disappear into the background.</para>
> </sect3>
> +
> </sect2>
>
> </sect1>
> _______________________________________________
> kde-doc-english mailing list
> kde-doc-english at kde.org
> https://mail.kde.org/mailman/listinfo/kde-doc-english
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.kde.org/pipermail/kde-doc-english/attachments/20090901/d209541d/attachment.htm
More information about the kde-doc-english
mailing list