Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Internal colors names renamed: their old names should still be provided #68

Closed
dbitouze opened this issue May 12, 2019 · 3 comments
Closed

Comments

@dbitouze
Copy link
Contributor

With version 4.20 of tcolorbox, internal colors names: tcbcolframe, tcbcolback, tcbcolbacktitle, tcbcolbacklower, tcbcolupper, tcbcollower, tcbcoltitle have been renamed.

IMHO, their old legacy names (containing an @) should still be provided, since some users (for instance me :) used them, getting inspiration from some examples of the tcolorbox' documentation, e.g. currently the one page 165 that contains \path[fill=tcbcolback!30!black].

@T-F-S
Copy link
Owner

T-F-S commented May 13, 2019

Typically, I hesitate very much to change a documented feature. But, the color names never were documented (even if used in one example).

Since Request 55, I thought about making the names official.

To keep the old names and just document them would have been one option. Finally, I droped this idea because the naming should clearly indicate the official nature. If an @ is part of the name, a macro or name or feature is internal and due to be changed in future. It may be used by users, but they have to be prepared to adapt code in future.

Still, I also hesitate to change internal macros and names, because every change to do something good may imply some unwanted side effects. In this case, I decided to change the names even if I am forced to change some applications of myself - or you or others. Keeping the old names as deprecated for some time would just shift the time of adaption.

For all internal color names, just the @ was removed. So, the adaption of affected user code can be done by a simple text replacement:

Replace tcbcol@ by tcbcol

This should do the trick. I've done it with several of my own applications.

I hope I did not cause too much trouble with this change. This good side is that color names are now official and (hopefully) never change in future.

@dbitouze
Copy link
Contributor Author

If an @ is part of the name, a macro or name or feature is internal and due to be changed in future. It may be used by users, but they have to be prepared to adapt code in future.

I agree but, because these names came up from the deep, usually a secret place of gods, through the tcolorbox's documentation, poor common mortals as us dared to use them, unconscious of the potential dangers :)

@nigeder
Copy link

nigeder commented Aug 10, 2021

oh,poor me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants