Dialogue to show all keyboard shortcuts #5849

Chips1234 · 2020-05-11T19:13:12Z

Summary of the Pull Request

Adds a dialogue that shows all keyboard shortcuts. If I'm missing anything, feel free to share!

References

Connected to #4695.

PR Checklist

Closes Feature request: Keyboard shortcut to show all keyboard shortcuts #4695
CLA signed. If not, go over here and sign the CLA
No documents
I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

Detailed Description of the Pull Request / Additional comments

A new dialogue launched by clicking on a new tab menu item.

Syncing fork to repo

…resources) Tooltip Text from Resources.resw Files

…resources)-1 Tooltip Text for New Tab Split Button

Made the dialogue in TerminalPage.xaml. The labels will be in the resw file but not the actual keybinding since I believe that it's the same worldwide.

Chips1234 · 2020-05-11T19:15:57Z

Wait, why are there commits unrelated to this?

zadjii-msft

Overall, looks like a great start.

I'd say the big thing that's missing here is that the dialog only displays a few of the default keybindings. Users could have set any key combination to any number of actions, including disabling these default keybindings. I'd think that the next step in this functionality would be enumerating all of those keybindings that are bound at runtime, and actually filling ShortcutsDialog with those bindings at runtime

github-actions · 2020-05-11T19:21:07Z

New misspellings found, please review:

defult

To accept these changes, run the following commands

remove_obsolete_words=$(mktemp)
echo '#!/usr/bin/perl -ni
my $re=join "|", qw('"
bitfield
Emojis
HREF
memcpying
OUTPATHROOT
textblock
usr
vpack
"');
next if /^($re)(?:$| .*)/;
print;' > $remove_obsolete_words
chmod +x $remove_obsolete_words
for file in .github/actions/spell-check/whitelist/alphabet.txt .github/actions/spell-check/whitelist/web.txt .github/actions/spell-check/whitelist/whitelist.txt; do $remove_obsolete_words $file; done
rm $remove_obsolete_words
(
echo "
defult
"
) | sort -u -f | perl -ne 'next unless /./; print' > new_whitelist.txt && mv new_whitelist.txt '.github/actions/spell-check/whitelist/ce61d8f6be1e1a59ef1ed4ad736cc7ea1cb0b00e.txt'

✏️ Contributor please read this

If the items listed above are names, please add them to .github/actions/spell-check/dictionary/names.txt.
If they're APIs, you can add them to a file in .github/actions/spell-check/dictionary/.
If they're just things you're using, please add them to an appropriate file in .github/actions/spell-check/whitelist/.
If you need to use a specific token in one place and it shouldn't generally be used, you can
add an item in an appropriate file in .github/actions/spell-check/patterns/.

See the README.md in each directory for more information.

⚠️ Reviewers

At present, the action that triggered this message will not show its ❌ in this PR unless the branch is within this repository.
Thus, you should make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

thernstig · 2020-05-11T20:21:33Z

@zadjii-msft Might I ask why you believe user defined keybindings? I'd look at it like a quick way to show default keybindings, to "learn and discover" what one can do. If one wants to see all keybindings it is always possible to open the settings.json file.

Chips1234 · 2020-05-11T20:23:38Z

@zadjii-msft, thus I was asking how to get data from json file to xaml.

github-actions · 2020-05-12T00:22:57Z

New misspellings found, please review:

defult

To accept these changes, run the following commands

remove_obsolete_words=$(mktemp)
echo '#!/usr/bin/perl -ni
my $re=join "|", qw('"
bitfield
Emojis
HREF
memcpying
OUTPATHROOT
textblock
usr
vpack
"');
next if /^($re)(?:$| .*)/;
print;' > $remove_obsolete_words
chmod +x $remove_obsolete_words
for file in .github/actions/spell-check/whitelist/alphabet.txt .github/actions/spell-check/whitelist/web.txt .github/actions/spell-check/whitelist/whitelist.txt; do $remove_obsolete_words $file; done
rm $remove_obsolete_words
(
echo "
defult
"
) | sort -u -f | perl -ne 'next unless /./; print' > new_whitelist.txt && mv new_whitelist.txt '.github/actions/spell-check/whitelist/93cb22dafb49404847ba24b117a3bf2cd2912b5d.txt'

✏️ Contributor please read this

If the items listed above are names, please add them to .github/actions/spell-check/dictionary/names.txt.
If they're APIs, you can add them to a file in .github/actions/spell-check/dictionary/.
If they're just things you're using, please add them to an appropriate file in .github/actions/spell-check/whitelist/.
If you need to use a specific token in one place and it shouldn't generally be used, you can
add an item in an appropriate file in .github/actions/spell-check/patterns/.

See the README.md in each directory for more information.

⚠️ Reviewers

At present, the action that triggered this message will not show its ❌ in this PR unless the branch is within this repository.
Thus, you should make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

src/cascadia/TerminalApp/TerminalPage.cpp

Co-authored-by: Josh Soref <[email protected]>

Chips1234 · 2020-05-16T00:02:09Z

So, I have here a binding that can possibly work. Problem is, I don't know what to put next in the if statement, as I need it to display text. Any help will be appreciated.

winrt::hstring TerminalPage::CopyKeybinding()
    {
       auto keyBindings = _settings->GetKeybindings();
        auto copyKeyCord = keyBindings.GetKeyBindingForAction(ShortcutAction::CopyText);
        if (copyKeyCord)
        {
       }
        return RS_(L"NoCopyData");
    }

Chips1234 · 2020-05-16T22:05:17Z

Another thing, how do I get it so that it can be displayed in const auto form?

Chips1234 · 2020-05-20T17:48:38Z

Well, right now, I just can't get it to display based on settings, but what do you say we implement the default keybindings for now and we can work on getting it to change based on the settings.json file later on?

vadimkantorov · 2020-06-13T11:42:52Z

If there're profile-specific keybindings supported in future, this dialog should also take some decisions about how to react/display to this specificity

Chips1234 · 2020-06-13T18:42:19Z

So is there a way to get the keybinding/profile into string then add it to XAML?

zadjii-msft · 2020-06-15T13:45:46Z

@Chips1234 sorry for the delay - I'm assuming #6487 answered your question?

Chips1234 · 2020-06-15T16:54:18Z

Yes, but how do you get it inside the dialog? As in, how do you get the code into XAML?

zadjii-msft · 2020-06-15T17:00:13Z

Oh so you can just construct the UI element at runtime. Take for example, the context menu on a tab - that's built at runtime in Tab::_CreateContextMenu. Or how we build the errors dialog over in applogic:

terminal/src/cascadia/TerminalApp/AppLogic.cpp

Lines 340 to 382 in 6d2fc5d

    
           void AppLogic::_ShowLoadErrorsDialog(const winrt::hstring& titleKey, 
        
                                                const winrt::hstring& contentKey, 
        
                                                HRESULT settingsLoadedResult) 
        
           { 
        
               auto title = GetLibraryResourceString(titleKey); 
        
               auto buttonText = RS_(L"Ok"); 
        
               Controls::TextBlock warningsTextBlock; 
        
               // Make sure you can copy-paste 
        
               warningsTextBlock.IsTextSelectionEnabled(true); 
        
               // Make sure the lines of text wrap 
        
               warningsTextBlock.TextWrapping(TextWrapping::Wrap); 
        
               winrt::Windows::UI::Xaml::Documents::Run errorRun; 
        
               const auto errorLabel = GetLibraryResourceString(contentKey); 
        
               errorRun.Text(errorLabel); 
        
               warningsTextBlock.Inlines().Append(errorRun); 
        
               warningsTextBlock.Inlines().Append(Documents::LineBreak{}); 
        
               if (FAILED(settingsLoadedResult)) 
        
               { 
        
                   if (!_settingsLoadExceptionText.empty()) 
        
                   { 
        
                       warningsTextBlock.Inlines().Append(_BuildErrorRun(_settingsLoadExceptionText, ::winrt::Windows::UI::Xaml::Application::Current().as<::winrt::TerminalApp::App>().Resources())); 
        
                       warningsTextBlock.Inlines().Append(Documents::LineBreak{}); 
        
                   } 
        
               } 
        
               // Add a note that we're using the default settings in this case. 
        
               winrt::Windows::UI::Xaml::Documents::Run usingDefaultsRun; 
        
               const auto usingDefaultsText = RS_(L"UsingDefaultSettingsText"); 
        
               usingDefaultsRun.Text(usingDefaultsText); 
        
               warningsTextBlock.Inlines().Append(Documents::LineBreak{}); 
        
               warningsTextBlock.Inlines().Append(usingDefaultsRun); 
        
               Controls::ContentDialog dialog; 
        
               dialog.Title(winrt::box_value(title)); 
        
               dialog.Content(winrt::box_value(warningsTextBlock)); 
        
               dialog.CloseButtonText(buttonText); 
        
               dialog.DefaultButton(Controls::ContentDialogButton::Close); 
        
               _ShowDialog(nullptr, dialog); 
        
           }

jsoref · 2020-08-13T09:04:50Z

Right now this PR displays to me as:

@Chips1234 wants to merge 18 commits into microsoft:master from unknown repository

that seems like isaacs/github#168 -- but I'm confused because afaict this PR still exists. Does someone happen to know why it says unknown repository? (Is this related to the PR being a draft?)

zadjii-msft · 2020-08-13T13:36:36Z

@jsoref That's bizarre, I've never seen anything like that before.

jsoref · 2020-08-13T13:51:05Z

@zadjii-msft: I don't suppose you can find someone via the internal directory who could shine some light on this?

zadjii-msft · 2020-08-13T14:00:20Z

Huh, I don't think I've ever actually mailed anyone from Github yet. Kinda forgot that they're under the MSFT umbrella 😅

Cold-emailing random @github.com emails doesn't really seem like it would work to find an appropriate engineer. Maybe @DHowett knows someone?

Chips1234 · 2020-08-13T16:06:27Z

Yes, unfortunately my fork is all messed up and U needed to delete my old one. Sorry, but I have to close this now.

DHowett · 2020-08-13T16:41:40Z

This is very much because the originating fork was deleted.

jsoref · 2020-08-13T20:16:11Z

Interesting. I'm surprised that the link presumes that the repository is this one even though it more or less knows it isn't.

Chips1234 and others added 11 commits April 17, 2020 15:47

Merge pull request #1 from microsoft/master

8a076bc

Syncing fork to repo

Added tooltip text for MinMaxCloseControl

c044f53

Merge pull request #1 from Chips1234/dev/chips1234/tooltip-text(from-…

e96de7e

…resources) Tooltip Text from Resources.resw Files

Tooltip Text for New Tab Split Button

a139c7b

Merge pull request #2 from Chips1234/dev/chips1234/tooltip-text(from-…

62751c1

…resources)-1 Tooltip Text for New Tab Split Button

Merge remote-tracking branch 'upstream/master'

7ff46af

Made the design for the dialog

d368245

Made the dialogue in TerminalPage.xaml. The labels will be in the resw file but not the actual keybinding since I believe that it's the same worldwide.

Update RESW file for dialog items

9cbe1e9

Create Key bindings menu item.

c65bf56

Put in the code for the button

6b490f3

Updated TerminalPage.h

ce61d8f

ghost added Area-UserInterface Issues pertaining to the user interface of the Console or Terminal Issue-Task It's a feature request, but it doesn't really need a major design. Product-Terminal The new Windows Terminal. labels May 11, 2020

zadjii-msft requested changes May 11, 2020

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label May 11, 2020

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label May 11, 2020

Fixed spelling mistake

93cb22d

jsoref reviewed May 12, 2020

View reviewed changes

src/cascadia/TerminalApp/TerminalPage.cpp Outdated Show resolved Hide resolved

Chips1234 and others added 3 commits May 12, 2020 08:42

made the words more grammatically correct

f10f444

Co-authored-by: Josh Soref <[email protected]>

Added more resources

f545b93

Design for more shortcuts

30fc9d0

Chips1234 added 3 commits June 16, 2020 10:38

Added a icon

6ecac69

Construct Dialog from runtime

d5b43a2

Updated Resources

e4c3717

Chips1234 closed this Aug 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dialogue to show all keyboard shortcuts #5849

Dialogue to show all keyboard shortcuts #5849

Chips1234 commented May 11, 2020

Chips1234 commented May 11, 2020

zadjii-msft left a comment

github-actions bot commented May 11, 2020

thernstig commented May 11, 2020

Chips1234 commented May 11, 2020

github-actions bot commented May 12, 2020

Chips1234 commented May 16, 2020 •

edited

Loading

Chips1234 commented May 16, 2020

Chips1234 commented May 20, 2020 •

edited

Loading

vadimkantorov commented Jun 13, 2020

Chips1234 commented Jun 13, 2020

zadjii-msft commented Jun 15, 2020

Chips1234 commented Jun 15, 2020

zadjii-msft commented Jun 15, 2020

jsoref commented Aug 13, 2020

zadjii-msft commented Aug 13, 2020

jsoref commented Aug 13, 2020

zadjii-msft commented Aug 13, 2020

Chips1234 commented Aug 13, 2020

DHowett commented Aug 13, 2020

jsoref commented Aug 13, 2020

Dialogue to show all keyboard shortcuts #5849

Dialogue to show all keyboard shortcuts #5849

Conversation

Chips1234 commented May 11, 2020

Summary of the Pull Request

References

PR Checklist

Detailed Description of the Pull Request / Additional comments

Chips1234 commented May 11, 2020

zadjii-msft left a comment

Choose a reason for hiding this comment

github-actions bot commented May 11, 2020

New misspellings found, please review:

⚠️ Reviewers

thernstig commented May 11, 2020

Chips1234 commented May 11, 2020

github-actions bot commented May 12, 2020

New misspellings found, please review:

⚠️ Reviewers

Chips1234 commented May 16, 2020 • edited Loading

Chips1234 commented May 16, 2020

Chips1234 commented May 20, 2020 • edited Loading

vadimkantorov commented Jun 13, 2020

Chips1234 commented Jun 13, 2020

zadjii-msft commented Jun 15, 2020

Chips1234 commented Jun 15, 2020

zadjii-msft commented Jun 15, 2020

jsoref commented Aug 13, 2020

zadjii-msft commented Aug 13, 2020

jsoref commented Aug 13, 2020

zadjii-msft commented Aug 13, 2020

Chips1234 commented Aug 13, 2020

DHowett commented Aug 13, 2020

jsoref commented Aug 13, 2020

Chips1234 commented May 16, 2020 •

edited

Loading

Chips1234 commented May 20, 2020 •

edited

Loading