Skip to content

Commit a178933

Browse files
Fix incorrect case/capitalization in reference documents (30/38) (#11938)
* Fix incorrect case/capitalization in ref docs This ensures the following components have the correct/consistent case throughout the reference documentation: Preference variable, PS environment variable, PS drive, PS provider, PS command name, PS command argument, PS module, PS file extension, PS host name/application, #Requires statement, parameter name, about_* topic, member name, scope modifier, keyword, operator, calculated property key/value, attribute, type accelerator, type literal/name, WMI namespace/class, variable name, special character, comment-based help keyword, product/company name, Windows drive letter/directory, Windows/Unix environment variable In addition, changes include fixes to incorrect terminology (e.g., referring to a keyword as a command) and formatting of PS syntax elements (non-exhaustive). * Fix formatting and links in Export-Console.md * Format PowerShell code and fix line breaks --------- Co-authored-by: Sean Wheeler <[email protected]>
1 parent 3800ff7 commit a178933

40 files changed

+243
-235
lines changed

reference/5.1/ISE/Get-IseSnippet.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ function Parse-Snippet {
7171
foreach ($SnippetFile in $SnippetFiles) {
7272
Write-Host ""
7373
$Title = Select-Xml -Path $SnippetFile.FullName -Namespace $SnippetNamespace -XPath "//x:Title" |
74-
ForEach-Object {$_.Node.InnerXML}
74+
ForEach-Object {$_.Node.InnerXml}
7575
$Text = Select-Xml -Path $SnippetFile.FullName -Namespace $SnippetNamespace -XPath "//x:Script" |
7676
ForEach-Object {$_.Node.InnerText}
7777
Write-Host "Title: $Title"
@@ -83,10 +83,10 @@ function Parse-Snippet {
8383
```Output
8484
Title: Mandatory
8585
Text:
86-
Param
86+
param
8787
(
88-
[parameter(Mandatory=True)]
89-
[String[]]
88+
[Parameter(Mandatory=True)]
89+
[string[]]
9090
$<ParameterName>
9191
)
9292
@@ -138,7 +138,7 @@ This cmdlet returns a file object representing the snippet file.
138138

139139
## NOTES
140140

141-
- The `New-IseSnippet` cmdlet stores new user-created snippets in unsigned .ps1xml files. As such,
141+
- The `New-IseSnippet` cmdlet stores new user-created snippets in unsigned `.ps1xml` files. As such,
142142
Windows PowerShell cannot add them to a session in which the execution policy is **AllSigned** or
143143
**Restricted**. In a **Restricted** or **AllSigned** session, you can create, get, and import
144144
unsigned user-created snippets, but you cannot use them in the session.

reference/5.1/ISE/Import-IseSnippet.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Snippets** or press <kbd>Ctrl</kbd>+<kbd>J</kbd>.
3838
Imported snippets are available only in the current session. To import the snippets into all Windows
3939
PowerShell ISE sessions, add an `Import-IseSnippet` command to your Windows PowerShell profile or
4040
copy the snippet files to your local snippets directory
41-
`$HOME\Documents\WindowsPowershell\Snippets`.
41+
`$HOME\Documents\WindowsPowerShell\Snippets`.
4242

4343
To import snippets, they must be properly formatted in the snippet XML for Windows PowerShell ISE
4444
snippets and saved in Snippet.ps1xml files. To create eligible snippets, use the `New-IseSnippet`
@@ -78,9 +78,9 @@ Import-IseSnippet -Module SnippetModule -ListAvailable
7878
This example gets snippets in all installed modules in the **PSModulePath** environment variable.
7979

8080
```powershell
81-
($env:PSModulePath).split(";") |
81+
($Env:PSModulePath).Split(";") |
8282
ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
83-
ForEach-Object {$_.Fullname}
83+
ForEach-Object {$_.FullName}
8484
```
8585

8686
### Example 4: Import all module snippets
@@ -90,7 +90,7 @@ you don't need to run a command like this because modules that have snippets wil
9090
`Import-IseSnippet` cmdlet to import them for you when the module is imported.
9191

9292
```powershell
93-
($env:PSModulePath).split(";") |
93+
($Env:PSModulePath).Split(";") |
9494
ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
9595
ForEach-Object {$psISE.CurrentPowerShellTab.Snippets.Load($_)}
9696
```
@@ -102,7 +102,7 @@ the current user. Unlike imported snippets, which affect only the current sessio
102102
are available in every Windows PowerShell ISE session.
103103

104104
```powershell
105-
($env:PSModulePath).split(";") |
105+
($Env:PSModulePath).Split(";") |
106106
ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
107107
Copy-Item -Destination $HOME\Documents\WindowsPowerShell\Snippets
108108
```
@@ -215,7 +215,7 @@ This cmdlet returns no output.
215215
**Microsoft.PowerShell.Host.ISE.ISESnippetCollection** objects. You can also use the **Load**
216216
method of snippets in the Windows PowerShell ISE object model:
217217
`$psISE.CurrentPowerShellTab.Snippets.Load()`
218-
- The `New-IseSnippet` cmdlet stores new user-created snippets in unsigned .ps1xml files. As such,
218+
- The `New-IseSnippet` cmdlet stores new user-created snippets in unsigned `.ps1xml` files. As such,
219219
Windows PowerShell cannot load them into a session in which the execution policy is **AllSigned**
220220
or **Restricted**. In a **Restricted** or **AllSigned** session, you can create, get, and import
221221
unsigned user-created snippets, but you cannot use them in the session.

reference/5.1/ISE/New-IseSnippet.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ This command creates a Comment-BasedHelp snippet for Windows PowerShell ISE. It
6666

6767
```powershell
6868
$M = @'
69-
Param
69+
param
7070
(
71-
[parameter(Mandatory=$true)]
72-
[String[]]
71+
[Parameter(Mandatory=$true)]
72+
[string[]]
7373
$<ParameterName>
7474
)
7575
'@
@@ -227,7 +227,7 @@ This cmdlet returns no output.
227227

228228
## NOTES
229229

230-
`New-IseSnippet` stores new user-created snippets in unsigned .ps1xml files. As such, Windows
230+
`New-IseSnippet` stores new user-created snippets in unsigned `.ps1xml` files. As such, Windows
231231
PowerShell cannot add them to a session in which the execution policy is **AllSigned** or
232232
**Restricted**. In a **Restricted** or **AllSigned** session, you can create, get, and import
233233
unsigned user-created snippets, but you cannot use them in the session.

reference/5.1/Microsoft.PowerShell.Core/About/about_DesiredStateConfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ have defined (two in the example above). For example, in this case:
9292

9393
```powershell
9494
MyWebConfig -MachineName "TestMachine" -WebsiteFilePath `
95-
"\\filesrv\WebFiles" -OutputPath "C:\Windows\system32\temp"
95+
"\\filesrv\WebFiles" -OutputPath "C:\Windows\system32\Temp"
9696
# OutputPath is optional
9797
```
9898

@@ -103,7 +103,7 @@ configuration, and enact those configurations. Note that you do not need to
103103
create a separate MOF file for class-based DSC resources.
104104

105105
```powershell
106-
Start-DscConfiguration -Verbose -Wait -Path "C:\Windows\system32\temp"
106+
Start-DscConfiguration -Verbose -Wait -Path "C:\Windows\system32\Temp"
107107
```
108108

109109
## USING DSC TO MAINTAIN CONFIGURATION STATE

reference/5.1/Microsoft.PowerShell.Core/About/about_Eventlogs.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Get-WmiObject Win32_NTEventlogFile |
7474
To find the Win32 event-related WMI classes, type:
7575

7676
```powershell
77-
Get-WmiObject -List | where Name -Like "win32*event*"
77+
Get-WmiObject -List | where Name -Like "Win32*Event*"
7878
```
7979

8080
For more information, see [Get-EventLog][05] and [Get-WmiObject][06].
@@ -86,48 +86,48 @@ recorded in the Windows PowerShell event log.
8686

8787
There are six event log preference variables; two variables for each of the
8888
three logging components: the engine (the Windows PowerShell program), the
89-
providers, and the commands. The LifeCycleEvent variables log normal starting
90-
and stopping events. The Health variables log error events.
89+
providers, and the commands. The `LifecycleEvent` variables log normal starting
90+
and stopping events. The `Health` variables log error events.
9191

9292
The following table lists the event log preference variables.
9393

9494
| Variable | Description |
9595
| ---------------------------- | ----------------------------------------------- |
96-
| `$LogEngineLifeCycleEvent` | Logs the start and stop of PowerShell |
96+
| `$LogEngineLifecycleEvent` | Logs the start and stop of PowerShell |
9797
| `$LogEngineHealthEvent` | Logs PowerShell program errors |
98-
| `$LogProviderLifeCycleEvent` | Logs the start and stop of PowerShell providers |
98+
| `$LogProviderLifecycleEvent` | Logs the start and stop of PowerShell providers |
9999
| `$LogProviderHealthEvent` | Logs PowerShell provider errors |
100-
| `$LogCommandLifeCycleEvent` | Logs the starting and completion of commands |
100+
| `$LogCommandLifecycleEvent` | Logs the starting and completion of commands |
101101
| `$LogCommandHealthEvent` | Logs command errors |
102102

103103
(For information about Windows PowerShell providers, see
104104
[about_Providers][01].)
105105

106106
By default, only the following event types are enabled:
107107

108-
- `$LogEngineLifeCycleEvent`
108+
- `$LogEngineLifecycleEvent`
109109
- `$LogEngineHealthEvent`
110-
- `$LogProviderLifeCycleEvent`
110+
- `$LogProviderLifecycleEvent`
111111
- `$LogProviderHealthEvent`
112112

113113
To enable an event type, set the preference variable for that event type to
114114
`$true`. For example, to enable command life-cycle events, type:
115115

116116
```powershell
117-
$LogCommandLifeCycleEvent
117+
$LogCommandLifecycleEvent
118118
```
119119

120120
Or, type:
121121

122122
```powershell
123-
$LogCommandLifeCycleEvent = $true
123+
$LogCommandLifecycleEvent = $true
124124
```
125125

126126
To disable an event type, set the preference variable for that event type to
127127
`$false`. For example, to disable command life-cycle events, type:
128128

129129
```powershell
130-
$LogProviderLifeCycleEvent = $false
130+
$LogProviderLifecycleEvent = $false
131131
```
132132

133133
You can disable any event, except for the events that indicate that the Windows

reference/5.1/Microsoft.PowerShell.Core/About/about_Logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ private key:
147147

148148
```powershell
149149
Get-WinEvent Microsoft-Windows-PowerShell/Operational |
150-
Where-Object Id -eq 4104 |
150+
Where-Object Id -EQ 4104 |
151151
Unprotect-CmsMessage
152152
```
153153

reference/5.1/Microsoft.PowerShell.Core/About/about_PSSnapins.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ Get-PSSnapin
4545
To get the snap-in for each Windows PowerShell provider, type:
4646

4747
```powershell
48-
Get-PSProvider | Format-List name, pssnapin
48+
Get-PSProvider | Format-List Name, PSSnapIn
4949
```
5050

5151
To get all the registered snap-ins on your system or to verify that a snap-in
5252
is registered, type:
5353

5454
```powershell
55-
Get-PSSnapin -registered
55+
Get-PSSnapin -Registered
5656
```
5757

5858
To get a list of the cmdlets in a Windows PowerShell snap-in, type:
@@ -70,7 +70,7 @@ your session.
7070

7171
## Add a snap-in to the current session
7272

73-
To add a registered snap-in to the current session, use the `Add-PsSnapin`
73+
To add a registered snap-in to the current session, use the `Add-PSSnapin`
7474
cmdlet. For example, to add the Microsoft SQL Server snap-in to the session,
7575
type:
7676

@@ -84,15 +84,15 @@ session unless you save them.
8484

8585
## Save a snap-ins
8686

87-
To use a snap-in in future Windows PowerShell sessions, add the `Add-PsSnapin`
87+
To use a snap-in in future Windows PowerShell sessions, add the `Add-PSSnapin`
8888
command to your Windows PowerShell profile. Or, export the snap-in names to a
8989
console file.
9090

9191
If you add the `Add-PSSnapin` command to your profile, it's available in all
9292
future Windows PowerShell sessions. If you export the names of the snap-ins in
9393
your session, you can use the export file only when you need the snap-ins.
9494

95-
To add the `Add-PsSnapin` command to your Windows PowerShell profile, open your
95+
To add the `Add-PSSnapin` command to your Windows PowerShell profile, open your
9696
profile, paste or type the command, and then save the profile. For more
9797
information, see [about_Profiles][03].
9898

@@ -111,12 +111,12 @@ For more information, see [Export-Console][05].
111111

112112
To use a console file that includes the snap-in, start Windows PowerShell
113113
(`powershell.exe`) from the command prompt in `cmd.exe` or in another Windows
114-
PowerShell session. Use the **PsConsoleFile** parameter to specify the console
114+
PowerShell session. Use the **PSConsoleFile** parameter to specify the console
115115
file that includes the snap-in. For example, the following command starts
116116
Windows PowerShell with the `NewConsole.psc1` console file:
117117

118118
```powershell
119-
PowerShell.exe -psconsolefile NewConsole.psc1
119+
powershell.exe -PSConsoleFile NewConsole.psc1
120120
```
121121

122122
The providers and cmdlets in the snap-in are now available for use in the
@@ -125,7 +125,7 @@ session.
125125
## Remove a snap-in
126126

127127
To remove a Windows PowerShell snap-in from the current session, use the
128-
`Remove-PsSnapin` cmdlet. For example, to remove the SQL Server snap-in from the
128+
`Remove-PSSnapin` cmdlet. For example, to remove the SQL Server snap-in from the
129129
current session, type:
130130

131131
```powershell
@@ -148,9 +148,9 @@ For more information, see [about_EventLogs][01].
148148
- [about_Profiles][03]
149149
- [Get-Command][06]
150150
- [Export-Console][05]
151-
- [Add-PsSnapin][04]
152-
- [Get-PsSnapin][07]
153-
- [Remove-PsSnapin][08]
151+
- [Add-PSSnapin][04]
152+
- [Get-PSSnapin][07]
153+
- [Remove-PSSnapin][08]
154154

155155
<!-- link references -->
156156
[01]: about_EventLogs.md

reference/5.1/Microsoft.PowerShell.Core/About/about_PowerShell_Ise_exe.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Explains how to use the PowerShell_Ise.exe command-line tool.
2+
description: Explains how to use the `powershell_ise.exe` command-line tool.
33
Locale: en-US
44
ms.date: 06/09/2017
55
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
@@ -11,23 +11,22 @@ title: about_PowerShell_Ise_exe
1111

1212
## Short description
1313

14-
Explains how to use the PowerShell_Ise.exe command-line tool.
14+
Explains how to use the `powershell_ise.exe` command-line tool.
1515

1616
## Long description
1717

18-
PowerShell_Ise.exe starts a Windows PowerShell Integrated
18+
Running `powershell_ise.exe` starts a Windows PowerShell Integrated
1919
Scripting Environment (ISE) session. You can run it in Cmd.exe
2020
and in Windows PowerShell.
2121

22-
To run PowerShell_ISE.exe, type PowerShell_ISE.exe, PowerShell_ISE,
23-
or ISE.
22+
To run Windows PowerShell ISE, type `powershell_ise.exe`, `powershell_ise`,
23+
or `ISE`.
2424

2525
## Syntax
2626

2727
```
28-
PowerShell_Ise[.exe]
29-
PowerShell_ISE[.exe]
30-
ISE[.exe]
28+
powershell_ise[.exe]
29+
ISE
3130
[-File]<FilePath[]> [-NoProfile] [-MTA]
3231
-Help | ? | -? | /? Displays the syntax and describes the command-line switches.
3332
```
@@ -43,7 +42,9 @@ commas to separate the file names within the string.
4342

4443
For example:
4544

46-
PowerShell_ISE -File "File1.ps1,File2.ps1,File3.xml".
45+
```powershell
46+
powershell_ise -File "File1.ps1,File2.ps1,File3.xml".
47+
```
4748

4849
Spaces between the file names are permitted in Windows PowerShell,
4950
but might not be interpreted correctly by other programs, such as
@@ -52,7 +53,7 @@ Cmd.exe.
5253
You can use this parameter to open any text file, including Windows
5354
PowerShell script files and XML files.
5455

55-
### -Mta
56+
### -MTA
5657

5758
Starts Windows PowerShell ISE using a multi-threaded apartment. This
5859
parameter is introduced in Windows PowerShell 3.0. Single-threaded
@@ -69,24 +70,24 @@ For more information, see [about_Profiles](about_Profiles.md).
6970

7071
### -Help -?, /?
7172

72-
Displays help for PowerShell_ISE.exe.
73+
Displays help for `powershell_ise.exe`.
7374

7475
## Examples
7576

7677
These commands start Windows PowerShell ISE. The commands are equivalent
7778
and can be used interchangeably.
7879

7980
```
80-
PS C:> PowerShell_ISE.exe
81-
PS C:> PowerShell_ISE
81+
PS C:> powershell_ise.exe
82+
PS C:> powershell_ise
8283
PS C:> ISE
8384
```
8485

8586
These commands open the Get-Profile.ps1 script in Windows PowerShell ISE.
8687
The commands are equivalent and can be used interchangeably.
8788

8889
```
89-
PS C:> PowerShell_ISE.exe -File .\Get-Profile.ps1
90+
PS C:> powershell_ise.exe -File .\Get-Profile.ps1
9091
PS C:> ISE -File .\Get-Profile.ps1
9192
PS C:> ISE .\Get-Profile.ps1
9293
```
@@ -106,10 +107,10 @@ This command starts Windows PowerShell ISE with no profiles.
106107
PS C:> ISE -NoProfile
107108
```
108109

109-
This command gets help for PowerShell_ISE.exe.
110+
This command gets help for `powershell_ise.exe`.
110111

111112
```
112-
PS C:> ISE -help
113+
PS C:> ISE -Help
113114
```
114115

115116
## See also

0 commit comments

Comments
 (0)