Skip to content

Commit

Permalink
Issue fixes, new preview feature, PR contributions (#357)
Browse files Browse the repository at this point in the history 
* command-line-arguments.md: Tag the Command Prompt code blocks

For some reason they were tagged as bash, which broke highlighting in at least one of them.

* fixed typo (#220)

in line 98 it's `C:\\path\\to\\icon.png` while in line 115 it was `C:\\path\\to\\icon` so I've added the missing `.png`

* Add note about escaping characters with backslash (#230)

Originally filed by Andrewery https://github.com/MicrosoftDocs/terminal/pull/134/files

* Add icon example and folder location (#231)

From #135

* Add icon example and folder location

As originally submitted by @aloneguid in #135

* Remove code brackets for readability

* Add spacing

* Fix default value by escaping characters (#232)

Original submission: https://github.com/MicrosoftDocs/terminal/pull/134/files

* Add info about the command palette (#180)

* Add info about the command palette

1. Add info about the command palette.
2. Typo fixes (e.g. "quick-start guide" instead of "quickstart")
3. Style fix, e.g. we don't have a keyboard key whose full name is "alt+shift+plus".

* revert description

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Add backslash escape note (#233)

...from PR #181

* Add a note about hiding dynamic profiles (#186)

* Add a note about hiding dynamic profiles

* Minor writing updates

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Clarify adding profile in ssh tutorial. Fixes #183 (#193)

* Clarify adding profile in ssh tutorial. Fixes: #183

* Remove  from docs link

* Add guid command for powershell (#234)

migrated from PR https://github.com/MicrosoftDocs/terminal/pull/199/files

* Change "i.e." to "e.g." (#207)

This seems to be the intended meaning: There are Linux distributions that are not Ubuntu, but Ubuntu is an example of a Linux distribution for which the behavior is the given.

* Old Ubuntu: Use up-to-date version of golang (#216)

Currently, the install recommends using an out-of-date version of golang, which in turn causes issues while installing powerline-go.

* Add startingDirectory example (#237)

* Add startingDirectory example

* Format startingDirectory entry

* remove icon file type

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* Change icon description to example

* Change false to true

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* Remove unnecessary sentence

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* Typo fixes

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* link fix

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* Capitalization fixes

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* shortcut fixes

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* page_title_updates_terminal (#243)

* Add docs for `newWindow` action (#259)

* refactor(powerline): update for oh-my-posh V3 (#263)

* Improved title setting procedure on bash/Ubuntu so that it doesn't destroy `PS1` (#123)

Improved title setting procedure on bash/Ubuntu so that it doesn't destroy `PS1`

* Update powerline-setup.md (#240)

* Update powerline-setup.md

* Update powerline-setup.md

* Update powerline-setup.md

* fix typo

* Merge release 1.7 into master (#264)

Co-authored-by: Mike Griese <migrie@microsoft.com>
Co-authored-by: Don-Vito <khvitaly@gmail.com>

* Update powerline-setup.md (#175)

* Update powerline-setup.md

Updated Tips to include setting the Integrated terminal within Visual Studio to use the Cascadia Code Powerlines font.
Also added an additional resource which shows step by step how to do this

* Combine VS Code & VS tips for setting up powerline

* Remove external blog link

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Fix a monor typo with the default keybinding for new tab (#287)

closes #270

* Add a note that --window is only available in 1.7+ (#288)

* Add a note that --window is only available in 1.7+

  closes #282

* Whoops, those can't go on one line

* Fix a typo in this doc (#289)

* Fix a typo in this doc

Closes #280

* I bet the docs build is gonna complain about this one

* Add a FAQ entry for folks who are confused when Settings does nothing (#290)

* Add a note that you can't set the tab color from the commandline (#291)

Closes #249

* Add UUID generator option

* Add online guid generator

* Add instructions to open defaults.json file

* Update panes.md

* Add note about using settings.json...

..not defaults.json for applying color schemes across profiles.

* fix link

* Merge release-1.8 into master (#309)

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>
Co-authored-by: Don-Vito <khvitaly@gmail.com>
Co-authored-by: Mike Griese <migrie@microsoft.com>

* Fix placement of unfocused appearance section (#312)

* Update TerminalDocs/command-line-arguments.md

* Update TerminalDocs/command-line-arguments.md

* Add mouse interaction section (#297)

Addresses issue #6

* document how to start windows terminal and have it execute a command (#298)

* document how to start windows terminal and have it execute a command #296

* Separated the argument examples 

and included explanations of what they accomplish

* fix typo

* remove version from url

Co-authored-by: Mark Iannucci <mark.iannucci@dhha.org>
Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* FIX syntax error in json configuration example (#308)

FIX syntax error in json configuration example

* Document trimBlockSelection setting (#313)

* Document trimBlockSelection setting

* Add preview disclaimer

* Minor edit + note re how to select rectangular txt

* Add preview to h2

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Updated openSettings default bindings. (#317)

* Updated openSettings default bindings.

* Updated the openSettings description.

* minor edits

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Update powerline-setup.md (#319)

Fix a typo 'optonal' replaced by 'optional'

* Updates for 1.9 release (#328)

* Fix links

* Typo "Windows terminal"→"Windows Terminal" (#326)

https://docs.microsoft.com/en-us/windows/terminal/custom-terminal-gallery/custom-schemes
#PingMSFTDocs

* Add link to alternative install options (#321)

Resolves #286

* Update `cursorHeight` minimum value (#278)

Documentation update for microsoft/terminal#9386

* Add link to install preview (#342)

* Add link to install preview

* Update wording

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* Update default settings, add UI screenshots (#343)

* Update default settings, add UI screenshots

* update screenshot

* fix numbering

* Fix screenshot steps

* Correct title verbage, update screenshot

* Add preview tags

* Fix typos

Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>

* Add required version for OMP2 

Oh-my-posh has updated to version 3, so adding a note to designate version 2 on this uninstall until we can return to this tutorial and update to version 3. In the meantime, there are other tutorials available on the web that walkthrough how to install OMP v3 and set it up with git status, etc.

* Update quakemode monitor setting

Based on #333

* Added link to Cascadia Code font

* Add troubleshooting section on git bash flashing (#356)

* font struct (#355)

Co-authored-by: Pankaj Bhojwani <pabhojwa@microsoft.com>

* documentation for minimzeToTray (#352)

* Add documentation for closing tabs by index (#347)

As implemented in microsoft/terminal#10447

* Update configuration section of get-start (#345)

Select Settings in the dropdown menu will open the Settings UI instead of open file since the release version v1.6.10571.0
But this page is not up to date, so I edit it.

* Add note about opening command palette via dropdown menu (#335)

* Make link relative

Co-authored-by: Samuel Bronson <naesten@gmail.com>
Co-authored-by: LSC <schad.lucas@gmail.com>
Co-authored-by: skycommand <jadangerbrooks@hotmail.com>
Co-authored-by: Mike Griese <migrie@microsoft.com>
Co-authored-by: Cameron Durham <cdurham@usc.edu>
Co-authored-by: Søren Fuglede Jørgensen <github@fuglede.dk>
Co-authored-by: Janne Mareike Koschinski <janne@kuschku.de>
Co-authored-by: Kayla Cinnamon <cinnamon@microsoft.com>
Co-authored-by: Meenal Patel <42360097+v-mepa@users.noreply.github.com>
Co-authored-by: Jan De Dobbeleer <2492783+JanDeDobbeleer@users.noreply.github.com>
Co-authored-by: Dakkaron <dak1st@gmx.at>
Co-authored-by: Ibrahim Rouis <73853380+rouisibra@users.noreply.github.com>
Co-authored-by: Don-Vito <khvitaly@gmail.com>
Co-authored-by: Michael James <mike@mjjames.co.uk>
Co-authored-by: Mark Iannucci <mark.iannucci@gmail.com>
Co-authored-by: Mark Iannucci <mark.iannucci@dhha.org>
Co-authored-by: lpotherat <l.potherat@planetb.fr>
Co-authored-by: Sean Jacobs <Sophismata@users.noreply.github.com>
Co-authored-by: superfaz <16510828+superfaz@users.noreply.github.com>
Co-authored-by: Hiroshi Yoshioka <40815708+hyoshioka0128@users.noreply.github.com>
Co-authored-by: Eugene Samoylov <eugenesmlv@gmail.com>
Co-authored-by: PankajBhojwani <pankaj.d.bhoj@gmail.com>
Co-authored-by: Pankaj Bhojwani <pabhojwa@microsoft.com>
Co-authored-by: Leon Liang <lelian@microsoft.com>
Co-authored-by: Ian O'Neill <ianjoneill@users.noreply.github.com>
Co-authored-by: Gaein_nidb <36162655+nidbCN@users.noreply.github.com>
Co-authored-by: Casper Verhaar <casper.verhaar@gmail.com>
  • Loading branch information
@mattwojo @SamB
@boop5 @skycommand @zadjii-msft @camerondurham @fuglede @justjanne @cinnamon-msft @v-mepa @JanDeDobbeleer @Dakkaron @Don-Vito @mjjames @MarkIannucci @lpotherat @Sophismata @superfaz @hyoshioka0128 @eugenesmlv @PankajBhojwani @leonMSFT @ianjoneill @nidbCN @KnapSac
28 people committed Jul 9, 2021
1 parent aef98f0 commit 88445b8
Show file tree
Hide file tree
Showing 6 changed files with 122 additions and 15 deletions.
37 changes: 35 additions & 2 deletions TerminalDocs/customize-settings/actions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -286,10 +286,16 @@ ___

### Close tab

This closes the current tab.
This closes the tab at a given index. If no index is provided, use the focused tab's index.

**Command name:** `closeTab`

#### Actions

| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
| `index` | Optional | Integer | Position of the tab to close. |

### 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 @@ -688,6 +694,23 @@ _This command is not currently bound in the default settings_.
> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Minimize To Tray ([Preview](https://aka.ms/terminal-preview))

This will hide the currently focused window from the Taskbar and instead will be accessible from the system tray icon. This action will only be useable when the tray icon is visible through one of the two global settings `minimizeToTray` or `alwaysShowTrayIcon`.

**Command name:** `minimizeToTray`

**Default binding:**

_This command is not currently bound in the default settings_.

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

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

___
Expand Down Expand Up @@ -1125,7 +1148,17 @@ The `desktop` and `monitor` properties can be combined in the following ways:
This action is a special variation of the [`globalSummon`](#global-commands) action. It specifically summons the [quake window](../tips-and-tricks.md#quake-mode). It is a shorthand for the following `globalSummon` action:

```json
{ "keys": "win+`", "command": { "action": "globalSummon", "name": "_quake", "dropdownDuration": 200, "toggleVisibility": true, "monitor": "toCursor", "desktop": "toCurrent" } }
{
"keys": "win+`",
"command": {
"action": "globalSummon",
"name": "_quake",
"dropdownDuration": 200,
"toggleVisibility": true,
"monitor": "toMouse",
"desktop": "toCurrent"
}
}
```

If you'd like to change the behavior of the `quakeMode` action, we recommended creating a new `globalSummon` entry in `actions` with the settings you prefer.
Expand Down
38 changes: 38 additions & 0 deletions TerminalDocs/customize-settings/interaction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,44 @@ When this is set to `true`, the window will snap to the nearest character bounda

___

## 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. The user will also be able to utilize the `minimizeToTray` _action_.

**Property name:** `minimizeToTray`

**Necessity:** Optional

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

**Default value:** `false`

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

___

## Always Show Tray Icon ([Preview](https://aka.ms/terminal-preview))

When this is set to `true`, the Terminal will place its icon in the system tray. If either this global setting or the `minimizeToTray` global setting is set to true, Terminal will place an icon in the system tray. The user will also be able to utilize the `minimizeToTray` _action_.

**Property name:** `alwaysShowTrayIcon`

**Necessity:** Optional

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

**Default value:** `false`

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

___

## Tab settings

### Tab switcher interface style
Expand Down
26 changes: 22 additions & 4 deletions TerminalDocs/customize-settings/profile-appearance.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,19 @@ This is the name of the color scheme used in the profile. Color schemes are defi

**Default value:** `"Campbell"`

### Font face
### Font

This is the structure within which the other font settings must be defined. An example of what this could look like in the JSON file is shown below.

**Property name:** `font`

**Necessity:** Optional

### Font Face

This is the name of the font face used in the profile. The terminal will try to fallback to Consolas if this can't be found or is invalid. To learn about the other variants of the default font, Cascadia Mono, visit the [Cascadia Code page](./../cascadia-code.md).

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

**Necessity:** Optional

Expand All @@ -53,7 +61,7 @@ This is the name of the font face used in the profile. The terminal will try to

This sets the profile's font size in points.

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

**Necessity:** Optional

Expand All @@ -65,14 +73,24 @@ This sets the profile's font size in points.

This sets the weight (lightness or heaviness of the strokes) for the profile's font.

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

**Necessity:** Optional

**Accepts:** `"normal"`, `"thin"`, `"extra-light"`, `"light"`, `"semi-light"`, `"medium"`, `"semi-bold"`, `"bold"`, `"extra-bold"`, `"black"`, `"extra-black"`, or an integer corresponding to the numeric representation of the OpenType font weight

**Default value:** `"normal"`

### Font example

```json
"font": {
"face": "Cascadia Mono",
"size": 12,
"weight": "normal"
}
```

## Retro terminal effects

:::row:::
Expand Down
9 changes: 4 additions & 5 deletions TerminalDocs/get-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ You can open a new tab of the default profile by pressing <kbd>Ctrl</kbd>+<kbd>S

## Invoke the command palette

You can invoke most features of Windows Terminal through the [command palette](./command-palette.md). The default key combination to invoke it is <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>.
You can invoke most features of Windows Terminal through the [command palette](./command-palette.md). The default key combination to invoke it is <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>. You can also open it using the **Command palette** button in the dropdown menu.

![Example of the command palette in use](./images/command-palette-iterable-commands.gif)

Expand All @@ -71,12 +71,11 @@ You can run multiple shells side-by-side using panes. To open a pane, you can us

## Configuration

To customize the settings of your Windows Terminal, select **Settings** in the dropdown menu. 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.
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 on the [Actions page](./customize-settings/actions.md#application-level-commands).

> [!TIP]
> You can also use the settings UI to configure your settings if you are using [Windows Terminal Preview](https://aka.ms/terminal-preview). You can learn how to open the settings UI on the [Actions page](./customize-settings/actions.md#application-level-commands).
> If you prefer to configure your settings by edit file, click the "setting" icon, 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.
## Command line arguments

Expand Down
21 changes: 20 additions & 1 deletion TerminalDocs/troubleshooting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Only images linked from a file location can be rendered as profile icons in the

## Technical Notes

Applications that use the [`GetConsoleScreenBufferInfo` family of APIs](https://docs.microsoft.com/windows/console/getconsolescreenbufferinfoex) to retrieve the active console colors in Win32 format and then attempt to transform them into cross-platform VT sequences (for example, by transforming `BACKGROUND_RED` to `\x1b[41m`) may interfere with Terminal's ability to detect what background color the application is attempting to use.
Applications that use the [`GetConsoleScreenBufferInfo` family of APIs](/windows/console/getconsolescreenbufferinfoex) to retrieve the active console colors in Win32 format and then attempt to transform them into cross-platform VT sequences (for example, by transforming `BACKGROUND_RED` to `\x1b[41m`) may interfere with Terminal's ability to detect what background color the application is attempting to use.

Application developers are encouraged to choose either Windows API functions _or_ VT sequences for adjusting colors and not attempt to mix them.

Expand All @@ -138,3 +138,22 @@ Starting in Windows Terminal 1.5, the Terminal will display a warning if the "To
5. Hit "Ok", and restart the PC.

After restarting the machine, the service should auto-start, and the dialog should no longer appear.

## Why do I see blinking or flashing when using a git bash command line?

You may notice a blinking or flashing when using a git bash command line inside Windows Terminal. This behavior is actually by design. The Terminal is obeying what git bash is telling it to do (setting bell-style to visible, causing a flash to associate with the bell response), BUT we understand this may be distracting. To fix this, open the `.inputrc` file for your Git bash with a text editor. This file will likely be located in the path `C:\Program Files\Git\etc`. To open with the Nano text editor: `nano ~/.inputrc`

Change the default:

```bash
# none, visible or audible
set bell-style visible
```

Set the bell-style to either `none` or `audible` to remove the visible flash:

```bash
set bell-style none
```

Press Ctrl + O and Ctrl + X to Save and Exit.
6 changes: 3 additions & 3 deletions TerminalDocs/tutorials/powerline-setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Using PowerShell, install Posh-Git and Oh-My-Posh:

```powershell
Install-Module posh-git -Scope CurrentUser
Install-Module oh-my-posh -Scope CurrentUser
Install-Module oh-my-posh -Scope CurrentUser -RequiredVersion 2.0.412
```

> [!TIP]
> You may need to install NuGet if you don't already have it. Your PowerShell command line will ask if you want to install NuGet if this is the case. Select [Y] Yes. You may also need to approve that you are installing modules from [PSGallery](/powershell/scripting/gallery/getting-started), an 'untrusted repository'. Select [Y] Yes.
> You may need to install NuGet if you don't already have it. You may also need to approve that you are installing modules from [PSGallery](/powershell/scripting/gallery/getting-started), an 'untrusted repository'.
[Posh-Git](https://github.com/dahlbyk/posh-git) adds Git status information to your prompt as well as tab-completion for Git commands, parameters, remotes, and branch names. [Oh-My-Posh](https://github.com/JanDeDobbeleer/oh-my-posh) provides theme capabilities for your PowerShell prompt.

Expand Down Expand Up @@ -76,7 +76,7 @@ function without the need for additional icons. You can also [create a custom th
### Set Cascadia Code PL as your font

To set the Cascadia Code PL font for use with PowerLine (after downloading, unzipping, and installing on your system), you will need to open your [profile settings](../customize-settings/profile-appearance.md) in your settings.json file by selecting **Settings** (Ctrl+,) from your Windows Terminal dropdown menu. This can also be done using the settings UI if you have it enabled.
To set the Cascadia Code PL font for use with PowerLine (after [downloading the Cascadia Code font](https://github.com/microsoft/cascadia-code/releases), unzipping, and installing on your system), you will need to open your [profile settings](../customize-settings/profile-appearance.md) in your settings.json file by selecting **Settings** (Ctrl+,) from your Windows Terminal dropdown menu. This can also be done using the settings UI if you have it enabled.

Once your settings.json file opens, find the Windows PowerShell profile and add: `"fontFace": "Cascadia Code PL"` to designate Cascadia Code PL as the font. This will provide those nice Cascadia Code Powerline glyphs. You should notice the change in your terminal as soon as you select **Save** in your editor.

Expand Down

0 comments on commit 88445b8

Please sign in to comment.