Repository navigation
Add remaining 1.3 release features - #119
Conversation
Kayla Cinnamon (cinnamon-msft)
changed the title
|
Docs Build status updates of commit 905ce8f: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Kayla Cinnamon (cinnamon-msft)
changed the title
|
Docs Build status updates of commit 03e49a7: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 3dc0ada: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 128030e: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 0364da3: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit c474aa4: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
|
||
| If you'd like to enter a `wt` command into the command palette, you can do so by starting with the `>` character. This will run the `wt` command in the current window. | ||
|
|
||
| ## Defining commands |
There was a problem hiding this comment.
Honestly, I recommend rewriting this section from the ground up. How about a structure like this:
- Explain what is a plain command:
- simple command:
{ "command": "newTab" } - advanced command
{ "command": { "action": "newTab", "commandline": "pwsh.exe" } } - These are examples of actions you can perform to interact with Windows Terminal. In this case, we're opening a new tab with our default profile with a simple command. The more advanced command opens a new tab with the default profile, but overrides the commandline parameter .
- These commands appear in your command palette with an autogenerated name, if one exists. More complicated commands do not have an autogenerated name.
- simple command:
- Adding a key binding shortcut:
- if you find yourself using a command a lot, you can bind it to a key chord by adding the
"keys"key to your json. It will look like this{ "command": "newTab", "keys": "ctrl+t" }. - Windows Terminal will still try to autogenerate a name for you, so it can be invoked in the command palette. We even display the associated key binding when it appears in the command palette. <include picture/gif>
- if you find yourself using a command a lot, you can bind it to a key chord by adding the
- Customizing the command palette entry:
- You can also add...
"name": to override the autogenerated name. Set to null to remove from the command palette."icon": to make the command stand out more in your command palette- <include picture/gif>
- You can also add...
There was a problem hiding this comment.
Note: don't forget to probably update the key bindings page too. We have "keys" as required. So now it technically isn't?
There was a problem hiding this comment.
I don't disagree with Carlos here.
|
|
||
| ### Nested commands | ||
|
|
||
| Nested commands let you invoke multiple commands with just one command. These will appear as single items in the command palette and can be invoked with one key binding. This can be done with the following syntax: |
There was a problem hiding this comment.
This is a great example of a command that does not have an autogenerated name. I'd create an example that looks cool, visually. Either open a few panes and send input to a few of them along they way. Or a simple one would be to just open the settings.json and the defaults.json.
|
|
||
| ### Iterable commands | ||
|
|
||
| Iterable commands let you iterate over an array defined in your settings.json file. Possible arrays to iterate over include `profiles` and `schemes`. These will create individual items in the command palette, one for each iteration. Below is an example of iterating over each profile and creating a new tab for each one. |
There was a problem hiding this comment.
I'd break this up into an example/section for profiles and another for scheme. My first question from reading this is "what properties can I access from a profile as opposed to a scheme?". It'd be nice if you provided a picture of the results that appear in the command palette from this.
Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>
Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>
|
Docs Build status updates of commit eafb007: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 022c61b: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>
Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>
|
Docs Build status updates of commit 0eea38e: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit eac4314: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit fda2bc1: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 1d75e22: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Mike Griese (zadjii-msft)
left a comment
Mike Griese (zadjii-msft)
left a comment
There was a problem hiding this comment.
ah shoot I see you bumped the PR while I was reviewing. This might already be out-of-date
|
|
||
| :::column-end::: | ||
| :::column span=""::: | ||
|
|
There was a problem hiding this comment.
Is there supposed to be a gif here?
There was a problem hiding this comment.
Yeah it's still on the issue checklist. I'll be creating gifs tonight.
|
|
||
| If you'd like to enter a `wt` command into the command palette, you can do so by starting with the `>` character. This will run the `wt` command in the current window. | ||
|
|
||
| ## Defining commands |
There was a problem hiding this comment.
I don't disagree with Carlos here.
|
|
||
| If you'd like to enter a `wt` command into the command palette, you can do so by starting with the `>` character. This will run the `wt` command in the current window. | ||
|
|
||
| ## Defining commands |
There was a problem hiding this comment.
At no point do we explain where commands come from in the file.
We probably need to add a paragraph that covers something like:
Commands are automatically generated for each of the actions in your
keybindings, when possible. If you'd like to add other commands to the command palette, you can do it like (this).
and make sure we specifically show that the commands are getting added to keybindings
|
Docs Build status updates of commit 486abea: ✅ Validation status: passed
TerminalDocs/panes.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit d3c7454:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| TerminalDocs/command-palette.md | View | Details | |
| TerminalDocs/TOC.yml | ✅Succeeded | View | |
| TerminalDocs/command-line-arguments.md | ✅Succeeded | View | |
| TerminalDocs/customize-settings/global-settings.md | ✅Succeeded | View | |
| TerminalDocs/customize-settings/key-bindings.md | ✅Succeeded | View | |
| TerminalDocs/customize-settings/profile-settings.md | ✅Succeeded | View | |
| TerminalDocs/panes.md | ✅Succeeded | View |
TerminalDocs/command-palette.md
- Line 59, Column 0: [Warning-hard-coded-locale]
Link 'https://docs.microsoft.com/en-us/windows/uwp/design/style/segoe-ui-symbol-font' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.
Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching in the Docs contributor and Admin Guide
- See the frequently asked questions
- Post your question in the Docs support channel
|
Docs Build status updates of commit d43f817: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 7b9e37d: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit cf82dd6: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit b21b4cf: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Mike Griese (zadjii-msft)
left a comment
Mike Griese (zadjii-msft)
left a comment
There was a problem hiding this comment.
I'm only blocking on the one $ typo - otherwise this is good to go
|
Docs Build status updates of commit 776b19f: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Mike Griese (zadjii-msft)
left a comment
Mike Griese (zadjii-msft)
left a comment
There was a problem hiding this comment.
Oh look, I can commit suggestions in PRs on this repo. Ignore my previous block. This is good to go.
Add the rest of the features listed here: #117
Closes #117