From 4bf8deb423fd17fb864669471d4802af1f83506c Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 1 Apr 2025 09:34:13 -0500 Subject: [PATCH 1/2] Update capitalization (#11971) --- .../Microsoft.PowerShell.Core/About/About.md | 6 +- ...Ise_exe.md => about_PowerShell_ISE_exe.md} | 60 ++++++++++--------- ...5.1.md => about_Windows_PowerShell_5.1.md} | 37 ++++-------- .../About/about_Windows_PowerShell_ISE.md | 42 ++++++++----- .../learn/ps101/02-help-system.md | 3 +- 5 files changed, 77 insertions(+), 71 deletions(-) rename reference/5.1/Microsoft.PowerShell.Core/About/{about_PowerShell_Ise_exe.md => about_PowerShell_ISE_exe.md} (63%) rename reference/5.1/Microsoft.PowerShell.Core/About/{about_Windows_Powershell_5.1.md => about_Windows_PowerShell_5.1.md} (86%) diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/About.md b/reference/5.1/Microsoft.PowerShell.Core/About/About.md index 0cd214343b49..def241d6b906 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/About.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/About.md @@ -2,7 +2,7 @@ description: About topics cover a range of concepts about PowerShell. Help Version: 6.0 Locale: en-US -ms.date: 01/21/2025 +ms.date: 04/01/2025 title: About topics --- # About topics @@ -375,7 +375,7 @@ Combining commands into pipelines in the PowerShell Explains how to use the `powershell.exe` command-line interface. Displays the command-line parameters and describes the syntax. -### [about_PowerShell_Ise_exe](about_PowerShell_Ise_exe.md) +### [about_PowerShell_ISE_exe](about_PowerShell_ISE_exe.md) Explains how to use the `powershell_ise.exe` command-line tool. @@ -627,7 +627,7 @@ the results of a conditional test. Describes how to use wildcard characters in PowerShell. -### [about_Windows_Powershell_5.1](about_Windows_Powershell_5.1.md) +### [about_Windows_PowerShell_5.1](about_Windows_PowerShell_5.1.md) Describes new features that are included in Windows PowerShell 5.1. diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_PowerShell_Ise_exe.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_PowerShell_ISE_exe.md similarity index 63% rename from reference/5.1/Microsoft.PowerShell.Core/About/about_PowerShell_Ise_exe.md rename to reference/5.1/Microsoft.PowerShell.Core/About/about_PowerShell_ISE_exe.md index d9b37bf0369b..a7408e4d79a6 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_PowerShell_Ise_exe.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_PowerShell_ISE_exe.md @@ -1,13 +1,13 @@ --- description: Explains how to use the `powershell_ise.exe` command-line tool. Locale: en-US -ms.date: 06/09/2017 +ms.date: 04/01/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_powershell_ise_exe?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 -title: about_PowerShell_Ise_exe +title: about_PowerShell_ISE_exe --- -# about_PowerShell_Ise_exe +# about_PowerShell_ISE_exe ## Short description @@ -35,10 +35,10 @@ ISE ### -File -Opens the specified files in Windows PowerShell ISE. The -parameter name ("-File") is optional. To list more than one -file, enter one text string enclosed in quotation marks. Use -commas to separate the file names within the string. +Opens the specified files in Windows PowerShell ISE. The parameter name +("-File") is optional. To list more than one file, enter one text string +enclosed in quotation marks. Use commas to separate the file names within the +string. For example: @@ -46,18 +46,17 @@ For example: powershell_ise -File "File1.ps1,File2.ps1,File3.xml". ``` -Spaces between the file names are permitted in Windows PowerShell, -but might not be interpreted correctly by other programs, such as -Cmd.exe. +Spaces between the file names are permitted in Windows PowerShell, but might +not be interpreted correctly by other programs, such as Cmd.exe. -You can use this parameter to open any text file, including Windows -PowerShell script files and XML files. +You can use this parameter to open any text file, including Windows PowerShell +script files and XML files. ### -MTA -Starts Windows PowerShell ISE using a multi-threaded apartment. This -parameter is introduced in Windows PowerShell 3.0. Single-threaded -apartment (STA) is the default. +Starts Windows PowerShell ISE using a multi-threaded apartment. This parameter +is introduced in Windows PowerShell 3.0. Single-threaded apartment (STA) is the +default. ### -NoProfile @@ -65,8 +64,8 @@ Does not run Windows PowerShell profiles. By default, Windows PowerShell profiles are run in every session. This parameter is recommended when you are writing shared content, such as -functions and scripts that will be run on systems with different profiles. -For more information, see [about_Profiles](about_Profiles.md). +functions and scripts that will be run on systems with different profiles. For +more information, see [about_Profiles][03]. ### -Help -?, /? @@ -74,8 +73,8 @@ Displays help for `powershell_ise.exe`. ## Examples -These commands start Windows PowerShell ISE. The commands are equivalent -and can be used interchangeably. +These commands start Windows PowerShell ISE. The commands are equivalent and +can be used interchangeably. ``` PS C:> powershell_ise.exe @@ -83,8 +82,8 @@ PS C:> powershell_ise PS C:> ISE ``` -These commands open the Get-Profile.ps1 script in Windows PowerShell ISE. -The commands are equivalent and can be used interchangeably. +These commands open the Get-Profile.ps1 script in Windows PowerShell ISE. The +commands are equivalent and can be used interchangeably. ``` PS C:> powershell_ise.exe -File .\Get-Profile.ps1 @@ -92,10 +91,9 @@ PS C:> ISE -File .\Get-Profile.ps1 PS C:> ISE .\Get-Profile.ps1 ``` -This command opens the Get-Backups.ps1 and Get-BackupInstance.ps1 scripts -in Windows PowerShell ISE. To open more than one file, use a comma to -separate the file names and enclose the entire file name value in quotation -marks. +This command opens the Get-Backups.ps1 and Get-BackupInstance.ps1 scripts in +Windows PowerShell ISE. To open more than one file, use a comma to separate the +file names and enclose the entire file name value in quotation marks. ``` PS C:> ISE -File ".\Get-Backups.ps1,Get-BackupInstance.ps1" @@ -115,6 +113,12 @@ PS C:> ISE -Help ## See also -- [about_PowerShell_exe](about_PowerShell_exe.md) -- [about_Windows_PowerShell_ISE](about_Windows_PowerShell_ISE.md) -- [Windows PowerShell Integrated Scripting Environment (ISE)](/powershell/scripting/windows-powershell/ise/introducing-the-windows-powershell-ise) +- [about_PowerShell_exe][02] +- [about_Windows_PowerShell_ISE][04] +- [Windows PowerShell Integrated Scripting Environment (ISE)][01] + + +[01]: /powershell/scripting/windows-powershell/ise/introducing-the-windows-powershell-ise +[02]: about_PowerShell_exe.md +[03]: about_Profiles.md +[04]: about_Windows_PowerShell_ISE.md diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_Powershell_5.1.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_PowerShell_5.1.md similarity index 86% rename from reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_Powershell_5.1.md rename to reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_PowerShell_5.1.md index 6ce0015bdd08..71dfd39ff916 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_Powershell_5.1.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_PowerShell_5.1.md @@ -1,10 +1,10 @@ --- description: Describes new features that are included in Windows PowerShell 5.1. Locale: en-US -ms.date: 10/23/2023 +ms.date: 04/01/2025 online version: https://learn.microsoft.com/powershell/module/about_windows_powershell_5.1?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 -title: about_Windows_Powershell_5.1 +title: about_Windows_PowerShell_5.1 --- # about_Windows_PowerShell_5.1 @@ -24,7 +24,7 @@ snap-ins, scripts, functions, and profiles that were designed for Windows PowerShell 4.0, Windows PowerShell 3.0, and Windows PowerShell 2.0 generally work in Windows PowerShell 5.1 without changes. -- New cmdlets: local users and groups; Get-ComputerInfo +- New cmdlets: local users and groups; `Get-ComputerInfo` - PowerShellGet improvements include enforcing signed modules, and installing JEA modules - PackageManagement added support for Containers, CBS Setup, EXE-based setup, @@ -37,11 +37,6 @@ work in Windows PowerShell 5.1 without changes. Windows PowerShell 5.1 is installed by default on Windows Server version 2016 and higher and Windows client version 10 and higher. -To install Windows PowerShell 5.1 on older versions of Windows, see -[Install and Configure WMF 5.1][09]. Be sure to read the download details, and -meet all system requirements, before you install Windows Management Framework -5.1. - You can also read about changes to Windows PowerShell 5.1 in [What's New in Windows PowerShell][08]. @@ -57,7 +52,7 @@ denote varying feature sets and platform compatibility. and modules targeting versions of PowerShell running on reduced footprint editions of Windows such as Nano Server and Windows IoT. -**Learn more about using PowerShell Editions** +Learn more about using PowerShell Editions - [Determine running edition of PowerShell using $PSVersionTable][04] - [Filter Get-Module results by CompatiblePSEditions using PSEdition parameter][05] @@ -77,7 +72,7 @@ distribute the set of folders along with corresponding catalog file representing those folders. This information is useful to validate whether any changes have been made to the folders since catalog creation time. -``` +```Syntax New-FileCatalog [-CatalogFilePath] [[-Path] ] [-CatalogVersion ] [-WhatIf] [-Confirm] [] ``` @@ -86,14 +81,14 @@ Catalog versions 1 and 2 are supported. Version 1 uses the SHA1 hashing algorithm to create file hashes; version 2 uses SHA256. You should use catalog version 2. -To verify the integrity of catalog file (Pester.cat in above example), sign it -using [Set-AuthenticodeSignature][07] cmdlet. +To verify the integrity of catalog file (`Pester.cat` in above example), sign +it using [Set-AuthenticodeSignature][07] cmdlet. #### Test-FileCatalog `Test-FileCatalog` validates the catalog representing a set of folders. -``` +```Syntax Test-FileCatalog [-Detailed] [-FilesToSkip ] [-CatalogFilePath] [[-Path] ] [-WhatIf] [-Confirm] [] @@ -113,12 +108,12 @@ Starting with WMF 5.1, PowerShell provides control over the file that's used to cache data about a module, such as the commands it exports. By default, this cache is stored in the file -`${Env:LOCALAPPDATA}\Microsoft\Windows\PowerShell\ModuleAnalysisCache`. The +`${env:LOCALAPPDATA}\Microsoft\Windows\PowerShell\ModuleAnalysisCache`. The cache is typically read at startup while searching for a command and is written on a background thread sometime after a module is imported. To change the default location of the cache, set the -`$Env:PSModuleAnalysisCachePath` environment variable before starting +`$env:PSModuleAnalysisCachePath` environment variable before starting PowerShell. Changes to this environment variable only affect child processes. The value should name a full path (including filename) that PowerShell has permission to create and write files. To disable the file cache, set this value @@ -160,20 +155,15 @@ In WMF 5.1: - You can use [ModuleSpecification Constructor (Hashtable)][01]. This hash table has the same format as `Get-Module -FullyQualifiedName`. - **Example:** `using module @{ModuleName = 'PSReadLine'; RequiredVersion = '1.1'}` + Example: `using module @{ModuleName = 'PSReadLine'; RequiredVersion = '1.1'}` - If there are multiple versions of the module, PowerShell uses the **same resolution logic** as `Import-Module` and doesn't return an error. ### Improvements to Pester -In WMF 5.1, the version of Pester that ships with PowerShell has been updated -from 3.3.5 to 3.4.0. You can review the changes in versions 3.3.5 to 3.4.0 by -inspecting the [CHANGELOG][11] in the GitHub repository. - -## KEYWORDS - -What's New in Windows PowerShell 5.1 +WMF 5.1 ships with Pester v3.4.0. For more information about this version, see +the [CHANGELOG][11] in the GitHub repository. [01]: /dotnet/api/microsoft.powershell.commands.modulespecification.-ctor @@ -184,6 +174,5 @@ What's New in Windows PowerShell 5.1 [06]: /powershell/module/microsoft.powershell.security/get-authenticodesignature [07]: /powershell/module/microsoft.powershell.security/set-authenticodesignature [08]: /powershell/scripting/windows-powershell/whats-new/what-s-new-in-windows-powershell-50 -[09]: /powershell/scripting/wmf/setup/install-configure [10]: /previous-versions/windows/powershell-scripting/hh847877(v=wps.640) [11]: https://github.com/pester/Pester/blob/main/docs/CHANGELOG.md diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_PowerShell_ISE.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_PowerShell_ISE.md index 56e7c56f6aee..d274bb3e5c22 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_PowerShell_ISE.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Windows_PowerShell_ISE.md @@ -38,7 +38,7 @@ Windows PowerShell ISE introduces two new features in Windows PowerShell 4.0. - Windows PowerShell ISE now supports both Windows PowerShell Workflow debugging and remote script debugging. For more Information, see - [about_Debuggers](about_Debuggers.md). + [about_Debuggers][02]. - IntelliSense support has been added for Windows PowerShell Desired State Configuration providers and configurations. @@ -54,7 +54,7 @@ supported versions of Windows. - In a Windows PowerShell console, Cmd.exe, or the Run or Search box in Windows, type `powershell_ise.exe`. You can also use the command-line parameters, including the NoProfile switch. For more information, see - [about_PowerShell_Ise_exe](about_powershell_ise_exe.md). + [about_PowerShell_ISE_exe][03]. ## Running Interactive Commands @@ -177,7 +177,7 @@ are in any Windows PowerShell host program. However, the items in your Windows PowerShell console profiles are not available in Windows PowerShell ISE. Instructions for moving and reconfiguring your profiles are available in -Windows PowerShell ISE Help and in [about_Profiles](about_Profiles.md). +Windows PowerShell ISE Help and in [about_Profiles][04]. ## Notes @@ -198,17 +198,31 @@ If the graphical elements of Windows PowerShell ISE do not render correctly on your system, you might resolve the problem by adding or adjusting the "Disable WPF Hardware acceleration" graphics rendering settings on your system. For more information, see -[Graphics Rendering Registry Settings](/dotnet/framework/wpf/graphics-multimedia/graphics-rendering-registry-settings). +[Graphics Rendering Registry Settings][01]. ## See also -- [about_Debuggers](about_Debuggers.md) -- [about_Profiles](about_Profiles.md) -- [about_Updatable_Help](about_Updatable_Help.md) -- [Show-Command](xref:Microsoft.PowerShell.Utility.Show-Command) -- [Get-Help](xref:Microsoft.PowerShell.Core.Get-Help) -- [Save-Help](xref:Microsoft.PowerShell.Core.Save-Help) -- [Update-Help](xref:Microsoft.PowerShell.Core.Update-Help) -- [Get-IseSnippet](xref:ISE.Get-IseSnippet) -- [Import-IseSnippet](xref:ISE.Import-IseSnippet) -- [New-IseSnippet](xref:ISE.New-IseSnippet) +- [about_Debuggers][02] +- [about_Profiles][04] +- [about_Updatable_Help][05] +- [Show-Command][12] +- [Get-Help][09] +- [Save-Help][10] +- [Update-Help][11] +- [Get-IseSnippet][06] +- [Import-IseSnippet][07] +- [New-IseSnippet][08] + + +[01]: /dotnet/framework/wpf/graphics-multimedia/graphics-rendering-registry-settings +[02]: about_Debuggers.md +[03]: about_PowerShell_ISE_exe.md +[04]: about_Profiles.md +[05]: about_Updatable_Help.md +[06]: xref:ISE.Get-IseSnippet +[07]: xref:ISE.Import-IseSnippet +[08]: xref:ISE.New-IseSnippet +[09]: xref:Microsoft.PowerShell.Core.Get-Help +[10]: xref:Microsoft.PowerShell.Core.Save-Help +[11]: xref:Microsoft.PowerShell.Core.Update-Help +[12]: xref:Microsoft.PowerShell.Utility.Show-Command diff --git a/reference/docs-conceptual/learn/ps101/02-help-system.md b/reference/docs-conceptual/learn/ps101/02-help-system.md index 9214c6bf8b80..8e50cf4f74c1 100644 --- a/reference/docs-conceptual/learn/ps101/02-help-system.md +++ b/reference/docs-conceptual/learn/ps101/02-help-system.md @@ -597,7 +597,7 @@ about_Simplified_Syntax HelpFile about_Switch HelpFile about_Variables HelpFile about_Variable_Provider HelpFile -about_Windows_Powershell_5.1 HelpFile +about_Windows_PowerShell_5.1 HelpFile about_WQL HelpFile about_WS-Management_Cmdlets HelpFile about_Foreach-Parallel HelpFile @@ -943,7 +943,6 @@ articles. In the next chapter, you'll learn about objects, properties, methods, and the `Get-Member` cmdlet. - [help]: /powershell/module/microsoft.powershell.core/get-help [gcm]: /powershell/module/microsoft.powershell.core/get-command [update-help]: /powershell/module/microsoft.powershell.core/update-help From 4a0c00b72b6f17106aa67e120e345d37abacbb43 Mon Sep 17 00:00:00 2001 From: "Mike F. Robbins" Date: Tue, 1 Apr 2025 15:52:43 -0500 Subject: [PATCH 2/2] Updated azps quick filter link for 13.4.0 (#11972) Co-authored-by: Mike F. Robbins --- reference/module/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/module/index.md b/reference/module/index.md index 774ced706119..327783c78a07 100644 --- a/reference/module/index.md +++ b/reference/module/index.md @@ -12,7 +12,7 @@ ms.manager: sewhee ms.product: powershell ms.topic: landing-page quickFilterColumn1: powershell-7.4,windowsserver2025-ps -quickFilterColumn2: azps-13.3.0,sqlserver-ps +quickFilterColumn2: azps-13.4.0,sqlserver-ps quickFilterColumn3: graph-powershell-1.0,systemcenter-ps-2022 title: PowerShell Module Browser ---