Skip to content

Commit

Permalink
(MicrosoftDocsGH-8799) Clean up formatting for non-core reference (Mi…
Browse files Browse the repository at this point in the history
…crosoftDocs#8825)

* (MicrosoftDocsGH-8799) Clean up formatting for non-core reference

* Update reference/5.1/PSWorkflow/About/about_WorkflowCommonParameters.md

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>
  • Loading branch information
michaeltlombardi and sdwheeler authored May 17, 2022
1 parent e2f781a commit b49734d
Show file tree
Hide file tree
Showing 124 changed files with 2,667 additions and 2,448 deletions.
18 changes: 9 additions & 9 deletions reference/5.1/CimCmdlets/Remove-CimInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.Management.Infrastructure.CimCmdlets.dll-Help.xml
Locale: en-US
Module Name: CimCmdlets
ms.date: 06/21/2021
ms.date: 05/17/2022
online version: https://docs.microsoft.com/powershell/module/cimcmdlets/remove-ciminstance?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Remove-CimInstance
Expand Down Expand Up @@ -151,7 +151,7 @@ Accept wildcard characters: False
### -Namespace
Specifies the namespace for the CIM operation. The default namespace is **root/cimv2**. You can use
Specifies the namespace for the CIM operation. The default namespace is `root/cimv2`. You can use
tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from
the local WMI server to provide the list of namespaces.

Expand All @@ -170,7 +170,7 @@ Accept wildcard characters: False
### -OperationTimeoutSec

Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the
value of this parameter is 0, which means that the cmdlet uses the default timeout value for the
value of this parameter is `0`, which means that the cmdlet uses the default timeout value for the
server.

If the **OperationTimeoutSec** parameter is set to a value less than the robust connection retry
Expand All @@ -195,10 +195,10 @@ Accept wildcard characters: False
Specifies a query to run on the CIM server. You can specify the query dialect using the
**QueryDialect** parameter.

If the value specified contains double quotes ("), single quotes ('), or a backslash (`\`), you must
escape those characters by prefixing them with the backslash (`\`) character. If the value specified
uses the WQL LIKE operator, then you must escape the following characters by enclosing them in
square brackets (`[]`): percent (%), underscore (`_`), or opening square bracket (`[`).
If the value specified contains double quotes (`"`), single quotes (`'`), or a backslash (`\`), you
must escape those characters by prefixing them with the backslash (`\`) character. If the value
specified uses the WQL `LIKE` operator, then you must escape the following characters by enclosing
them in square brackets (`[]`): percent (`%`), underscore (`_`), or opening square bracket (`[`).

```yaml
Type: System.String
Expand All @@ -215,7 +215,7 @@ Accept wildcard characters: False
### -QueryDialect

Specifies the query language used for the Query parameter. The acceptable values for this parameter
are: **WQL** or **CQL**. The default value is **WQL**.
are: `WQL` or `CQL`. The default value is `WQL`.

```yaml
Type: System.String
Expand Down Expand Up @@ -245,7 +245,7 @@ By default, if you do not specify this parameter, the DMTF standard resource URI
ResourceURI can only be used with CIM sessions created using the WSMan protocol, or when specifying
the ComputerName parameter, which creates a CIM session using WSMan. If you specify this parameter
without specifying the ComputerName parameter, or if you specify a CIM session created using DCOM
protocol, you will get an error, because the DCOM protocol does not support the ResourceURI
protocol, you get an error, because the DCOM protocol does not support the **ResourceURI**
parameter.

If both the **ResourceUri** parameter and the **Filter** parameter are specified, the **Filter**
Expand Down
14 changes: 7 additions & 7 deletions reference/5.1/ISE/Import-IseSnippet.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: ISE-help.xml
Locale: en-US
Module Name: ISE
ms.date: 06/09/2017
ms.date: 05/17/2022
online version: https://docs.microsoft.com/powershell/module/ise/import-isesnippet?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Import-IseSnippet
Expand Down Expand Up @@ -75,7 +75,7 @@ Import-IseSnippet -Module SnippetModule -ListAvailable

### Example 3: Find snippets in modules

This example gets snippets in all installed modules in the PSModulePath environment variable.
This example gets snippets in all installed modules in the **PSModulePath** environment variable.

```powershell
($env:PSModulePath).split(";") |
Expand All @@ -97,9 +97,9 @@ you don't need to run a command like this because modules that have snippets wil

### Example 5: Copy all module snippets

This example copies the snippet files from all installed modules into the Snippets directory of the
current user. Unlike imported snippets, which affect only the current session, copied snippets are
available in every Windows PowerShell ISE session.
This example copies the snippet files from all installed modules into the `Snippets` directory of
the current user. Unlike imported snippets, which affect only the current session, copied snippets
are available in every Windows PowerShell ISE session.

```powershell
($env:PSModulePath).split(";") |
Expand Down Expand Up @@ -135,8 +135,8 @@ Accept wildcard characters: False
Imports snippets from the specified module into the current session. Wildcard characters are not
supported.
This parameter imports snippets from Snippet.ps1xml files in the Snippets subdirectory in the module
path, such as `$home\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets`.
This parameter imports snippets from `Snippet.ps1xml` files in the Snippets subdirectory in the
module path, such as `$home\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets`.

This parameter is designed to be used by module authors in a startup script, such as a script
specified in the **ScriptsToProcess** key of a module manifest. Snippets in a module are not
Expand Down
33 changes: 17 additions & 16 deletions reference/5.1/Microsoft.PowerShell.Diagnostics/Export-Counter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Diagnostics.dll-help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Diagnostics
ms.date: 10/12/2020
ms.date: 05/17/2022
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.diagnostics/export-counter?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Export-Counter
Expand All @@ -22,9 +22,9 @@ Export-Counter [-Path] <String> [-FileFormat <String>] [-MaxSize <UInt32>]

## DESCRIPTION

The `Export-Counter` cmdlet exports performance counter data (PerformanceCounterSampleSet objects)
to log files in binary performance log (.blg), comma-separated value (.csv), or tab-separated value
(.tsv) format. You use this cmdlet to log performance counter data.
The `Export-Counter` cmdlet exports performance counter data (**PerformanceCounterSampleSet**
objects) to log files in binary performance log (`.blg`), comma-separated value (`.csv`), or
tab-separated value (`.tsv`) format. You use this cmdlet to log performance counter data.

The `Export-Counter` cmdlet is designed to export data that is returned by the `Get-Counter` and
`Import-Counter` cmdlets.
Expand All @@ -42,8 +42,8 @@ Get-Counter "\Processor(*)\% Processor Time" | Export-Counter -Path $home\Counte
```

The command uses the `Get-Counter` cmdlet to collect processor time data. It uses a pipeline
operator (|) to send the data to the `Export-Counter` cmdlet. The `Export-Counter` command uses the
**Path** variable to specify the output file.
operator (`|`) to send the data to the `Export-Counter` cmdlet. The `Export-Counter` command uses
the **Path** variable to specify the output file.

Because the data set might be very large, this example sends the data to `Export-Counter` through
the pipeline. If the data were saved in a variable, you might use a disproportionate amount of
Expand Down Expand Up @@ -74,7 +74,7 @@ The first command uses the `Get-Counter` cmdlet to collect working set counter d
remote computer. The command saves the data in the `$C` variable.

The second command uses a pipeline operator (`|`) to send the data in `$C` to the `Export-Counter`
cmdlet, which saves it in the `Workingset.blg` file in the Perf share of the Server01 computer.
cmdlet, which saves it in the `Workingset.blg` file in the `Perf` share of the Server01 computer.

```powershell
$C = Get-Counter -ComputerName Server01 -Counter "\Process(*)\Working Set - Private" -MaxSamples $C | Export-Counter -Path \\Server01\Perf\WorkingSet.blg
Expand All @@ -90,15 +90,15 @@ This example shows how to use the `Import-Counter` and `Export-Counter` cmdlets
data.

The first command uses the `Import-Counter` cmdlet to import performance counter data from the
DiskSpace.blg log. It saves the data in the `$All` variable. This file contains samples of the
`DiskSpace.blg` log. It saves the data in the `$All` variable. This file contains samples of the
"LogicalDisk\% Free Space" counter on more than 200 remote computers in the enterprise.

The second command uses the `Where-Object` cmdlet to select objects with **CookedValue** of less
than 15 (percent). The command saves the results in the `$LowSpace` variable.

The third command uses a pipeline operator (`|`) to send the data in the `$LowSpace` variable to the
`Export-Counter` cmdlet. The command uses the **Path** parameter to indicate that the selected data
should be logged in the LowDiskSpace.blg file.
should be logged in the `LowDiskSpace.blg` file.

```powershell
$All = Import-Counter DiskSpace.blg
Expand All @@ -110,8 +110,8 @@ $LowSpace | Export-Counter -Path LowDiskSpace.blg

### -Circular

Indicates that the output file is a circular log with first in, first out (FIFO) format.
When you include this parameter, the **MaxSize** parameter is required.
Indicates that the output file is a circular log with first in, first out (FIFO) format. When you
include this parameter, the **MaxSize** parameter is required.

```yaml
Type: System.Management.Automation.SwitchParameter
Expand All @@ -131,11 +131,11 @@ Specifies the output format of the output log file.
The acceptable values for this parameter are:
- CSV
- TSV
- BLG
- `CSV`
- `TSV`
- `BLG`

The default value is BLG.
The default value is `BLG`.

```yaml
Type: System.String
Expand All @@ -151,7 +151,8 @@ Accept wildcard characters: False

### -Force

Overwrites and replaces an existing file if one exists in the location specified by the **Path** parameter.
Overwrites and replaces an existing file if one exists in the location specified by the **Path**
parameter.

```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down
7 changes: 4 additions & 3 deletions reference/5.1/Microsoft.PowerShell.Diagnostics/Get-Counter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Diagnostics.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Diagnostics
ms.date: 06/21/2021
ms.date: 05/17/2022
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.diagnostics/get-counter?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Get-Counter
Expand Down Expand Up @@ -411,7 +411,7 @@ Path InstanceName CookedValue
`Get-Counter` uses the **Counter** parameter to specify the counter
`\Processor(*)\% Processor Time`. The values are stored in the `$Counter` variable. The objects
stored in `$Counter.CounterSamples` are sent down the pipeline. `Where-Object` uses a script block
to compare each objects value against a specified value of 20. The `$_.CookedValue` is a variable
to compare each objects value against a specified value of `20`. The `$_.CookedValue` is a variable
for the current object in the pipeline. Counters with a **CookedValue** that is less than 20 are
displayed.

Expand Down Expand Up @@ -599,7 +599,8 @@ Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand Down
28 changes: 15 additions & 13 deletions reference/5.1/Microsoft.PowerShell.Diagnostics/Import-Counter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Diagnostics.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Diagnostics
ms.date: 09/28/2021
ms.date: 05/17/2022
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.diagnostics/import-counter?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Import-Counter
Expand All @@ -18,8 +18,8 @@ the log.
### GetCounterSet (Default)

```
Import-Counter [-Path] <String[]> [-StartTime <DateTime>] [-EndTime <DateTime>] [-Counter <String[]>]
[-MaxSamples <Int64>] [<CommonParameters>]
Import-Counter [-Path] <String[]> [-StartTime <DateTime>] [-EndTime <DateTime>]
[-Counter <String[]>] [-MaxSamples <Int64>] [<CommonParameters>]
```

### ListSetSet
Expand Down Expand Up @@ -111,7 +111,7 @@ $i | Export-Counter -Path .\Interrupts.csv -Format CSV
```

The first command uses `Import-Counter` to import all of the performance counter data from the
`ProcessorData.blg files`. The command saves the data in the `$data` variable.
`ProcessorData.blg` files. The command saves the data in the `$data` variable.

The second command displays the counter paths in the `$data` variable. To get the display shown in
the command output, the example uses the `Format-Table` cmdlet to format as a table the counter
Expand All @@ -125,9 +125,9 @@ The fourth command displays the selected counter paths in the `$intCtrs` variabl

The fifth command uses the `Import-Counter` cmdlet to import the data. It uses the `$intCtrs`
variable as the value of the **Counter** parameter to import only data for the counter paths in
$IntCtrs.
`$intCtrs`.

The sixth command uses the Export-Counter cmdlet to export the data to the `Interrupts.csv` file.
The sixth command uses the `Export-Counter` cmdlet to export the data to the `Interrupts.csv` file.

### Example 4: Display all counter paths in a group of imported counter sets

Expand Down Expand Up @@ -177,9 +177,9 @@ counter sets that are represented in a counter data file.

The second command gets all of the counter paths from the list set.

### Example 5: Import counter data from a range of time stamps
### Example 5: Import counter data from a range of timestamps

This example imports only the counter data that has a time stamp between the starting an ending
This example imports only the counter data that has a timestamp between the starting an ending
ranges specified in the command.

```powershell
Expand All @@ -188,10 +188,10 @@ $start = [datetime]"7/9/2008 3:47:00 PM"; $end = [datetime]"7/9/2008 3:47:59 PM"
Import-Counter -Path Disk.blg -StartTime $start -EndTime $end
```

The first command lists in a table the time stamps of all of the data in the `ProcessorData.blg`
The first command lists in a table the timestamps of all of the data in the `ProcessorData.blg`
file.

The second command saves particular time stamps in the `$start` and `$end` variables. The strings
The second command saves particular timestamps in the `$start` and `$end` variables. The strings
are cast to **DateTime** objects.

The third command uses the `Import-Counter` cmdlet to get only counter data that has a time stamp
Expand All @@ -200,7 +200,8 @@ parameters of `Import-Counter` to specify the range.

### Example 6: Import a specified number of the oldest samples from a performance counter log file

This example shows how to import the five oldest and five newest samples from a performance counter log file.
This example shows how to import the five oldest and five newest samples from a performance counter
log file.

```powershell
Import-Counter -Path "Disk.blg" -MaxSamples 5
Expand Down Expand Up @@ -267,7 +268,7 @@ Specifies, as a string array, the performance counters. By default, `Import-Coun
data from all counters in the input files. Enter one or more counter paths. Wildcards are permitted
in the Instance part of the path.

Each counter path has the following format. The ComputerName value is required in the path. For
Each counter path has the following format. The `ComputerName` value is required in the path. For
instance:

- `\\<ComputerName>\<CounterSet>(<Instance>)\<CounterName>`
Expand Down Expand Up @@ -405,7 +406,8 @@ Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand Down
4 changes: 2 additions & 2 deletions reference/5.1/Microsoft.PowerShell.Management/Add-Content.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Management
ms.date: 11/03/2021
ms.date: 05/16/2022
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.management/add-content?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Add-Content
Expand Down Expand Up @@ -146,7 +146,7 @@ Mode LastWriteTime Length Name
`IsReadOnlyTextFile.txt` in the current directory.
- The `Set-ItemProperty` cmdlet uses the **Name** and **Value** parameters to change the file's
**IsReadOnly** property to True.
- The `Get-ChildItem` cmdlet shows the file is empty (0) and has the read-only attribute (`r`).
- The `Get-ChildItem` cmdlet shows the file is empty (`0`) and has the read-only attribute (`r`).
- The `Add-Content` cmdlet uses the **Path** parameter to specify the file. The **Value** parameter
includes the text string to append to the file. The **Force** parameter writes the text to the
read-only file.
Expand Down
16 changes: 8 additions & 8 deletions reference/5.1/Microsoft.PowerShell.Management/Clear-EventLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Management
ms.date: 06/09/2017
ms.date: 05/17/2022
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.management/clear-eventlog?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Clear-EventLog
Expand All @@ -15,7 +15,8 @@ Clears all entries from specified event logs on the local or remote computers.
## SYNTAX

```
Clear-EventLog [-LogName] <String[]> [[-ComputerName] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Clear-EventLog [-LogName] <String[]> [[-ComputerName] <String[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -24,9 +25,9 @@ The `Clear-EventLog` cmdlet deletes all of the entries from the specified event
computer or on remote computers. To use `Clear-EventLog`, you must be a member of the Administrators
group on the affected computer.

The cmdlets that contain the **EventLog** noun (the EventLog cmdlets) work only on classic event
The cmdlets that contain the `EventLog` noun (the `EventLog` cmdlets) work only on classic event
logs. To get events from logs that use the Windows Event Log technology in Windows Vista and later
versions of Windows, use the Get-WinEvent cmdlet.
versions of Windows, use the `Get-WinEvent` cmdlet.

## EXAMPLES

Expand Down Expand Up @@ -97,7 +98,7 @@ before they were displayed.
Specifies a remote computer. The default is the local computer.

Type the NetBIOS name, an Internet Protocol (IP) address, or a fully qualified domain name of a
remote computer. To specify the local computer, type the computer name, a dot (.), or "localhost".
remote computer. To specify the local computer, type the computer name, a dot (`.`), or `localhost`.

This parameter does not rely on Windows PowerShell remoting. You can use the **ComputerName**
parameter of `Get-EventLog` even if your computer is not configured to run remote commands.
Expand Down Expand Up @@ -154,8 +155,7 @@ Accept wildcard characters: False
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down Expand Up @@ -191,7 +191,7 @@ This cmdlet does not generate any output.
## NOTES

- To use `Clear-EventLog` on Windows Vista and later versions of Windows, start Windows PowerShell
with the "Run as administrator" option.
with the **Run as administrator** option.

## RELATED LINKS

Expand Down
Loading

0 comments on commit b49734d

Please sign in to comment.