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

Makes headings consistent across PowerToys documentation #4820

Open
wants to merge 4 commits into
base: docs
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion hub/powertoys/always-on-top.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A system-wide Windows utility to pin windows above other windows.

![AlwaysOnTop screenshot.](../images/pt-always-on-top.png)

## Pin a window
## Pinning a window

When you activate Always On Top (default: <kbd>⊞ Win</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd>), the utility pins the active window above all other windows. The pinned window stays on top, even when you select other windows.

Expand Down
2 changes: 1 addition & 1 deletion hub/powertoys/awake.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.localizationpriority: medium

PowerToys Awake is a 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 can be helpful when running time-consuming tasks, ensuring that the computer does not go to sleep or turn off its screens.

## Getting started
## Using PowerToys Awake

You can use PowerToys Awake directly from PowerToys Settings or as a standalone executable. When it's running from PowerToys, it can be managed from PowerToys Settings or the system tray.

Expand Down
4 changes: 2 additions & 2 deletions hub/powertoys/cmd-not-found.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A PowerShell 7 module that detects command-line errors and suggests a relevant W
- [PowerShell 7](/PowerShell/scripting/install/installing-PowerShell-on-windows)
- [PowerShell Microsoft.WinGet.Client module](https://www.powershellgallery.com/packages/Microsoft.WinGet.Client)

## Install the module
## Installing Command Not Found

To install the Command Not Found module, navigate to the Command Not Found page in PowerToys settings and select the **Install** button. Once the module installation has completed, PowerShell 7 experimental features needed for the module to function will be enabled:

Expand All @@ -37,6 +37,6 @@ Import-Module "<powertoys install dir>/WinGetCommandNotFound.psd1"

**Note:** The profile file will be created if needed. Restart PowerShell session to use the module.

## Uninstall the module
## Uninstalling Command Not Found

To uninstall the Command Not Found module, navigate to the Command Not Found page in PowerToys settings and select the **Uninstall** button. Once the module uninstall has completed, the block of commands previously added will be removed from the PowerShell profile file.
8 changes: 3 additions & 5 deletions hub/powertoys/color-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,11 @@ A system-wide color picking utility for Windows to pick colors from any screen a

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

## Getting started

### Enabling Color Picker
## Enabling Color Picker

Enable Color Picker in the **Color Picker** tab in PowerToys.

### Activating Color Picker
## Activating Color Picker

You can choose what happens when you activate Color Picker (default: <kbd>Win</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd>) by changing **Activation Behavior**:

Expand Down Expand Up @@ -139,7 +137,7 @@ For example `%ReX` means the red value in hex uppercase two digits format.

Color formats can contain any words or characters that you prefer. For example, the default color format, which shows up on color format creation is: `_'new Color (R = %Re, G = %Gr, B = %Bl)'_`.

## Limitations
## Limitations of Color Picker

- Color Picker can't display on top of the Start menu or Action Center, but you can still pick a color.
- If you started the currently-focused application with an administrator elevation (**Run as administrator**), the Color Picker activation shortcut won't work, unless you also started PowerToys with an administrator elevation.
Expand Down
4 changes: 2 additions & 2 deletions hub/powertoys/crop-and-lock.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ ms.localizationpriority: medium
no-loc: [PowerToys, Windows, Crop And Lock, Win]
---

# Crop And Lock
# Crop And Lock utility

PowerToys **Crop And Lock** allows you to crop a current application into a smaller window or just create a thumbnail. Focus the target window and press the shortcut to start cropping.</value>

![Crop And Lock screenshot.](../images/powertoys-crop-and-lock.gif)

## Getting started

### How to use
### Cropping a window

To start using Crop And Lock, enable it in the PowerToys Settings (**Crop And Lock** tab).

Expand Down
8 changes: 4 additions & 4 deletions hub/powertoys/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ ms.topic: article
no-loc: [PowerToys, Windows, Environment Variables, Win]
---

# Environment Variables
# Environment Variables utility

Environment Variables offers an easy and convenient way to manage environment variables. It also allows you to create profiles for managing a set of variables together. Profile variables have precedence over User and System variables. Applying the profile adds variables to User environment variables in the background. When a profile is applied, if there is an existing User variable with the same name, a backup variable is created in User variables which will be reverted to the original value on profile un-apply.

Applied variables list shows the current state of the environment, respecting the order of evaluation of environment variables (Profile -> User -> System). Evaluated Path variable value is shown at the top of the list.

![PowerToys Environment Variables screenshot.](../images/powertoys-environment-variables.png)

## Edit/Remove variable
## Editing or removing a variable

To edit or remove a variable (profile, User or System), select the more options button (**•••**) on the desired variable:

![PowerToys Environment Variables: Edit/Remove variable](../images/powertoys-environment-variables-edit-variable.gif)

## Add profile
## Adding a profile

To add a new profile:

Expand All @@ -34,7 +34,7 @@ To add a new profile:

To edit or remove a profile, select the more options button (**•••**) on the desired profile.

## Apply profile
## Applying a profile

To apply a profile, set the profile toggle to On. Only one profile can be applied at a time. The Applied variables list will show applied profile variables at the top (below Path variable):

Expand Down
6 changes: 3 additions & 3 deletions hub/powertoys/file-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ no-loc: [PowerToys, Windows, File Explorer, Monaco]
> [!WARNING]
> Enabling the preview handlers will override other preview handlers already installed - there have been reports of incompatibility between Outlook and the PDF Preview Handler.

## Preview Pane previewers
## Previewing files with Preview Pane

Preview Pane is an existing feature in the Windows File Explorer which allows you to see a preview of the file's contents in the view's reading pane. PowerToys adds multiple extensions: Markdown, SVG, PDF, G-code and QOI. In addition to those, PowerToys also adds support for source code files for more than 150 file extensions.

Expand All @@ -35,7 +35,7 @@ Expand the **Source code files (Monaco)** section to change the following settin
| Try to format the source for preview | Enable or disable formatting of the source code for json and xml files.<br />The original file stays unchanged. |
| Maximum file size to preview | Maximum file size in kilobytes to preview. |

### Enabling Preview Pane support
### Enabling Preview Pane

To enable preview support, set the extension to **On**.

Expand All @@ -58,7 +58,7 @@ Open Windows File Explorer, select the **View** tab in the Explorer ribbon, and
> [!NOTE]
> It is not possible to change the background color of the preview pane, so if you are working with transparent images with white shapes, you may not be able to see them in the preview.

## Thumbnail Previews
## Previewing files with thumbnail previews

To enable thumbnail preview support, set the extension to **On**.

Expand Down
2 changes: 1 addition & 1 deletion hub/powertoys/file-locksmith.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ File Locksmith is a Windows shell extension for checking which files are in use

![File Locksmith Demo.](../images/powertoys-file-locksmith.gif)

## How to activate and use File Locksmith
## Activating and using File Locksmith

To activate File Locksmith, open PowerToys and turn on the **Enable File Locksmith** toggle. Select one or more files or directories in Windows File Explorer. If a directory is selected, all of its files and subdirectories will be scanned as well. Right-click on the selected file(s), select **Show more options** from the menu to expand your list of menu options, then select **What's using this file?** to open File Locksmith and see which processes are using the file(s).

Expand Down
20 changes: 10 additions & 10 deletions hub/powertoys/grouppolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,25 @@ no-loc: [PowerToys, Windows, Group Policy, Win]

Since version 0.64, PowerToys is released on GitHub with Administrative Templates that allows you to configure PowerToys using Group Policies.

## How to install
## Installing PowerToys using Group Policy

### Download

You can find the latest administrative templates (ADMX files) in the assets section of our newest PowerToys release on <https://github.com/microsoft/PowerToys/releases>. The file is named `GroupPolicyObjectsFiles-<Version>.zip`.

### Add the administrative template to an individual computer
### Adding the administrative template to an individual computer

1. Copy the "PowerToys.admx" file to your Policy Definition template folder. (Example: C:\Windows\PolicyDefinitions)
2. Copy the "PowerToys.adml" file to the matching language folder in your Policy Definition folder. (Example: C:\Windows\PolicyDefinitions\en-US)

### Add the administrative template to Active Directory
### Adding the administrative template to Active Directory

1. On a domain controller or workstation with RSAT, go to the **PolicyDefinition** folder (also known as the *Central Store*) on any domain controller for your domain. For older versions of Windows Server, you might need to create the **PolicyDefinition** folder. For more information, see [How to create and manage the Central Store for Group Policy Administrative Templates in Windows](https://support.microsoft.com/help/3087759/how-to-create-and-manage-the-central-store-for-group-policy-administra).
2. Copy the "PowerToys.admx" file to the PolicyDefinition folder. (Example: %systemroot%\sysvol\domain\policies\PolicyDefinitions)
3. Copy the "PowerToys.adml" file to the matching language folder in the PolicyDefinition folder. Create the folder if it doesn't already exist. (Example: %systemroot%\sysvol\domain\policies\PolicyDefinitions\EN-US)
4. If your domain has more than one domain controller, the new ADMX files will be replicated to them at the next domain replication interval.

### Import the administrative template in Intune
### Importing the administrative template in Intune

You can find all instructions on how to import the administrative templates in Intune [here](/mem/intune/configuration/administrative-templates-import-custom#add-the-admx-and-adml-files).

Expand All @@ -42,7 +42,7 @@ You will find the policies under "Administrative Templates/Microsoft PowerToys"
The syntax of OMA-URI is the following: ./Device/Vendor/MSFT/Policy/Config/PowerToys~Policy~PowerToys[[~<category1>]~<categoryN>]/<ADMX-DisplayName-ID>
-->

### Configure global utility enabled state
### Configuring global utility enabled state

> Supported on PowerToys 0.75.0 or later.

Expand Down Expand Up @@ -74,7 +74,7 @@ The individual enabled state policies for the utilities will override this polic
- OMA-URI: `./Device/Vendor/MSFT/Policy/Config/PowerToys~Policy~PowerToys/ConfigureGlobalUtilityEnabledState`
- Example value: `<disabled/>`

### Configure enabled state for individual utilities
### Configuring enabled state for individual utilities

> Supported on PowerToys 0.64.0 or later depending on the utility.

Expand Down Expand Up @@ -155,7 +155,7 @@ These policies have a higher priority than the policy "Configure global utility

- Example value: `<disabled/>`

### Allow experimentation
### Allowing experimentation

> Supported on PowerToys 0.68.0 or later.

Expand Down Expand Up @@ -186,7 +186,7 @@ This policy configures whether PowerToys experimentation is allowed. With experi

### Installer and Updates

#### Disable per-user installation
#### Disabling per-user installation

> Supported on PowerToys 0.68.0 or later.

Expand Down Expand Up @@ -218,7 +218,7 @@ This policy configures whether PowerToys per-user installation is allowed or not
- OMA-URI: `./Device/Vendor/MSFT/Policy/Config/PowerToys~Policy~PowerToys~InstallerUpdates/DisablePerUserInstallation`
- Example value: `<enabled/>`

#### Disable automatic downloads
#### Disabling automatic downloads

> Supported on PowerToys 0.68.0 or later.

Expand Down Expand Up @@ -347,7 +347,7 @@ You can override this policy for individual plugins using the policy "Configure
- OMA-URI: `./Device/Vendor/MSFT/Policy/Config/PowerToys~Policy~PowerToys~PowerToysRun/PowerToysRunAllPluginsEnabledState`
- Example value: `<disabled/>`

#### Configure enabled state for individual plugins
#### Configuring enabled state for individual plugins

> Supported on PowerToys 0.75.0 or later.

Expand Down
6 changes: 3 additions & 3 deletions hub/powertoys/hosts-file-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ no-loc: [PowerToys, Windows, Hosts File Editor, Win]

# Hosts File Editor utility

Windows includes a local "Hosts" file that contains domain names and matching IP addresses, acting as a map to identify and locate hosts on IP networks. Every time you visit a website, your computer will check the hosts file first to see which IP address it connects to. If the information is not there, your internet service provider will look into the <abbr title="Domain Name Server">DNS</abbr> for the resources to load the site.
Windows includes a local "Hosts" file that contains domain names and matching IP addresses, acting as a map to identify and locate hosts on IP networks. Every time you visit a website, your computer will check the hosts file first to see which IP address it connects to. If the information is not there, your internet service provider will look into the Domain Name Server (DNS) for the resources to load the site.

The Hosts File Editor provides a convenient way to edit the hosts file configuration. This can be useful for scenarios like migrating a website to a new hosting provider or domain name, which may take a 24-48 hour period of downtime. Creating a custom IP address to associate with your domain using the hosts file can enable you to see how it will look on the new server.

Expand All @@ -32,7 +32,7 @@ To filter host file entries, select the filter icon and then enter characters in

![PowerToys Hosts File Editor: Filtering entries](../images/pt-hosts-file-editor-filter.gif)

## Back up Hosts file
## Backing up the hosts file

Hosts File Editor creates a backup of the hosts file before editing session. The backup files are located near the hosts file in `%SystemRoot%/System32/drivers/etc` named `hosts_PowerToysBackup_YYYYMMDDHHMMSS`.

Expand All @@ -47,7 +47,7 @@ From the Settings menu, the following options can be configured:
| Additional lines position | Default value is **Top**. If **Bottom** is selected, the file header is moved below hosts settings to the bottom. |
| Consider loopback addresses as duplicates | Loopback addresses (like 127.0.0.1 and ::1) are considered as duplicates. |

## Troubleshooting
## Troubleshooting Hosts File Editor

A "Failed to save hosts file" error appears if a change is made without administrator permissions:

Expand Down
6 changes: 5 additions & 1 deletion hub/powertoys/image-resizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ no-loc: [PowerToys, Windows, File Explorer, Image Resizer]

# Image Resizer utility

Image Resizer is a Windows shell extension for bulk image-resizing. After installing PowerToys, right-click on one or more selected image files in File Explorer, and select **Resize pictures** from the menu.
Image Resizer is a Windows shell extension for bulk image-resizing.

## Resizing images with Image Resizer

After installing PowerToys, right-click on one or more selected image files in File Explorer, and select **Resize pictures** from the menu.

![Image Resizer Demo.](../images/powertoys-resize-images.gif)

Expand Down
8 changes: 4 additions & 4 deletions hub/powertoys/keyboard-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ There are a few rules to follow when remapping shortcuts. These rules only apply
- Shortcuts must end with an action key (all non-modifier keys): A, B, C, 1, 2, 3, etc.
- Shortcuts cannot be longer than four keys

### Remap a shortcut to a single key
### Remapping a shortcut to a single key

It is possible to remap a shortcut (key combination) to a single key press by selecting **Remap a shortcut** in PowerToys Settings.

Expand All @@ -114,7 +114,7 @@ For example, to replace the shortcut <kbd>⊞ Win</kbd>+<kbd>←</kbd> (left arr
> [!IMPORTANT]
> Shortcut remapping will be maintained even if the remapped key is used inside another shortcut. The order of key press matters in this scenario as the action is executed during key-down, not key-up. For example: pressing <kbd>⊞ Win</kbd>+<kbd>←</kbd>+<kbd>Shift</kbd> would result in `Alt` + `Shift`.

### Remap a shortcut to text
### Remapping a shortcut to text

For example, to replace the shortcut <kbd>Ctrl</kbd>+<kbd>G</kbd> with `Hello!` text, first select "Text" in the combo box and then fill the text box with "Hello!":

Expand Down Expand Up @@ -144,7 +144,7 @@ Keyboard Manager uses process-names (not application names) to target apps. For
| Word | winword.exe |
| Powerpoint | powerpnt.exe |

## How to select a key
## Selecting a key

To select a key or shortcut to remap:

Expand Down Expand Up @@ -197,7 +197,7 @@ Keyboard Manager lists mappings for all known physical keyboard keys. Some of th

![PowerToys Keyboard Manager List of Keys.](../images/pt-key-remap-drop-down.png)

## Troubleshooting
## Troubleshooting Keyboard Manager

If you have tried to remap a key or shortcut and are having trouble, it could be one of the following issues:

Expand Down
6 changes: 3 additions & 3 deletions hub/powertoys/mouse-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no-loc: [PowerToys, Windows, Mouse, jump]

Mouse utilities is a collection of features that enhance mouse and cursor functionality on Windows.

## Find my mouse
## Find My Mouse

Activate a spotlight that focuses on the cursor's position pressing the <kbd>Ctrl</kbd> key twice, using a custom shortcut or shaking the mouse. Click the mouse or press any keyboard key to dismiss it. If you move the mouse while the spotlight is active, the spotlight will dismiss on its own shortly after the mouse stops moving.

Expand Down Expand Up @@ -56,7 +56,7 @@ From the settings page, the following options can be configured:
| Fade delay | How long it takes before a highlight starts to disappear - Measured in milliseconds. |
| Fade duration | Duration of the disappear animation - Measured in milliseconds. |

## Mouse jump
## Mouse Jump

![Screenshot of Mouse jump.](../images/pt-mouse-jump.gif)

Expand All @@ -66,7 +66,7 @@ Mouse jump allows moving the mouse pointer long distances on a single screen or
| :--- | :--- |
| Activation shortcut | The customizable keyboard command to activate the mouse jump. |

## Mouse pointer Crosshairs
## Mouse Pointer Crosshairs

![Screenshot of Crosshairs.](../images/pt-mouseutilities-crosshairs.png)

Expand Down
8 changes: 4 additions & 4 deletions hub/powertoys/mouse-without-borders.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ms.topic: article
no-loc: [PowerToys, Windows, Mouse without borders]
---

# Mouse Without Borders
# Mouse Without Borders utility

**Mouse Without Borders** enables you to control up to 4 computers from the same machine.

Expand All @@ -16,11 +16,11 @@ Features:
- Share clipboard between the machines.
- Transfer files between the machines.

## How to use Mouse Without Borders
## Using Mouse Without Borders

With the latest version of PowerToys installed, you will see Mouse Without Borders listed in the PowerToys Settings, where you will need to do some initial configuration.

### Initial configuration
### Setting up Mouse Without Borders

1. Open Mouse Without borders in PowerToys Settings to configure your connections.

Expand All @@ -40,7 +40,7 @@ It's possible to switch the order of the devices by dragging the device icon to

![Animation of Mouse Without Borders settings configuring device layout.](../images/powertoys-mouse-without-borders-drag-device-layout.gif)

### Install Mouse Without Borders as a service
### Installing Mouse Without Borders as a service

To allow Mouse Without Borders to control elevated applications or the lock screen from another computer, it's possible to run Mouse Without Borders as a service under the System account.

Expand Down
Loading