Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Powertoys docs #3436

Merged
merged 23 commits into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added hub/images/pt-vcm-source-in-app.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions hub/powertoys/administrator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: PowerToys administrator mode for Windows 10
title: PowerToys administrator mode for Windows
description: For PowerToys to work with an app running in elevated admin mode, PowerToys must be run in administrator mode as well.
ms.date: 05/28/2021
ms.topic: article
Expand All @@ -20,7 +20,7 @@ There are two options for PowerToys to support applications running as administr

## Run as administrator elevated processes explained

Windows applications run in *User mode* by default. To run an application in *Administrative mode* or as an *elevated process* means that app will run with additional access to the operating system.
Windows applications run in _User mode_ by default. To run an application in _Administrative mode_ or as an _elevated process_ means that app will run with additional access to the operating system.

The simplest way to run an app or program in administrative mode is to right-click the program and select <kbd>Run as administrator</kbd>. If the current user is not an administrator, Windows will ask for the administrator username and password.

Expand All @@ -30,7 +30,7 @@ If you see this User Account Control prompt, the application is requesting admin

![Windows elevated permission prompt screenshot](../images/pt-admin-prompt.png)

In the case of an elevated command line, typically the text "Administrator" will be appended to the title bar.
In the case of an elevated command line, typically the text "Administrator" will be included in the title bar.

![Windows admin command line screenshot](../images/pt-admin-terminal.png)

Expand Down
19 changes: 10 additions & 9 deletions hub/powertoys/awake.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,21 @@ ms.topic: article
ms.localizationpriority: medium
---

# Awake utility
# PowerToys Awake utility

Awake is a utility tool for Windows designed to keep a computer awake without having to manage its [power & sleep settings](https://support.microsoft.com/windows/how-to-adjust-power-and-sleep-settings-26f623b5-4fcc-4194-863d-b824e5ea7679). This behavior can be helpful when running time-consuming tasks, ensuring that the computer does not go to sleep or turn off its screens.
PowerToys Awake is a utility tool for Windows designed to keep a computer awake without having to manage its [power & sleep settings](https://support.microsoft.com/windows/how-to-adjust-power-and-sleep-settings-26f623b5-4fcc-4194-863d-b824e5ea7679). This behavior can be helpful when running time-consuming tasks, ensuring that the computer does not go to sleep or turn off its screens.

## Get started

Awake can be used directly from PowerToys settings or as a standalone executable. When the tool is running from PowerToys, it can be managed from PowerToys settings or the system tray.
PowerToys Awake can be used directly from PowerToys settings or as a standalone executable. When the tool is running from PowerToys, it can be managed from PowerToys settings or the system tray.

> [!NOTE]
> Awake does not modify any of the Windows power plan settings, and does not depend on a custom power plan configuration. Instead, it spawns background threads that tell Windows that they require a specific state of the machine.
> PowerToys Awake does not modify any of the Windows power plan settings, and does not depend on a custom power plan configuration. Instead, it spawns background threads that tell Windows that they require a specific state of the machine.

## PowerToys settings

In the PowerToys settings view, start Awake by using the **Enable Awake** toggle. Once enabled, the application will manage the awakeness state of the computer.
<!-- [Jay] GUI text needs to be updated to "PowerToys Awake", then change following text and images accordingly -->
In the PowerToys settings view, start PowerToys Awake by using the **Enable Awake** toggle. Once enabled, the application will manage the awakeness state of the computer.

![A screenshot of the Awake settings](../images/pt-awake-settings-menu.png)

Expand All @@ -34,17 +35,17 @@ The following Awake states can be selected:

## Keep screen on

While Awake can keep the computer awake indefinitely or temporarily, in its default state the displays connected to the machine will turn off, even though the computer won't go to sleep. If you need the displays to be available, use the **Keep screen on** switch, which will ensure that all monitors remain on.
While PowerToys Awake can keep the computer awake indefinitely or temporarily, in its default state the displays connected to the machine will turn off, even though the computer won't go to sleep. If you need the displays to be available, use the **Keep screen on** switch, which will ensure that all monitors remain on.

## System tray

To manage the execution of the tool from the system tray, right-click on the Awake icon.
To manage the execution of the tool from the system tray, right-click on the PowerToys Awake icon.

![Awake settings managed from the system tray on Windows](../images/pt-awake-tray.gif)

## Command Line Interface (CLI)

Awake can also be executed as a standalone application, directly from the PowerToys folder. The following command line arguments can be used when running `PowerToys.Awake.exe` from the terminal or via a `.lnk` shortcut file:
PowerToys Awake can also be executed as a standalone application, directly from the PowerToys folder. The following command line arguments can be used when running `PowerToys.Awake.exe` from the terminal or via a `.lnk` shortcut file:

| Argument | Description |
|:------------------|:------------|
Expand All @@ -53,4 +54,4 @@ Awake can also be executed as a standalone application, directly from the PowerT
| `--time-limit` | Duration, in seconds, during which Awake keeps the computer awake. Can be used in combination with `--display-on`. |
| `--pid` | Attaches the execution of Awake to a Process ID (PID). When the process with a given PID terminates, Awake terminates as well. |

In absence of command-line arguments, Awake will keep the computer awake indefinitely.
In absence of command-line arguments, PowerToys Awake will keep the computer awake indefinitely.
21 changes: 14 additions & 7 deletions hub/powertoys/color-picker.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: PowerToys Color Picker utility for Windows 10
description: A system-wide color picking utility for Windows 10 that enables you to pick colors from any currently running application and automatically copies the HEX or RGB values to your clipboard.
title: PowerToys Color Picker utility for Windows
description: A system-wide color picking utility for Windows that enables you to pick colors from the screen and automatically copies the default value to your clipboard.
ms.date: 05/28/2021
ms.topic: article
ms.localizationpriority: medium
Expand All @@ -9,7 +9,7 @@ no-loc: [PowerToys, Windows, FancyZones, Fancy, Zone, Zones]

# Color Picker utility

A system-wide color picking utility for Windows 10 that enables you to pick colors from any currently running application and automatically copies it in a configurable format to your clipboard.
A system-wide color picking utility for Windows that enables you to pick colors from any currently running application and can copy it in a configurable format to your clipboard.

![ColorPicker](../images/pt-colorpicker-hex-editor.png)

Expand All @@ -21,25 +21,31 @@ To start using Color Picker, make sure it is enabled in the PowerToys settings (

### Activate

Once enabled, you can choose one of the following three behaviors to be executed when launching Color Picker with the activation shortcut <kbd>Win</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> (note that this shortcut can be changed in the settings window):
Once enabled, you can choose one of the following three behaviors to be executed when launching Color Picker with the activation shortcut (default: <kbd>Win</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd>).

:::image type="content" source="../images/pt-colorpicker-behaviors.png" alt-text="ColorPicker behaviors.":::

- **Color Picker with editor mode enabled** - Opens Color Picker. After selecting a color, the editor is opened and the selected color is copied to the clipboard (in the default format - configurable in the settings dialog).
- **Editor** - Opens Editor directly, from here you can choose a color from the history, fine tune a selected color, or capture a new color with by opening the color picker.
- **Editor** - Opens editor directly, from here you can choose a color from the history, fine tune a selected color, or capture a new color with by opening the color picker.
- **Color Picker only** - Opens Color Picker only and the selected color will be copied to the clipboard.

### Select color

After the Color Picker is activated, hover your mouse cursor over the color you would like to copy and left-click the mouse button to select a color. If you want to see the area around your cursor in more detail, scroll up to zoom in.

The copied color will be stored in your clipboard in the format that is configured in the settings (HEX by default).
The copied color will be stored in your clipboard in the format that is configured in the settings (default: HEX).

![Selecting a Color](../images/pt-colorpicker.gif)

> [!NOTE]
> To select the color of the non-mouse-over state of a element:
> - Move the mouse pointer close, but not over the element
> - Zoom in by scrolling the mouse wheel (image will be frozen)
> - In the enlarged area, you can pick the color of the element

## Editor usage

The editor lets you see the history of picked colors (up to 20) and copy their representation in any predefined string format. You can configure which color formats are visible in the editor, and in what order that they appear. This configuration can be found in PowerToys settings.
The editor lets you see the history of picked colors (up to 20) and copy their representation in any predefined string format. You can configure which color formats are visible in the editor, and in what order that they appear. This configuration can be found in PowerToys Settings.

The editor also allows you to fine tune any picked color or get a new similar color. Editor previews different shades of currently selected color: 2 lighter and 2 darker ones.

Expand All @@ -64,3 +70,4 @@ Color picker will let you change following settings:

- Color picker can't be displayed on top of the start menu or action center (you can still pick a color).
- If the currently focused application was started with an administrator elevation (Run as administrator), the Color Picker activation shortcut will not work, unless PowerToys was also started with an administrator elevation.
- Currently, there is a "blind spot" in the bottom right corner of the desktop.
8 changes: 4 additions & 4 deletions hub/powertoys/fancyzones.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: PowerToys FancyZones utility for Windows 10
title: PowerToys FancyZones utility for Windows
description: A window manager utility for arranging and snapping windows into efficient layouts
ms.date: 05/28/2021
ms.topic: article
Expand Down Expand Up @@ -30,7 +30,7 @@ Launch the zones editor using the button in the PowerToys Settings menu or by pr

### Elevated permission admin apps

If you have applications that are elevated, run in administrator mode, read [PowerToys and running as administrator](administrator.md) for more information.
If you have applications that are elevated, run PowerToys in administrator mode. Read [PowerToys and running as administrator](administrator.md) for more information.

## Choose your layout (Layout Editor)

Expand All @@ -44,7 +44,7 @@ If multiple displays are in use, the editor will detect the available monitors a

### Space around zones

The **Show space around zones** check box enables you to determine what sort of border or margin will surround each FancyZone window. The **Space around zones** field enables you to set a custom value for the width of the margin. With the Zones Editor open, change the **Show space around zones** after changing the values to see the new value applied.
The **Show space around zones** check box enables you to determine what sort of margin will surround each FancyZone window. The **Space around zones** field enables you to set a custom value for the width of the margin. With the Zones Editor open, change the **Show space around zones** after changing the values to see the new value applied.

The **Distance to highlight adjacent zones** enables you to set a custom value for the amount of space between zones until they snap together, or before both are highlighted enabling them to merge together.

Expand Down Expand Up @@ -93,7 +93,7 @@ To snap a window to multiple zone using only the keyboard, first check the two o
| <kbd>⊞ Win</kbd>+<kbd>\`</kbd> | Launches the editor (this shortcut can be changed in the settings window) |
| <kbd>⊞ Win</kbd>+<kbd>left/right</kbd> | Move focused window between zones (only if **Override Windows Snap hotkeys** setting is turned on, in that case only the <kbd>⊞ Win</kbd>+<kbd>←</kbd> and <kbd>⊞ Win</kbd>+<kbd>→</kbd> are overridden, while the <kbd>⊞ Win</kbd>+<kbd>↑</kbd> and <kbd>⊞ Win</kbd>+<kbd>↓</kbd> keep working as usual) |

FancyZones doesn't override the Windows 10 <kbd>⊞ Win</kbd>+<kbd>Shift</kbd>+<kbd>arrow</kbd> to quickly move a window to an adjacent monitor.
FancyZones doesn't override the Windows <kbd>⊞ Win</kbd>+<kbd>Shift</kbd>+<kbd>arrow</kbd> to quickly move a window to an adjacent monitor.

## Settings

Expand Down
10 changes: 7 additions & 3 deletions hub/powertoys/file-explorer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: PowerToys File Explorer utility for Windows 10
title: PowerToys File Explorer utility for Windows
description: A File Explorer add on that enables Markdown and SVG previews
ms.date: 05/28/2021
ms.topic: article
Expand All @@ -19,14 +19,18 @@ File Explorer add-ons currently include:

## Preview Pane

Preview Pane is an existing feature in the Windows File Explorer which shows a lightweight, rich, read-only preview of the file's contents in the view's reading pane. PowerToys adds three extensions, Markdown, SVG and PDF.
Preview Pane is an existing feature in the Windows File Explorer which shows a lightweight, rich, read-only preview of the file's contents in the view's reading pane. PowerToys adds three extensions: Markdown, SVG and PDF.

## Enabling Preview Pane

To enable, first ensure that in the PowerToys Settings "Enable SVG (.svg) preview", "Enable SVG (.svg) thumbnails", "Enable PDF (.pdf) preview", "Enable PDF (.pdf) thumbnails", and "Enable Markdown (.md) preview" are all set to **On**.
To enable, first ensure that in the PowerToys Settings all are set to **On**.

<!-- [Jay] image need to be updated to include PDF -->
![PowerToys Settings Enable File Explorer screenshot](../images/powertoys-settings-fileexplorer.png)

> [!NOTE]
> Windows Explorer has an additional setting that needs to be checked in order for preview handlers to work. Open Explorer's Folder options, go to tab "View", under "Advanced settings" check **Show preview handlers in preview pane**.

Next, open Windows File Explorer, select the **View** tab in the File Explorer ribbon, then select **Preview Pane**.

![PowerToys Preview Pane Demo](../images/powertoys-fileexplorer.gif)
6 changes: 5 additions & 1 deletion hub/powertoys/image-resizer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: PowerToys Image Resizer utility for Windows 10
title: PowerToys Image Resizer utility for Windows
description: A Windows shell extension for bulk image-resizing
ms.date: 05/28/2021
ms.topic: article
Expand Down Expand Up @@ -60,6 +60,10 @@ For example, setting the filename format to: `%1 (%2)` on the file `example.png`

You can specify a directory in the filename format to group resized images into sub-directories. For example, a value of `%2\%1` would save the resized image(s) to `Small\example.jpg`

<!-- [Jay] remove following warning if/when a solution is committed -->
> [!IMPORTANT]
> As mentioned above, you can use a backslash to create a new folder upon execution. Please be aware that, at this point - until a fix is committed, all special charaters are not filtered. For example: giving a preset a name with "1/4" in it, will also unintentionally create a folder. A colon `:` will result in corrupted files. For a complete list, see https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#file-and-directory-names.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make links like this one relative, so a more standard way to link this section is, that doesn't include a 'hardcoded' language-location in the URL (including the 'en-us' will force the link to show up in English, excluding it will allow the browser to choose based on the current language setting), so here's my recommended change:
For a complete list, see File and Directory Names in the WIN32 Local File Systems docs.


You can also choose to retain the original *last modified* date on the resized image.

### Auto width/height
Expand Down