Skip to content

Commit

Permalink
Issue resolution updates (#391)
Browse files Browse the repository at this point in the history
* Update to change equal symbol to plus key

Addresses issue #196
*On my Surface Book keyboard + and = are the same key, but this may not be the case for all keyboard layouts.

* change + to plus as shipped by default

* Add notes about title change persistance

* Update settings.json section

* Link settings.json mentions

* Fix links

* fix a few more links

* Update TerminalDocs/customize-settings/actions.md

Co-authored-by: Kayla Cinnamon <[email protected]>

* Update TerminalDocs/dynamic-profiles.md

Co-authored-by: Kayla Cinnamon <[email protected]>

* Update TerminalDocs/customize-settings/actions.md

Co-authored-by: Kayla Cinnamon <[email protected]>

* Remove repititious section

Co-authored-by: Kayla Cinnamon <[email protected]>
  • Loading branch information
mattwojo and cinnamon-msft authored Aug 24, 2021
1 parent 7b81af3 commit 55a79ac
Show file tree
Hide file tree
Showing 20 changed files with 69 additions and 66 deletions.
2 changes: 2 additions & 0 deletions TerminalDocs/command-line-arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Below is the full list of supported commands and options for the `wt` command li
| `focus-tab`, `ft` | `--target, -t tab-index` | Focuses on a specific tab. |
| `move-focus`, `mf` | `direction` | Move focus between panes in the given direction. Accepts one of `up`, `down`, `left`, `right`. |

If you change the title of a tab in Windows Terminal and want that title to persist, you must enable the [suppressApplicationTitle](./customize-settings/actions.md#actions-6) option by setting it to `true`.

> [!NOTE]
> When opening Windows Terminal from cmd (Command Prompt), if you want to use your custom "cmd" profile settings, you will need to use the command `wt -p cmd`. Otherwise, to run your *default* profile settings, just use `wt cmd`.
Expand Down
2 changes: 1 addition & 1 deletion TerminalDocs/command-palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You can add a custom key binding for invoking the command palette in the command

## Adding an icon to a command

You can optionally add an icon to a command defined in your settings.json that appears in the command palette. This can be done by adding the `icon` property to the action. Icons can be a path to an image, a symbol from [Segoe MDL2 Assets](https://docs.microsoft.com/windows/uwp/design/style/segoe-ui-symbol-font), or any character, including emojis.
You can optionally add an icon to a command defined in your [settings.json](./get-started.md#settings-json-file) that appears in the command palette. This can be done by adding the `icon` property to the action. Icons can be a path to an image, a symbol from [Segoe MDL2 Assets](/windows/uwp/design/style/segoe-ui-symbol-font), or any character, including emojis.

```json
{ "icon": "C:\\Images\\my-icon.png", "name": "New tab", "command": "newTab", "keys": "ctrl+shift+t" },
Expand Down
2 changes: 1 addition & 1 deletion TerminalDocs/custom-terminal-gallery/custom-schemes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here are some color schemes for you to try or use as the basis of your own desig

## Installing schemes

Copy the JSON from the **"schemes"** section into the correct section in settings.json, for example:
Copy the JSON from the **"schemes"** section into the correct section in [settings.json](../get-started.md#settings-json-file), for example:

Before:

Expand Down
18 changes: 9 additions & 9 deletions TerminalDocs/customize-settings/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ms.localizationpriority: high
# Custom actions in Windows Terminal

> [!IMPORTANT]
> As of Windows Terminal version 1.4, the `keybindings` array has been renamed to `actions` inside the settings.json file. Support for the `keybindings` array still exists for backward compatibility, however the terminal will not automatically rename `keybindings` to `actions` inside your settings.json file.
> As of Windows Terminal version 1.4, the `keybindings` array has been renamed to `actions` inside the settings.json file. Support for the `keybindings` array still exists for backward compatibility, however the terminal will not automatically rename `keybindings` to `actions` inside your [settings.json file](../get-started.md#settings-json-file).
You can create custom actions inside Windows Terminal that give you control of how you interact with the terminal. These actions will automatically be added to the command palette.

Expand Down Expand Up @@ -198,7 +198,7 @@ This opens the dropdown menu.

### Open settings files

This opens either the settings UI, custom settings file (`settings.json`), or default settings file (`defaults.json`), depending on the `target` field.
This opens either the settings UI, custom settings file ([`settings.json`](../get-started.md#settings-json-file)), or default settings file (`defaults.json`), depending on the `target` field.
Without the `target` field, the custom settings file will be opened.

**Command name:** `openSettings`
Expand Down Expand Up @@ -378,7 +378,7 @@ This creates a new tab. Without any arguments, this will open the default profil
| `index` | Optional | Integer | Profile that will open based on its position in the dropdown (starting at 0). |
| `profile` | Optional | Profile's name or GUID as a string | Profile that will open based on its GUID or name. |
| `colorScheme` | Optional | The name of a color scheme as a string | The scheme to use instead of the profile's set `colorScheme` |
| `suppressApplicationTitle` | Optional | `true`, `false` | When set to `false`, applications can change the tab title by sending title change messages. When set to `true`, these messages are suppressed. If not provided, the behavior is inherited from the profile's settings. |
| `suppressApplicationTitle` | Optional | `true`, `false` | When set to `false`, applications can change the tab title by sending title change messages. When set to `true`, these messages are suppressed. If not provided, the behavior is inherited from the profile's settings. In order to enter a new tab title and have that title persist, this must be set to true. |

### Open next tab

Expand Down Expand Up @@ -1104,12 +1104,12 @@ ways:

The `desktop` and `monitor` properties can be combined in the following ways:

| | `"desktop"` | | |
| -- | --------- | -- | -- |
| **`"monitor"`** | `"any"`<br />**Leave where it is** | `"toCurrent"`<br />**Move to current desktop** | `"onCurrent"`<br />**On current desktop only** |
| `"any"`<br />**Summon the MRU window** | Go to the desktop the window is on (leave position alone) | Move the window to this desktop (leave position alone) | If there isn't one on this desktop:<ul><li>Create a new one in the default position</li></ul>Else:<ul><li>Activate the one on this desktop (don't move it)</li></ul> |
| `"toCurrent"`<br />**Summon the MRU window TO the monitor with the foreground window** | Go to the desktop the window is on, move to the monitor with the foreground window | Move the window to this desktop, move to the monitor with the foreground window | If there isn't one on this desktop:<ul><li>Create a new one</li></ul>Else:<ul><li>Activate the one on this desktop, move to the monitor with the foreground window</li></ul> |
| `"toMouse"`<br />**Summon the MRU window TO the monitor with the mouse** | Go to the desktop the window is on, move to the monitor with the mouse | Move the window to this desktop, move to the monitor with the mouse | If there isn't one on this desktop:<ul><li>Create a new one</li></ul>Else:<ul><li>Activate the one on this desktop, move to the monitor with the mouse</li></ul> |
| Combinations | **`"desktop": "any"`** | **`"desktop": "toCurrent"`**| **`"desktop": "onCurrent"`**| Not included |
| ------------ | ---------------------- | --------------------------- | --------------------------- | ------------ |
| **`"monitor": "any"`**| Go to the desktop the window is on (leave position alone) | Move the window to this desktop (leave position alone) | If there isn't one on this desktop:<ul><li>Create a new one in the default position</li></ul>Else:<ul><li>Activate the one on this desktop (don't move it)</li></ul> | Summon the MRU window |
| **`"monitor": "toCurrent"`**| Go to the desktop the window is on, move to the monitor with the foreground window | Move the window to this desktop, move to the monitor with the foreground window | If there isn't one on this desktop:<ul><li>Create a new one</li></ul>Else:<ul><li>Activate the one on this desktop, move to the monitor with the foreground window</li></ul> | Summon the MRU window TO the monitor with the foreground window |
| **`"monitor": "toMouse"`**| Go to the desktop the window is on, move to the monitor with the mouse | Move the window to this desktop, move to the monitor with the mouse | If there isn't one on this desktop:<ul><li>Create a new one</li></ul>Else:<ul><li>Activate the one on this desktop, move to the monitor with the mouse</li></ul> | Summon the MRU window TO the monitor with the mouse |
| **Not included** | Leave where it is | Move to current desktop | On current desktop only | N/A |

#### Examples

Expand Down
2 changes: 1 addition & 1 deletion TerminalDocs/customize-settings/appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# Appearance settings in Windows Terminal

The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your settings.json file.
The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your [settings.json file](../get-started.md#settings-json-file).

## Language ([Preview](https://aka.ms/terminal-preview))

Expand Down
4 changes: 2 additions & 2 deletions TerminalDocs/customize-settings/color-schemes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# Color schemes in Windows Terminal

Windows Terminal lets you define your own color schemes, either by using the built-in preset schemes, or by creating your own scheme from scratch. To change schemes, you'll need to edit the settings.json file in an editor such as [Visual Studio Code](https://code.visualstudio.com/).
Windows Terminal lets you define your own color schemes, either by using the built-in preset schemes, or by creating your own scheme from scratch. To change schemes, you'll need to edit the [settings.json file](../get-started.md#settings-json-file) in an editor such as [Visual Studio Code](https://code.visualstudio.com/).

## Switching to a different color scheme

Expand Down Expand Up @@ -39,7 +39,7 @@ Notice the extra comma in the **hidden** line. Once you save this file, Windows

The "Tango Light" scheme is included as a default option, but you can create your own scheme from scratch or by copying an existing scheme.

Color schemes can be defined in the `schemes` array of your settings.json file. They are written in the following format:
Color schemes can be defined in the `schemes` array of your [settings.json file](../get-started.md#settings-json-file). They are written in the following format:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion TerminalDocs/customize-settings/interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# Interaction settings in Windows Terminal

The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your settings.json file.
The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your [settings.json file](../get-started.md#settings-json-file).

## Automatically copy selection to clipboard

Expand Down
2 changes: 1 addition & 1 deletion TerminalDocs/customize-settings/profile-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# Advanced profile settings in Windows Terminal

The settings listed below are specific to each unique profile. If you'd like a setting to apply to all of your profiles, you can add it to the `defaults` section above the list of profiles in your settings.json file.
The settings listed below are specific to each unique profile. If you'd like a setting to apply to all of your profiles, you can add it to the `defaults` section above the list of profiles in your [settings.json file](../get-started.md#settings-json-file).

```json
"defaults":
Expand Down
2 changes: 1 addition & 1 deletion TerminalDocs/customize-settings/profile-appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# Appearance profile settings in Windows Terminal

The settings listed below are specific to each unique profile. If you'd like a setting to apply to all of your profiles, you can add it to the `defaults` section above the list of profiles in your settings.json file.
The settings listed below affect the visual settings of each profile separately. If you'd like a setting to apply to all of your profiles, you can add it to the `defaults` section above the list of profiles in your [settings.json file](../get-started.md#settings-json-file).

```json
"defaults":
Expand Down
6 changes: 3 additions & 3 deletions TerminalDocs/customize-settings/profile-general.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# General profile settings in Windows Terminal

The settings listed below are specific to each unique profile. If you'd like a setting to apply to all of your profiles, you can add it to the `defaults` section above the list of profiles in your settings.json file.
The settings listed below are specific to each unique profile. If you'd like a setting to apply to all of your profiles, you can add it to the `defaults` section above the list of profiles in your [settings.json file](../get-started.md#settings-json-file).

```json
"defaults":
Expand Down Expand Up @@ -67,7 +67,7 @@ This is the directory the shell starts in when it is loaded.

**Example:** Start the PowerShell profile in the *GitHubRepos* folder of your *Documents* directory by finding the powershell.exe profile and adding `"startingDirectory": "%USERPROFILE%/Documents/GitHubRepos",`

**Example with WSL:** When setting the starting directory for a [Linux distribution installed via WSL](https://docs.microsoft.com/windows/wsl/install-win10), use the format: `"startingDirectory": "\\\\wsl$\\DISTRO NAME\\home\\USERNAME"`, replacing with the placeholders with the proper names of your distribution. For example, `"startingDirectory": "\\\\wsl$\\Ubuntu-20.04\\home\\user1"`. If you are using the Windows Terminal Settings UI, rather than the settings.json file, to declare this path, you can use the **Browse...** button to select your starting directory or enter the WSL path as: `//wsl.localhost/DISTRO NAME/home/USERNAME`. For example, `//wsl.localhost/Ubuntu-20.04/home/user1`.
**Example with WSL:** When setting the starting directory for a [Linux distribution installed via WSL](/windows/wsl/install-win10), use the format: `"startingDirectory": "\\\\wsl$\\DISTRO NAME\\home\\USERNAME"`, replacing with the placeholders with the proper names of your distribution. For example, `"startingDirectory": "\\\\wsl$\\Ubuntu-20.04\\home\\user1"`. If you are using the Windows Terminal Settings UI, rather than the [settings.json file](../get-started.md#settings-json-file), to declare this path, you can use the **Browse...** button to select your starting directory or enter the WSL path as: `//wsl.localhost/DISTRO NAME/home/USERNAME`. For example, `//wsl.localhost/Ubuntu-20.04/home/user1`.

**Default behavior:** When the startingDirectory value is not specified, you will get different results depending on where you launch Terminal:
- If you run Windows Terminal from the Start menu: C:\windows\system32
Expand All @@ -90,7 +90,7 @@ This sets the icon that displays within the tab, dropdown menu, jumplist, and ta

**Accepts:** File location as a string, or an emoji

**Example:** By placing the icon image `ubuntu.ico` in the folder located at `%LOCALAPPDATA%\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\RoamingState`, you can display the icon by adding this line to the profile in your settings.json: `"icon": "ms-appdata:///roaming/ubuntu.ico"`.
**Example:** By placing the icon image `ubuntu.ico` in the folder located at `%LOCALAPPDATA%\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\RoamingState`, you can display the icon by adding this line to the profile in your [settings.json](../get-started.md#settings-json-file): `"icon": "ms-appdata:///roaming/ubuntu.ico"`.

<br>
___
Expand Down
2 changes: 1 addition & 1 deletion TerminalDocs/customize-settings/rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# Rendering settings in Windows Terminal

The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your settings.json file.
The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your [settings.json file](../get-started.md#settings-json-file).

If you are thinking about changing the rendering settings, additional information is provided on the [Troubleshooting page](./../troubleshooting.md#the-text-is-blurry) to help guide you.

Expand Down
4 changes: 2 additions & 2 deletions TerminalDocs/customize-settings/startup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: high

# Startup settings in Windows Terminal

The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your settings.json file.
The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your [settings.json file](../get-started.md#settings-json-file).

## Default profile

Expand All @@ -32,7 +32,7 @@ ___

Set the default terminal emulator in Windows for all command line applications to run inside of.

**Property name:** This modifies an OS setting and does not have a property name inside the settings.json file.
**Property name:** This modifies an OS setting and does not have a property name inside the [settings.json file](../get-started.md#settings-json-file).

**Necessity:** Required

Expand Down
6 changes: 3 additions & 3 deletions TerminalDocs/dynamic-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Regardless of whether a new shell is installed before or after your terminal ins

## Hide a profile

To hide a profile from your terminal dropdown menu, add the `hidden` property to the profile object in your settings.json file and set it to `true`.
To hide a profile from your terminal dropdown menu, add the `hidden` property to the profile object in your [settings.json file](./get-started.md#settings-json-file) and set it to `true`.

```json
"hidden": true
```

If you delete a dynamically-created profile, the terminal will automatically regenerate the profile and replace it in your settings.json file.
If you delete a dynamically-created profile, the terminal will automatically regenerate the profile and replace it in your [settings.json file](./get-started.md#settings-json-file).

## Prevent a profile from being generated

Expand All @@ -40,7 +40,7 @@ To prevent a dynamic profile from being generated, you can add the profile gener

## Add a third party profile

If a 3rd party command line tool does not have a profile auto-generated into your settings.json file, you can add it manually. Below are profiles for a few common 3rd party tools for your reference.
If a 3rd party command line tool does not have a profile auto-generated into your [settings.json file](./get-started.md#settings-json-file), you can add it manually. Below are profiles for a few common 3rd party tools for your reference.

### Anaconda

Expand Down
17 changes: 14 additions & 3 deletions TerminalDocs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,20 @@ You can run multiple shells side-by-side using panes. To open a pane, you can us

To customize the settings of your Windows Terminal, select **Settings** in the dropdown menu. This will open the settings UI to configure your settings. You can learn how to open the settings UI with keyboard shortcuts on the [Actions page](./customize-settings/actions.md#application-level-commands).

> [!TIP]
> If you prefer to configure your settings by editing a JSON file, select **Settings** in the dropdown menu while holding <kbd>Shift</kbd>. This will open the `settings.json` file in your default text editor. (The default text editor is defined in your [Windows settings](ms-settings:defaultapps).)
> The terminal supports customization of global properties that affect the whole application, [profile properties](./customize-settings/profile-general.md) that affect the settings of each profile, and [actions](./customize-settings/actions.md) that allow you to interact with the terminal using your keyboard or the command palette.
### Settings JSON file

If you prefer to configure your Windows Terminal settings using code, rather than the graphic user interface, you can edit the settings.json file.

Select **Settings** in the Windows Terminal dropdown menu while holding <kbd>Shift</kbd> to open the `settings.json` file in your default text editor. (The default text editor is defined in your [Windows settings](ms-settings:defaultapps).)

The path for your Windows Terminal settings.json file may be found in one of the following directories:

- Terminal (stable / general release): `%LOCALAPPDATA%\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\settings.json`
- Terminal (preview release): `%LOCALAPPDATA%\Packages\Microsoft.WindowsTerminalPreview_8wekyb3d8bbwe\LocalState\settings.json`
- Terminal (unpackaged: Scoop, Chocolately, etc): `%LOCALAPPDATA%\Microsoft\Windows Terminal\settings.json`

> [!Tip]
> You can access the default settings for Windows Terminal by selecting **Settings** in the dropdown menu while holding <kbd>Alt</kbd> to open the `defaults.json` file in your default text editor. This file is auto-generated and any changes to it will be ignored.
## Command line arguments

Expand Down
Loading

0 comments on commit 55a79ac

Please sign in to comment.