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

[MU4 Issue] Change "Frame" (in Properties panel) to "Border" (to avoid confusion with layout frame) #15534

Open
rgreen5 opened this issue Dec 23, 2022 · 7 comments
Assignees
Labels
community Issues particularly suitable for community contributors to work on good first issue Issues suitable for first-time contributors. See https://github.com/musescore/MuseScore/contribute P3 Priority: Low strings Affects translatable strings

Comments

@rgreen5
Copy link

rgreen5 commented Dec 23, 2022

Describe the issue

"Frame" is used in two different contexts in the program UI. Firstly in the context of text/vertical/horizontal frames; and secondly as a property in the "Text" section of properties. This is potentially confusing for users and forces a workaround in the documentation.

IMV, a solution is to change the word "Frame" in the "Properties" panel to "Border". This would remove the ambiguity, and free up the word "Frame" for exclusive use as a layout device.

@Tantacrul Tantacrul added the P3 Priority: Low label Feb 22, 2023
@Tantacrul
Copy link
Contributor

Makes sense to me.

@cbjeukendrup cbjeukendrup moved this to In the further future in MuseScore Studio Backlog May 19, 2024
@cbjeukendrup cbjeukendrup added strings Affects translatable strings good first issue Issues suitable for first-time contributors. See https://github.com/musescore/MuseScore/contribute community Issues particularly suitable for community contributors to work on labels Aug 19, 2024
@Gustavo-Ando
Copy link

Hey! I saw this was labeled as a good first issue and I am hoping to contribute.
I have some questions: should I only change the name from frame to border in the UI or should I also internally change it in the codebase? Also, there exists something called frameBorderColor, if I were to rename it to border it would become borderBorderColor and I think this would only further the confusion.

image

@Tantacrul
Copy link
Contributor

I have some questions: should I only change the name from frame to border in the UI or should I also internally change it in the codebase? Also, there exists something called frameBorderColor, if I were to rename it to border it would become borderBorderColor and I think this would only further the confusion.

I'd make sure those definitions refer to the text border and not other kinds of frame. If they refer strictly to the text border, then I'd suggest textBorder textBorderColor, although I think @cbjeukendrup would be best to decide on this, since he'll have a better sense of the right naming conventions to use.

You can then submit the PR and someone will check the names to make sure they make sense.

@Jojo-Schmitz
Copy link
Contributor

For now I've fixed it in the trantions, en_US, en_GB and de, and left this on Transifex:
STRING INSTRUCTIONS
This particular one describes the frame or border around a text, in a text's properties, and not any of the frames from the layout palette

@cbjeukendrup
Copy link
Contributor

In this case updating the terminology in the code too seems good to me.

Probably the new names should be something like this:

  • m_frameType -> m_borderType
  • m_bgColor -> m_backgroundColor
  • m_frameColor -> m_borderColor
  • m_frameWidth -> m_borderThickness (or m_borderWidth, to be in line with CSS? But "width" suggests something horizontal, which is confusing in many contexts, so therefore I don't prefer it)
  • m_paddingWidth -> m_borderPadding (or just m_padding?)
  • int m_frameRound -> double m_borderRadius

and of course all related things too, like the getters/setters and Pids.

For the UI names, I suggest the following:
Scherm­afbeelding 2024-11-14 om 00 18 37
Or should it be just "Color" instead of "Border color"?

Also, the names of the corresponding settings in Format > Style > Text styles should of course be updated too; note that those use "highlight" instead of "fill color", but I think "fill color" (like in Properties) is more accurate.

@Jojo-Schmitz
Copy link
Contributor

Jojo-Schmitz commented Nov 14, 2024

OK, I've fixed the translations for those to (for en_US, en_GB and de), to "Border color" rep. "Fill color", corresponding string instructions already existed

@cbjeukendrup
Copy link
Contributor

@Gustavo-Ando Are you still planning to work on this issue? Please let us know if you need any more information!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Issues particularly suitable for community contributors to work on good first issue Issues suitable for first-time contributors. See https://github.com/musescore/MuseScore/contribute P3 Priority: Low strings Affects translatable strings
Projects
Status: Available
Status: In the further future
Development

No branches or pull requests

5 participants