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

Normalize casing in UI text in English #3363

Closed
wetneb opened this issue Nov 26, 2020 · 31 comments · Fixed by #4172
Closed

Normalize casing in UI text in English #3363

wetneb opened this issue Nov 26, 2020 · 31 comments · Fixed by #4172
Assignees
Labels
Good First Issue Indicates issues suitable for newcomers to design or coding, providing a gentle introduction. Module: Frontend These issues involve working on HTML, CSS, and JavaScript code that affects the user interface. Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements.
Milestone

Comments

@wetneb
Copy link
Member

wetneb commented Nov 26, 2020

We do not use a consistent casing throughout the UI.
For instance, in the "Export" menu:

  • "Custom tabular exporter" versus "SQL Exporter"

In the "SQL Exporter" dialog:

  • "Output empty row (i.e. all cells null)" vs "Trim Column Names"

Expected Behavior

We should consistently use lowercase since that is what is used in most places so far.

To solve this issue

Simply go through the existing translation files (in English) and normalize the phrases with incorrect casing.

@wetneb wetneb added Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements. Module: Frontend These issues involve working on HTML, CSS, and JavaScript code that affects the user interface. Good First Issue Indicates issues suitable for newcomers to design or coding, providing a gentle introduction. labels Nov 26, 2020
@allanaaa
Copy link
Contributor

sql

Thanks for this. Just want to mention an example: "Drop Statement" should become "DROP statement"

@steve-kasica
Copy link
Contributor

This seems like a good issue to tackle as I get familiar with the UI code. I could probably resolve it sometime this week.

@thadguidry
Copy link
Member

Great Steve! Go for it! Appreciate all the help we can get on our issues and roadmap!

@leoshrey
Copy link
Contributor

I would like to tackle it, if @swkasica not proceeding...

@steve-kasica
Copy link
Contributor

@leoshrey I am proceeding.

@leoshrey
Copy link
Contributor

Sure thing, please go ahead.

@steve-kasica
Copy link
Contributor

Quick update: I'm about halfway through. End of term stuff took longer than I anticipated. Grammar is kind of tricky in UI because in addition to the normal rules of grammar and usage, there's UX specific conventions. I'm adapting these guidelines from Firefox UX on when to use different capitalization styles: title case, sentence, case, all caps, lowercase, camel case, etc...

@SmritiSharmaBG
Copy link

Hello, I am new to Open Source. I want to know if this bug is fixed? If it is fixed and merged then why is it still showing up in Issues section? If not, then can I start to work on it? Any help/feedback will be appreciated. Thankyou :)

@wetneb
Copy link
Member Author

wetneb commented Jan 30, 2021

We should ask @swkasica first, to see if he is still working on this.

@steve-kasica
Copy link
Contributor

Hi all,

Sorry I haven't had time to work on this issue this month. Academic stuff has consumed all my time. To boot, my computer died a week ago and I don't have a way of running OpenRefine 😢. But I will have more free time by February 4th (and hopefully a real computer too 🤞).

@SmritiSharmaBG, please feel free to work on this issue but keep me in the loop because I have done a bit of work addressing this issue. I think it requires a bit more thought than just changing the specific examples pointed out in this thread. OpenRefine currently doesn't have a set of guidelines on capitalization. So I was creating some based on the guidelines from the Firefox UX, and implementing these rules throughout the entire interface in English. These fixed the issues mentioned above, but also other areas of the interface where casing isn't consistent.

@pvcodes-zz
Copy link

Hi @wetneb, Is anyone working on this issue right now?

@wetneb
Copy link
Member Author

wetneb commented Feb 14, 2021

@pvcodes what is your guess, based on the discussion above and the assignee of this issue?

@pvcodes-zz
Copy link

Yeah! I think @SmritiSharmaBG on it.

@wetneb
Copy link
Member Author

wetneb commented May 4, 2021

I am clearing assignees to signal that this issue could be worked on.

@pvcodes-zz
Copy link

pvcodes-zz commented May 6, 2021

@weblate Now I think it is open?

@wetneb
Copy link
Member Author

wetneb commented May 6, 2021

@pvcodes it's all yours!

@pvcodes-zz
Copy link

@wetneb So basically, I have to change the all casing to lower case for example: in SQL Exported there is a checkbox of Include 'IF EXISTS' in DROP statement I have to change it to Include 'if exists' in drop statement
Also could you please tell me where these statements are present, i.e., in which file or folder

@ostephens
Copy link
Member

@pvcodes I think you've picked an example there that should not be changed. "IF EXISTS" and "DROP" are deliberately capitalised in that case because this is the usual way of writing these statements in SQL.

This is a case of checking each individual situation and making a decision - there is no single rule that can be applied across the board. The initial examples given by @wetneb are good and changes like this should be made:

SQL Exporter -> SQL exporter
Trim Column Names -> Trim column names

@swkasica also mentioned the Firefox guidelines https://design.firefox.com/photon/copy/capitalization.html which may help guide the work.

I think the general rule you can work to is "lowercase should be used except where there is a good reason for capitalisation" which is what the Firefox guidelines describe as "Sentence case". Good reasons to capitalise could include:

  • Start of sentence
  • Real names
  • Code conventions

pvcodes-zz pushed a commit to pvcodes-zz/OpenRefine that referenced this issue May 7, 2021
@pvcodes-zz
Copy link

Have a look file

@wetneb
Copy link
Member Author

wetneb commented May 7, 2021

it's much easier to discuss your changes if you open a pull request for them, actually :)

@pvcodes-zz
Copy link

Fair enough

@pvcodes-zz
Copy link

Hi, half of it has been done, but due to some reasons I have stop it for 2-3 days, hope you don't mind!

@ostephens
Copy link
Member

No problem

@pvcodes-zz
Copy link

Sorry for the delay! I was an unwanted and unexpected one, I was tested positive and yesterday I'm fully recovered. Now things are coming back on track.

pvcodes-zz pushed a commit to pvcodes-zz/OpenRefine that referenced this issue May 24, 2021
@pvcodes-zz
Copy link

Hi, @wetneb

@wetneb
Copy link
Member Author

wetneb commented May 26, 2021

Hello @pvcodes, how are you doing today? Nice weather, isn't it?

@pvcodes-zz
Copy link

NVM, 😁 I was asking about the commit should I do PR

@wetneb
Copy link
Member Author

wetneb commented May 27, 2021

Please do!

@riteshsoni123
Copy link
Contributor

@wetneb I would like to work on this issue. Can you assign it to me??

@wetneb wetneb assigned riteshsoni123 and unassigned pvcodes-zz Sep 23, 2021
@riteshsoni123
Copy link
Contributor

@wetneb I have a doubt. The changes made by pvcodes-zz is not merged . Is it better to make all the changes as he did and add some more changes of mine or do you want me to start from the beginning??

@wetneb
Copy link
Member Author

wetneb commented Sep 23, 2021

@riteshsoni123 as you prefer! It could make sense to start from #3976 since I have already reviewed that: you should only have to address the review comments there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Indicates issues suitable for newcomers to design or coding, providing a gentle introduction. Module: Frontend These issues involve working on HTML, CSS, and JavaScript code that affects the user interface. Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements.
Projects
None yet
9 participants