Improve a few UI items and their corresponding documentation #1014

brandelune · 2024-04-27T23:13:44Z

<!-- Note: The OmegaT project uses GitHub pull requests for code review only.
The "real" code base is hosted on SourceForge; the GitHub project is a mirror.

If your PR is accepted it will be applied to the SourceForge repository by a
core contributor and the PR ticket will be closed. It will appear to have been
"closed without merging" but that is normal. --->

↑ maybe we can remove this part from the template now ?

What does this PR change?

The PR improves some UI items that were not finalized for the 6.0 release
It rewords a number of new items

Other information

We need to have a style for error messages, with indication of a subject, a verb, etc. so that have a better understanding of what is going on.

brandelune · 2024-04-27T23:16:17Z

Please review the commits separately and I'll squash all when I commit.
Also, most of the items are portable to 6.0.1. So we'll need to handle that too.

github-actions · 2024-04-27T23:18:09Z

❌ Unit Tests, Quality checks, and Acceptance Tests failed.

Please look a Gradle Scan page for details:
https://gradle.com/s/zj56jrnhwrztm

Kazephil · 2024-04-29T01:34:25Z

Please review the commits separately and I'll squash all when I commit.

I'll try to get started on this today, but my wife has plans to steal most of my free time while she's off today and tomorrow, so the bulk of the commits might not get done before Wednesday, when she's at work 😅

kosivantsov · 2024-04-29T07:32:43Z

doc_src/en/OmegaT_Preferences.xml

The whole shebang about switching from the clear but long "project-specific" to a much more confusing but shorter "local" was the length of the string, IIRC. Now, "locally-defined" is only one character shorter than "project-specific", but still not nearly as clear.

No, it was not the length of the string that brought the modification but the fact that the UI did not have a word for the "default" which is what we call now "global". And that was extremely confusing.

Now we have a clear opposition between "global" and "local" all over the UI.

This modification is not about relabeling all the "local" properties as "locally-defined" but just to remove the confusion that comes from having "local" next to "external" in one item. Maybe the second one is not necessary. And maybe there is a better way to fix what I think is confusing about having "local external things".

I'm fine if you oppose the modification. That's the reason why there is a review. But it was not a "shebang" that we had but quite a few thoughtful exchanges over the course of a few months and I don’t have the feeling that OmegaT is worse off with the modifications that we made to the UI and the extensive work that we did on the manual to clarify everything.

My comment was in no way meant to diminish what had been done, or to object the change. We crossed that bridge, and clarifying things is always good. It was more of an amused general observation, no need to take it so seriously. Sorry for causing a stir-up.

Don’t worry. I’m fine :-) If you think the changes are not necessary, please say so. I don’t mind removing that part of the proposal and I’m OK with proposals that help "unweirden" that label.

This reverts commit fc8e479.

src/org/omegat/Bundle.properties

github-actions · 2024-04-29T16:29:42Z

❌ Unit Tests, Quality checks, and Acceptance Tests failed.

Please look a Gradle Scan page for details:
https://gradle.com/s/zzcvsn25uv2je

doc_src/en/OmegaT_EditorsPanes.xml

Why does GitHub keep changing that single apostrophe if I commit and push from Intellij IDEA?

github-actions · 2024-04-30T04:35:30Z

❌ Unit Tests, Quality checks, and Acceptance Tests failed.

Please look a Gradle Scan page for details:
https://gradle.com/s/hwvevsizoc65i

Kazephil · 2024-04-30T05:08:49Z

src/org/omegat/Bundle.properties


-WF_OPTION_INSERT_AUTHOR_PREFIX=&Name/ID:
+WF_OPTION_INSERT_AUTHOR_PREFIX=Nickname:


I'm not entirely sure about "nickname". It's not wrong, but something about it bugs me a little, though I can't quite put my finger on why. Maybe "alias" would be better?

Given the context, I think line 1772 should probably be:
Enter the alias you want to use to identify your translations in the memory.

("Enter the nickname…" if we decide to keep that.)

Line 1774 then either becomes Alias: or stays as is.

Interestingly, this alias/nickname applies even in non team projects, so this entire section should perhaps be under the General heading, but that's beyond the scope of this specific PR.

Alias is fine. You're correct about the location, but it was a "team" feature before the synchronization thing was implemented.

Kazephil · 2024-04-30T05:41:35Z

OK, I've gone through each individual commit and…

added extra commits to propose additional tweaks,
added a comment to discuss whether further tweaks are necessary, or
did nothing.

The last one simply means that particular commit is fine as is.

On a slightly different note, I just noticed in looking at some of these tweaks that we have a mix of "directory" and "folder". We should probably pick just one of those. If memory serves, "directory" is favoured in Linux, and "folder" is preferred in Windows. Not sure which one macOS tends to use more.

I don't have a strong preference either way, though I suppose that "folder" has the benefit of being a few characters shorter, if that's a consideration. (I haven't checked, but I have a hunch that we have more uses of "folder" than "directory", so keeping the former may be the path of least resistance.)

Kazephil · 2024-04-30T11:44:21Z

↑ maybe we can remove this part from the template now ?

Just noticed this comment.

Indeed. We should remove that!

miurahr · 2024-05-26T21:03:48Z

src/org/omegat/gui/preferences/view/SaveOptionsPanel.java

@@ -56,7 +56,6 @@ private void initComponents() {
        java.awt.GridBagConstraints gridBagConstraints;

        intervalDescriptionPanel = new javax.swing.JPanel();
-        intervalDescriptionTextArea = new javax.swing.JTextArea();


You should not directly edit SaveOptionsPanel.java but you edit it through NetBeans GUI editor.
The change break SaveOptionsPanel.form divert with generated Java code.

It builds properly here. I'm OK with editing things in Netbeans but I asked how to use the GUI Editor in the past and nobody answered.

I remember a question was too general, and I could not say RTBM in public ML for core team.

But I need to say readthedocs of Coding Styles which can be improved to explain clearer.

I don’t know if that's the information I need, but that's the kind of link you could have posted when I asked for information.

Regarding the coding style file, we may need to improve it a bit but I need first to identify the reason why I was stuck.

Thank you for the reference.

Jean-Christophe Helary added 12 commits April 22, 2024 07:54

Reword the saving interval preference UI

7ec4a1a

Reword "Alt+menu item" to open enclosing folder

04cb3b6

Reword the match selection explanations

77e100c

Clarify "history predictions" and "history completions"

6d180f2

If we want break/exception we need radio buttons.

cad2bbf

Rewording for easier reading

79b5544

Change name/ID to nickname

2582538

Change capitalization

332374f

Clarify "local" -> change to "locally defined"

3293fc8

remove ambiguity between word and noun "segment"

2ce553d

Reword to match "remote server"

7663d5a

Reword the authentication new strings

376360b

brandelune added documentation UI labels Apr 27, 2024

brandelune added this to the 6.1.0 (Require Java 11) milestone Apr 27, 2024

brandelune requested review from miurahr, kosivantsov and Kazephil April 27, 2024 23:13

brandelune self-assigned this Apr 27, 2024

kosivantsov reviewed Apr 29, 2024

View reviewed changes

Kazephil added 4 commits April 30, 2024 00:49

Propose minor tweak to UI label

fc8e479

Revert "Propose minor tweak to UI label"

288c361

This reverts commit fc8e479.

Propose minor tweak to UI label (with correct encoding this time)

2a3ace4

Fix weird apostrophe issue caused by IDE.

e703e89

Kazephil reviewed Apr 29, 2024

View reviewed changes

src/org/omegat/Bundle.properties Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

Streamline the rewording for Alt+menu item

e304b89

Kazephil reviewed Apr 30, 2024

View reviewed changes

doc_src/en/OmegaT_EditorsPanes.xml Outdated Show resolved Hide resolved

Kazephil added 2 commits April 30, 2024 13:28

Adjust use of singular/plural

9726be1

Apostrophe… again

cf7d398

Why does GitHub keep changing that single apostrophe if I commit and push from Intellij IDEA?

Tweaks to the rewording tweaks

ebec3c1

Kazephil reviewed Apr 30, 2024

View reviewed changes

Kazephil added 2 commits April 30, 2024 14:15

Apply upper/lowercase changes to correct keys

64acf03

Further tweaks to the rewording

e38172b

Kazephil added 3 commits April 30, 2024 20:56

Apply new suggestion

7eaccde

Change "nickname" to "alias"

6c4e573

Remove mistakenly added .fo file

cb2a676

miurahr requested changes May 26, 2024

View reviewed changes

miurahr mentioned this pull request May 27, 2024

docs_devel: update coding sytles #1042

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve a few UI items and their corresponding documentation #1014

Improve a few UI items and their corresponding documentation #1014

brandelune commented Apr 27, 2024 •

edited

Loading

brandelune commented Apr 27, 2024

github-actions bot commented Apr 27, 2024

Kazephil commented Apr 29, 2024

kosivantsov Apr 29, 2024

brandelune Apr 29, 2024

kosivantsov Apr 29, 2024

brandelune Apr 29, 2024

This comment was marked as resolved.

github-actions bot commented Apr 29, 2024

github-actions bot commented Apr 30, 2024

Kazephil Apr 30, 2024 •

edited

Loading

brandelune Apr 30, 2024

Kazephil commented Apr 30, 2024

Kazephil commented Apr 30, 2024

miurahr May 26, 2024

brandelune May 26, 2024

miurahr May 27, 2024

brandelune May 27, 2024


		WF_OPTION_INSERT_AUTHOR_PREFIX=&Name/ID:
		WF_OPTION_INSERT_AUTHOR_PREFIX=Nickname:

Improve a few UI items and their corresponding documentation #1014

Are you sure you want to change the base?

Improve a few UI items and their corresponding documentation #1014

Conversation

brandelune commented Apr 27, 2024 • edited Loading

What does this PR change?

Other information

brandelune commented Apr 27, 2024

github-actions bot commented Apr 27, 2024

Kazephil commented Apr 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

github-actions bot commented Apr 29, 2024

github-actions bot commented Apr 30, 2024

Kazephil Apr 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kazephil commented Apr 30, 2024

Kazephil commented Apr 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brandelune commented Apr 27, 2024 •

edited

Loading

Kazephil Apr 30, 2024 •

edited

Loading