Please document colors.tdesktop-theme better.

[jjvvx]

I can't tell you how many things I've come across programs that have such flexible styling options but just document said feature poorly if at all. It would really be nice to get a small wiki page or something that broke down what each color option affected/did.

[auchri]

You can edit the wiki or make a PR

[jjvvx]

The problem is I shouldn't have to. They made the feature and it's their job as maintainers of an application to properly document it since they are the ones most familiar with the software under the hood.

[danielytics]

How can @joaquin-v edit the wiki or make a PR if (s)he doesn't understand the styling options because... they're not properly documented? We can improve documentation if we understand what its documenting, but if not, then the authors have to do so.

[john-preston]

@gudvinr Nice looking one here:

If you are trying to create a new theme, take a look to SolidDark theme: https://github.com/MasterGroosha/telegram-soliddark-theme/blob/master/colors.tdesktop-theme

It's a nice example with:

— Documented attributes.
— Separated by sections.
— Global color variables.

[ADTC]

Created Wiki (blank at this moment): https://github.com/telegramdesktop/tdesktop/wiki/Theme-Reference

Thanks for the reference @john-preston I can use it as a starting point.

[dulnan]

Not sure if this has been done before, but here's a theme with random, unique colors (which are also as far apart from each other as possible). Apply it, color pick something and then search for that HEX value to see what attribute matches.

https://gist.github.com/dulnan/323b4d14f15c295c6d92612624fb971e

[ADTC]

@john-preston I just made the table in the wiki using your link as a base. The documentation is lacking though. Also, what I plan to add in the Illustration column is a tiny screenshot showing exactly what component that color will apply to. But I think it may not be necessary if the Description column can pinpoint it using words.

@dulnan Is every color in the 391 chosen colors shown somewhere in the screenshot?

[dulnan]

@ADTC I did not verify if all theme attributes are actually being used. There's a lot of attributes that are so super specific, I was not able to find out where exactly that color is being used in the application. The "theme preview" screenshot covers only a handful of the colors.

[ADTC]

If you can help fill out the missing descriptions that will be great. I'll work on the screenshots when I get some free time (my life is often quite busy). I need to redo some screenshots as I realized the identifier color was mistakenly used for multiple elements (due to aliasing).

[MasterGroosha]

I think this commit (ed4b9bc) will satisfy you :)
Now all strings are commented.

[ADTC]

Thank you, I have updated to the official descriptions. The following do not have any description though:

• historySystemBg
• historySystemBgSelected
• historySystemFg
• searchedBarBorder

[MasterGroosha]

These strings have disappeared from colors file.

[ADTC]

Yes, apparently so. Does that mean they are no longer used? Anyway I have removed them.

PS: For anyone reading to the end, this is now documented in the wiki: https://github.com/telegramdesktop/tdesktop/wiki/Theme-Reference

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.