Skip to content

Commit d9156f0

Browse files
authored
Fix structure of About files (#12378)
* Upcase H2 headers * Fix structure of About files * Fix duplicate H2
1 parent 82f8f14 commit d9156f0

File tree

601 files changed

+5124
-5087
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

601 files changed

+5124
-5087
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ title: about_ANSI_Terminals
77
---
88
# about_ANSI_Terminals
99

10-
## Short description
10+
## SHORT DESCRIPTION
1111
Describes the support available for ANSI escape sequences in Windows PowerShell.
1212

13-
## Long description
13+
## LONG DESCRIPTION
1414

1515
Unlike newer versions of PowerShell, the Windows PowerShell 5.1 engine and core
1616
cmdlets don't output ANSI escape sequences to format the text displayed on your
1717
screen. However, that doesn't prevent you from using ANSI escape sequences for
1818
text formatting in terminals that support it.
1919

20-
## ANSI Terminal support
20+
## ANSI TERMINAL SUPPORT
2121

2222
On Windows 10 and higher, the Windows Console Host is [xterm][02] compatible.
2323
The [Windows Terminal][03] application is also xterm compatible. These
@@ -31,7 +31,7 @@ The default colors were chosen for use with terminals that have a dark
3131
background. You can change the colors needed for your environment. For more
3232
information, see [Customizing your shell experience][01].
3333

34-
## Redirecting output
34+
## REDIRECTING OUTPUT
3535

3636
You should be careful about creating output that's decorated with ANSI escape
3737
sequences. The formatting is intended for display in the terminal. When you

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ title: about_Alias_Provider
99
---
1010
# about_Alias_Provider
1111

12-
## Provider name
12+
## PROVIDER NAME
1313

1414
Alias
1515

16-
## Drives
16+
## DRIVES
1717

1818
`Alias:`
1919

20-
## Capabilities
20+
## CAPABILITIES
2121

2222
**ShouldProcess**
2323

24-
## Short description
24+
## SHORT DESCRIPTION
2525

2626
Provides access to the PowerShell aliases and the values that they represent.
2727

28-
## Detailed description
28+
## DETAILED DESCRIPTION
2929

3030
The PowerShell **Alias** provider lets you get, add, change, clear, and delete
3131
aliases in PowerShell.
@@ -58,12 +58,12 @@ cmdlets.
5858
- [New-Alias][10]
5959
- [Set-Alias][11]
6060

61-
## Types exposed by this provider
61+
## TYPES EXPOSED BY THIS PROVIDER
6262

6363
Each alias is an instance of the [System.Management.Automation.AliasInfo][12]
6464
class.
6565

66-
## Navigating the Alias drive
66+
## NAVIGATING THE ALIAS DRIVE
6767

6868
The **Alias** provider exposes its data store in the `Alias:` drive. To work
6969
with aliases, you can change your location to the `Alias:` drive by using the
@@ -139,7 +139,7 @@ cmdlet name.
139139
Get-Item -Path Alias:* | Where-Object {$_.Definition -eq "Get-ChildItem"}
140140
```
141141

142-
## Creating aliases
142+
## CREATING ALIASES
143143

144144
### Create an alias from the Alias: drive
145145

@@ -181,7 +181,7 @@ function CD32 {Set-Location -Path C:\windows\system32}
181181
Set-Item -Path Alias:go -Value CD32
182182
```
183183

184-
## Changing aliases
184+
## CHANGING ALIASES
185185

186186
### Change the options of an alias
187187

@@ -226,7 +226,7 @@ This command uses the `Rename-Item` cmdlet to change the `popd` alias to `pop`.
226226
Rename-Item -Path Alias:popd -NewName pop
227227
```
228228

229-
## Copying an alias
229+
## COPYING AN ALIAS
230230

231231
This command copies the `pushd` alias so that a new `push` alias is created for
232232
the `Push-Location` cmdlet.
@@ -240,7 +240,7 @@ the `-Path` parameter.
240240
Copy-Item -Path Alias:pushd -Destination Alias:push
241241
```
242242

243-
## Deleting an alias
243+
## DELETING AN ALIAS
244244

245245
This command deletes the `serv` alias from the current session.
246246
You can use this command in any PowerShell drive.
@@ -267,7 +267,7 @@ allows the command to delete aliases whose **Options** property has a value of
267267
Remove-Item Alias:* -Force
268268
```
269269

270-
## Dynamic parameters
270+
## DYNAMIC PARAMETERS
271271

272272
Dynamic parameters are cmdlet parameters that are added by a PowerShell
273273
provider and are available only when the cmdlet is being used in the
@@ -292,14 +292,14 @@ Determines the value of the **Options** property of an alias.
292292
- [New-Item][04]
293293
- [Set-Item][14]
294294

295-
## Using the pipeline
295+
## USING THE PIPELINE
296296

297297
Provider cmdlets accept pipeline input. You can use the pipeline to simplify
298298
task by sending provider data from one cmdlet to another provider cmdlet.
299299
To read more about how to use the pipeline with provider cmdlets, see the
300300
cmdlet references provided throughout this article.
301301

302-
## Getting help
302+
## GETTING HELP
303303

304304
Beginning in Windows PowerShell 3.0, you can get customized help topics for
305305
provider cmdlets that explain how those cmdlets behave in a file system drive.
@@ -316,7 +316,7 @@ Get-Help Get-ChildItem
316316
Get-Help Get-ChildItem -Path Alias:
317317
```
318318

319-
## See also
319+
## SEE ALSO
320320

321321
- [about_Aliases][16]
322322
- [about_Providers][17]

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ title: about_Aliases
99
---
1010
# about_Aliases
1111

12-
## Short description
12+
## SHORT DESCRIPTION
1313

1414
Describes how to use alternate names for cmdlets and commands in PowerShell.
1515

16-
## Long description
16+
## LONG DESCRIPTION
1717

1818
An alias is an alternate name or nickname for a cmdlet or for a command
1919
element, such as a function, script, file, or executable file. You can use the
@@ -47,7 +47,7 @@ If you create `word` as the alias for Microsoft Office Word, you can type
4747
"C:\Program Files\Microsoft Office\Office11\Winword.exe"
4848
```
4949

50-
## Built-in aliases
50+
## BUILT-IN ALIASES
5151

5252
PowerShell includes a set of built-in aliases, including `cd` and `chdir` for
5353
the `Set-Location` cmdlet, and `ls` and `dir` for the `Get-ChildItem` cmdlet.
@@ -58,7 +58,7 @@ To get all the aliases on the computer, including the built-in aliases, type:
5858
Get-Alias
5959
```
6060

61-
## Alias cmdlets
61+
## ALIAS CMDLETS
6262

6363
PowerShell includes the following cmdlets, which are designed for working with
6464
aliases:
@@ -81,7 +81,7 @@ For example, type:
8181
Get-Help Export-Alias -Detailed
8282
```
8383

84-
## Creating an alias
84+
## CREATING AN ALIAS
8585

8686
To create a new alias, use the `New-Alias` cmdlet. For example, to create the
8787
`gh` alias for `Get-Help`, type:
@@ -105,7 +105,7 @@ Or, type:
105105
gh Get-CimInstance -Detailed
106106
```
107107

108-
## Saving aliases
108+
## SAVING ALIASES
109109

110110
The aliases that you create are saved only in the current session. To use the
111111
aliases in a different session, add the alias to your PowerShell profile. Or,
@@ -117,7 +117,7 @@ For more information, type:
117117
Get-Help about_Profiles
118118
```
119119

120-
## Getting aliases
120+
## GETTING ALIASES
121121

122122
To get all the aliases in the current session, including the built-in aliases,
123123
the aliases in your PowerShell profiles, and the aliases that you have created
@@ -164,7 +164,7 @@ hyphen. These are likely to be preferred substitute names for cmdlets and
164164
functions, instead of typical abbreviations or nicknames, and the author might
165165
not want them to be as evident.
166166

167-
## Alternate names for commands with parameters
167+
## ALTERNATE NAMES FOR COMMANDS WITH PARAMETERS
168168

169169
You can assign an alias to a cmdlet, script, function, or executable file. You
170170
cannot assign an alias to a command and its parameters. For example, you can
@@ -192,7 +192,7 @@ For more information about functions, type:
192192
Get-Help about_Functions
193193
```
194194

195-
## Alias objects
195+
## ALIAS OBJECTS
196196

197197
PowerShell aliases are represented by objects that are instances of the
198198
System.Management.Automation.AliasInfo class. For more information about this
@@ -216,7 +216,7 @@ the `dir` alias. The following command performs these tasks:
216216
Get-Alias -Name dir | Format-List -Property *
217217
```
218218

219-
## PowerShell Alias provider
219+
## POWERSHELL ALIAS PROVIDER
220220

221221
PowerShell includes the Alias provider. The Alias provider lets you view the
222222
aliases in PowerShell as though they were on a file system drive.
@@ -255,7 +255,7 @@ For more information about the PowerShell Alias provider, type:
255255
Get-Help Alias
256256
```
257257

258-
## See also
258+
## SEE ALSO
259259

260260
- [about_Functions](about_Functions.md)
261261
- [about_Profiles](about_Profiles.md)

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ title: about_Arithmetic_Operators
88
---
99
# about_Arithmetic_Operators
1010

11-
## Short description
11+
## SHORT DESCRIPTION
1212

1313
Describes the operators that perform arithmetic in PowerShell.
1414

15-
## Long description
15+
## LONG DESCRIPTION
1616

1717
Arithmetic operators calculate numeric values. You can use one or more
1818
arithmetic operators to add, subtract, multiply, and divide values, and to
@@ -107,7 +107,7 @@ PowerShell supports the following arithmetic operators:
107107
102 -shr 2 # result = 25
108108
```
109109

110-
## Operator precedence
110+
## OPERATOR PRECEDENCE
111111

112112
PowerShell processes arithmetic operators in the following order:
113113

@@ -160,7 +160,7 @@ $a = $a + 1
160160
$b[$a] = $tmp
161161
```
162162

163-
## Division and rounding
163+
## DIVISION AND ROUNDING
164164

165165
When the quotient of a division operation is an integer, PowerShell rounds the
166166
value to the nearest integer. When the value is `.5`, it rounds to the nearest
@@ -192,7 +192,7 @@ PS> [int][Math]::Floor(5 / 2)
192192
For more information, see the [Math.Round](/dotnet/api/system.math.round)
193193
method.
194194

195-
## Type conversion to accommodate result
195+
## TYPE CONVERSION TO ACCOMMODATE RESULT
196196

197197
PowerShell automatically selects the .NET numeric type that best expresses the
198198
result without losing precision. For example:
@@ -309,7 +309,7 @@ PS> 1 / [int]1.9
309309
0.5
310310
```
311311

312-
## Adding and multiplying non numeric types
312+
## ADDING AND MULTIPLYING NON NUMERIC TYPES
313313

314314
You can add numbers, strings, arrays, and hash tables. And, you can multiply
315315
numbers, strings, and arrays. However, you can't multiply hash tables.
@@ -469,7 +469,7 @@ $array
469469
2
470470
```
471471

472-
## Arithmetic operators and variables
472+
## ARITHMETIC OPERATORS AND VARIABLES
473473

474474
You can also use arithmetic operators with variables. The operators act on the
475475
values of the variables. The following examples demonstrate the use of
@@ -487,7 +487,7 @@ PS> $a + $b
487487
PowerShell
488488
```
489489

490-
## Arithmetic operators and commands
490+
## ARITHMETIC OPERATORS AND COMMANDS
491491

492492
Typically, you use the arithmetic operators in expressions with numbers,
493493
strings, and arrays. However, you can also use arithmetic operators with the
@@ -522,7 +522,7 @@ Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName
522522
In the above expression, each process working space (`$_.WS`) is multiplied by
523523
`2`; and, the result, compared against `50mb` to see if it's greater than that.
524524

525-
## Bitwise operators
525+
## BITWISE OPERATORS
526526

527527
PowerShell supports the standard bitwise operators, including bitwise-AND
528528
(`-band`), the inclusive and exclusive bitwise-OR operators (`-bor` and
@@ -631,7 +631,7 @@ unsigned values, a zero is inserted in the left-most position.
631631
| `(-21 -shr 1)` | -11 | 11111111111111111111111111110101 | 0xFFFFFFF5 |
632632
| `(-21 -shr 2)` | -6 | 11111111111111111111111111111010 | 0xFFFFFFF4 |
633633

634-
## See also
634+
## SEE ALSO
635635

636636
- [about_Arrays](about_Arrays.md)
637637
- [about_Hash_Tables](about_Hash_Tables.md)

0 commit comments

Comments
 (0)