Skip to content

Commit

Permalink
Docs updates for 1.11 release (#397)
Browse files Browse the repository at this point in the history
  • Loading branch information
cinnamon-msft committed Aug 31, 2021
1 parent f7f5011 commit e7f739e
Show file tree
Hide file tree
Showing 11 changed files with 125 additions and 82 deletions.
53 changes: 0 additions & 53 deletions TerminalDocs/customize-settings/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,9 +297,6 @@ This closes the tab at a given index. If no index is provided, use the focused t
| ---- | --------- | ------- | ----------- |
| `index` | Optional | Integer | Position of the tab to close. |

> [!IMPORTANT]
> This `index` property is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Close all other tabs

This closes all tabs except for the one at an index. If no index is provided, use the focused tab's index.
Expand Down Expand Up @@ -651,53 +648,6 @@ _This command is not currently bound in the default settings_.
{"command": "identifyWindows" },
```

### Open window rename dialog ([Preview](https://aka.ms/terminal-preview))

This command changes displays a popup window that lets you edit the name for the current window. Clearing the text field will reset the window name.

**Command name:** `openWindowRenamer`

**Default binding:**

```json
{ "command": "openWindowRenamer" }
```

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Identify window ([Preview](https://aka.ms/terminal-preview))

This pops up an overlay on the focused window that displays the window's name and index.

**Command name:** `identifyWindow`

**Default binding:**

```json
{"command": "identifyWindow", "keys": "" },
```

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Identify windows ([Preview](https://aka.ms/terminal-preview))

This pops up an overlay on all windows that displays each window's name and index.

**Command name:** `identifyWindows`

**Default binding:**

_This command is not currently bound in the default settings_.

```json
{"command": "identifyWindows" },
```

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
<br />

___
Expand Down Expand Up @@ -824,9 +774,6 @@ This halves the size of the active pane and opens another. Without any arguments
| `splitMode` | Optional | `"duplicate"` | Controls how the pane splits. Only accepts `"duplicate"`, which will duplicate the focused pane's profile into a new pane. |
| `size` | Optional | Float | Specify how large the new pane should be, as a fraction of the current pane's size. `1.0` would be "all of the current pane", and `0.0` is "None of the parent". Defaults to `0.5`. |

> [!IMPORTANT]
> The `"colorScheme"` and `"suppressApplicationTitle"` parameters are only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
<br />

___
Expand Down
35 changes: 30 additions & 5 deletions TerminalDocs/customize-settings/appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Appearance Settings
description: Learn how to customize appearance settings within Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 07/14/2021
ms.date: 08/30/2021
ms.topic: how-to
ms.localizationpriority: high
---
Expand All @@ -12,7 +12,7 @@ ms.localizationpriority: high

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))
## Language

This sets an override for the application's preferred language.

Expand All @@ -22,9 +22,6 @@ This sets an override for the application's preferred language.

**Accepts:** A BCP-47 language tag like `"en-US"`

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
<br />

## Theme
Expand Down Expand Up @@ -107,6 +104,34 @@ When this is set to `true`, the tabs are moved into the title bar and the title

___

## Show acrylic in tab row ([Preview](https://aka.ms/terminal-preview))

:::row:::
:::column span="":::
When this is set to `true`, the tab row is given an acrylic background at 50% opacity. When it's set to `false`, the tab row will be opaque. Note that changing this setting will require starting a new terminal instance.

**Property name:** `useAcrylicInTabRow`

**Necessity:** Optional

**Accepts:** `true`, `false`

**Default value:** `false`

:::column-end:::
:::column span="":::
![Windows Terminal acrylic in tab row](./../images/acrylic-tab-row.png)

:::column-end:::
:::row-end:::

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
<br />

___

## Use active terminal title as application title

When this is set to `true`, the title bar displays the title of the selected tab. When it's set to `false`, title bar displays "Windows Terminal". Note that changing this setting will require starting a new terminal instance.
Expand Down
4 changes: 2 additions & 2 deletions TerminalDocs/customize-settings/interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Interaction Settings
description: Learn how to customize interaction settings within Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 07/14/2021
ms.date: 08/30/2021
ms.topic: how-to
ms.localizationpriority: high
---
Expand Down Expand Up @@ -107,7 +107,7 @@ ___

## Minimize to tray ([Preview](https://aka.ms/terminal-preview))

When this is set to `true`, minimizing a window will hide it from the taskbar, making it inaccessible from that area. It will instead be accessible from Terminal's system tray icon. If either this global setting or the `minimizeToTray` global setting is set to true, Terminal will place an icon in the system tray.
When this is set to `true`, minimizing a window will hide it from the taskbar, making it inaccessible from that area. It will instead be accessible from terminal's system tray icon. If either this global setting or the `minimizeToTray` global setting is set to true, terminal will place an icon in the system tray.

**Property name:** `minimizeToTray`

Expand Down
56 changes: 52 additions & 4 deletions TerminalDocs/customize-settings/profile-appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Appearance Profile Settings
description: Learn how to customize the appearance profile settings within Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 07/14/2021
ms.date: 08/30/2021
ms.topic: how-to
ms.localizationpriority: high
---
Expand Down Expand Up @@ -99,9 +99,57 @@ This sets the weight (lightness or heaviness of the strokes) for the profile's f
> "fontWeight": "normal"
> ```
### Intense Text Formatting
### Font features ([Preview](https://aka.ms/terminal-preview))
This controls how "intense" text is formatted in the Terminal. "Intense" text is text formatted with the escape sequence `\x1b[1m`.
This sets the [OpenType font features](/typography/opentype/spec/featurelist) for the given font.
**Property name:** `features` (defined within the `font` object)
**Necessity:** Optional
**Accepts:** Feature properties in the format of: `"string": integer`
**Example:**
```jsonc
// Enables ss01 and disables ligatures
"font": {
"face": "Cascadia Code",
"features": {
"ss01": 1,
"liga": 0
}
}
```
> [!IMPORTANT]
> This feature only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Font axes ([Preview](https://aka.ms/terminal-preview))

This sets the [OpenType font axes](/typography/opentype/spec/dvaraxisreg) for the given font.

**Property name:** `axes` (defined within the `font` object)

**Necessity:** Optional

**Accepts:** Axis properties in the format of: `"string": integer`

**Example:**

```jsonc
// Sets the font to italic
"font": {
"face": "Cascadia Code",
"axes": {
"ital": 1
}
}
```

### Intense text formatting

This controls how "intense" text is formatted in the terminal. "Intense" text is text formatted with the escape sequence `\x1b[1m`.

**Property name:** `intenseTextStyle`

Expand All @@ -112,7 +160,7 @@ This controls how "intense" text is formatted in the Terminal. "Intense" text is
* `"all"`: render intense text as both **bold** and bright
* `"bold"`: render intense text as **bold**, but not bright
* `"bright"`: render intense text bright, but not bold
* `"none"`: the Terminal won't do anything special for intense text
* `"none"`: the terminal won't do anything special for intense text

**Default value:** `"all"`

Expand Down
4 changes: 1 addition & 3 deletions TerminalDocs/dynamic-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Dynamic Profiles
description: Learn about dynamic profiles in Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 05/19/2020
ms.date: 08/30/2021
ms.topic: concept
---

Expand All @@ -28,8 +28,6 @@ To hide a profile from your terminal dropdown menu, add the `hidden` property to
"hidden": true
```

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

To prevent a dynamic profile from being generated, you can add the profile generator to the `disabledProfileSources` array in your global settings. More information on this setting can be found on the [Global settings page](./customize-settings/startup.md#disable-dynamic-profiles).
Expand Down
Binary file added TerminalDocs/images/acrylic-tab-row.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added TerminalDocs/images/drag-and-drop.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added TerminalDocs/images/split-tab.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 26 additions & 5 deletions TerminalDocs/panes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Panes
description: Learn how to split panes in Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 04/14/2021
ms.date: 08/30/2021
ms.topic: how-to
---

Expand Down Expand Up @@ -34,6 +34,15 @@ If you'd like to open a new pane of your default profile, you can hold the <kbd>

![Windows Terminal dropdown pane](./images/alt-click-pane.gif)

### Using the tab context menu ([Preview](https://aka.ms/terminal-preview))

If you'd like to open a new pane of a profile that is already open in your terminal, you can right click on the tab and click Split Tab. This will duplicate the focused pane in the current tab.

![Windows Terminal split tab](./images/split-tab.gif)

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
## Switching between panes

The terminal allows you to navigate between panes by using the keyboard. If you hold the <kbd>Alt</kbd> key, you can use your arrow keys to move your focus between panes. You can identify which pane is in focus by the accent color border surrounding it. Note that this accent color is set in your Windows color settings.
Expand All @@ -52,9 +61,12 @@ You can customize this by adding key bindings for the `moveFocus` command and se
{ "command": { "action": "moveFocus", "direction": "nextInOrder" } }
```

## Swapping panes
> [!IMPORTANT]
> The `previous`, `previousInOrder`, and `nextInOrder` directions are only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
Once two panes have been created you can swap their positions in the terminal.
## Swapping panes ([Preview](https://aka.ms/terminal-preview))

Once two panes have been created, you can swap their positions in the terminal.

The `swapPane` command can be customized using the same navigation `direction`s as `moveFocus`. These commands will swap the positions of the currently focused pane and its neighbor according to `direction`.

Expand All @@ -68,7 +80,10 @@ The `swapPane` command can be customized using the same navigation `direction`s
{ "command": { "action": "swapPane", "direction": "nextInOrder" } }
```

## Moving panes
> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
## Moving panes ([Preview](https://aka.ms/terminal-preview))

Panes can also be moved between tabs, creating a new tab if one with the target index does not exist.

Expand All @@ -86,14 +101,20 @@ The key bindings for the `movePane` command can be customized for moving panes t
{ "command": { "action": "movePane", "index": 8 } }
```

## Changing Split Orientation
> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
## Changing split orientation ([Preview](https://aka.ms/terminal-preview))

After two panes on a tab have been created, the split orientation of those panes can be switched between `vertical` and `horizontal` with the `toggleSplitOrientation` command.

```json
{ "command": "toggleSplitOrientation" }
```

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
## Resizing a pane

You can adjust the size of your panes by holding <kbd>Alt</kbd>+<kbd>Shift</kbd> and using your arrow keys to resize the focused pane.
Expand Down
11 changes: 10 additions & 1 deletion TerminalDocs/tips-and-tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal tips and tricks
description: In this page, you will find tips and tricks to help improve your Windows Terminal experience.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 05/25/2021
ms.date: 08/30/2021
ms.topic: how-to
ms.localizationpriority: high
---
Expand Down Expand Up @@ -44,6 +44,15 @@ You can adjust the opacity of the background by holding <kbd>ctrl+shift</kbd> an

You can open a hyperlink from inside Windows Terminal with your mouse using <kbd>ctrl</kbd> + click.

### Drag and drop file/folder to open ([Preview](https://aka.ms/terminal-preview))

You can drag and drop a file or folder over the New Tab button to open your default profile with that given file or folder. By default, this will open a new tab. You can hold <kbd>Alt</kbd> to open a new pane in your current tab or hold <kbd>Shift</kbd> to open a new window.

![Windows Terminal drag and drop](./images/drag-and-drop.gif)

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Copy/paste

You can right-click with your mouse to copy and paste text within Windows Terminal using your clipboard storage.
Expand Down
13 changes: 4 additions & 9 deletions TerminalDocs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows Terminal Troubleshooting
description: Learn fixes to common obstacles in Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 02/25/2021
ms.date: 08/30/2021
ms.topic: overview
ms.localizationpriority: high
---
Expand Down Expand Up @@ -35,6 +35,9 @@ For example, the following setting will launch the "Ubuntu-18.04" distribution i
}
```

> [!IMPORTANT]
> On newer versions of Windows, `startingDirectory` can accept Linux-style paths in [Windows Terminal Preview](https://aka.ms/terminal-preview).
## Setting the tab title

To have the shell automatically set your tab title, [visit the set the tab title tutorial](./tutorials/tab-title.md). If you want to set your own tab title, open the [settings.json file](./get-started.md#settings-json-file) and follow these steps:
Expand All @@ -61,14 +64,6 @@ Alternatively, if you are running a script using the `commandline` profile setti

The purpose of `startingDirectory` is to launch a new Windows Terminal instance in the given directory. If the terminal runs any code that changes its directory, that may be a good place to take a look.

## Deleting a profile

By default, Windows Terminal ships with a built-in PowerShell and a Command Prompt profile. The terminal will also autodetect if other command line applications are installed, such as PowerShell Core, WSL distributions (Ubuntu, Debian, etc), and Azure Cloud Shell. We call these types of automatically generated profiles "Dynamic profiles".

For both built-in and dynamic profiles, deleting the profile from your [settings.json file](./get-started.md#settings-json-file) will not remove it from your profiles. Built-in profiles are defined in `defaults.json`, so they're always available. Dynamic profiles will attempt to create a JSON stub for their profile in your `settings.json` file whenever a profile is not already present in the file.

The only way to truly remove these profiles from the list is by "hiding" them. To hide a profile, add the property `"hidden": true` to the profile.

## Ctrl+= does not increase the font size

If you are using a German keyboard layout, you may run into this problem. <kbd>ctrl+=</kbd> gets deserialized as <kbd>ctrl+shift+0</kbd> if your main keyboard layout is set to German. This is the correct mapping for German keyboards.
Expand Down

0 comments on commit e7f739e

Please sign in to comment.