GUI: Improve Connect Dialog help texts#2121
Conversation
pljones
force-pushed
the
feature/connect-dialog-help-improvements
branch
from
15ca137 to
adf6b27
Compare
gilgongo
left a comment
gilgongo
left a comment
There was a problem hiding this comment.
I think one day we could do with reviewing all this UI help. Some of it could benefit from being a bit more informative I think - eg "Use the Directory dropdown change directory" is rather ... thin :-)
pljones
force-pushed
the
feature/connect-dialog-help-improvements
branch
from
adf6b27 to
789c864
Compare
pljones
force-pushed
the
feature/connect-dialog-help-improvements
branch
from
789c864 to
86978ae
Compare
| QString().setNum ( DEFAULT_PORT_NUMBER ) + | ||
| tr ( ". The field will " | ||
| "also show a list of the most recently used server addresses." ); | ||
| "address or URL using a colon as a separator, e.g, %1. " |
There was a problem hiding this comment.
Should we include something about literal IPv6 addresses here? Because it contains colons, a literal IPv6 address must be enclosed in [ ], and any optional :port added after the ].
There was a problem hiding this comment.
We should also add that into the docs too. Will give that a go. As to the text, what's the %1 variable here (I'm on a Mac and the help text isn't showing...)? If it's jamulus.example.com:22124 then maybe have jamulus.example.com:22124 (Note: IPv6 addresses must be enclosed in square brackets)
There was a problem hiding this comment.
Personally, I'd rather keep it short and simple here, with the documentation for IPv6 providing the cases where something specific must be provided. It's already a bit long...
There was a problem hiding this comment.
Putting the cursor into the Server Address field and pressing Shift-F1 on my Linux build gives
Right-click, choose What's This? on the "Server Address" label gives the same text (of course).
Shift-F1 on my Windows box:
There was a problem hiding this comment.
Hm. This is why I think all this is due for a re-jig now we have the docs in any case. It should really say something like, "Enter the URL or IP address of any private server you have access to." The help popups should just disambiguate the UI element that's described in the docs (and so that we don't spend efforts keeping the two in sync). But then that would apply to all of them, so that's not part of this ticket. I'd just leave it for now and I'll put the IPv6 thing in the docs.
gilgongo
left a comment
gilgongo
left a comment
There was a problem hiding this comment.
Yes - I think we should do a general review of all of the UI help text at some point though.
hoffie
changed the title
3 participants
Short description of changes
Improvements to the Connect dialog help
Context: Fixes an issue?
Fixes some misalignment between display names and help text, adds some help text and updates descriptions to cover "new" functionality.
Does this change need documentation? What needs to be documented and how?
Translations will need updating.
Status of this Pull Request
Ready to merge but please review for style (maybe "client connection" doesn't need to mention "client", etc).
What is missing until this pull request can be merged?
Ready to merge.
Checklist