en-US/Documentarian.ModuleAuthor-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-ParameterWithAttribute</command:name> <command:verb>Find</command:verb> <command:noun>ParameterWithAttribute</command:noun> <maml:description> <maml:para>Returns a list of cmdlets and parameters that have the specified attribute type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns a list of cmdlets and parameters that have the specified attribute type. This is useful for finding cmdlets that have experimental parameters, parameters that have validation attributes, or other specific attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-ParameterWithAttribute</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AttributeKind</maml:name> <maml:description> <maml:para>Specifies the type of attribute you want to find. Possible values are:</maml:para> <maml:para>- `DontShow`</maml:para> <maml:para>- `Experimental`</maml:para> <maml:para>- `HasValidation`</maml:para> <maml:para>- `SupportsWildcards`</maml:para> <maml:para>- `ValueFromPipeline`</maml:para> <maml:para>- `ValueFromRemaining`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DontShow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Experimental</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HasValidation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SupportsWildcards</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ValueFromPipeline</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ValueFromRemaining</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ParameterAttributeKind</command:parameterValue> <dev:type> <maml:name>ParameterAttributeKind</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>CommandName</maml:name> <maml:description> <maml:para>The name of the command you want to search. If you don't specify a value, the cmdlet searches all commands.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupBy</maml:name> <maml:description> <maml:para>This parameter specifies how the cmdlet groups the results for output. The default value is `None`. Possible values are:</maml:para> <maml:para>- `Cmdlet`</maml:para> <maml:para>- `Parameter`</maml:para> <maml:para>- `None`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Cmdlet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Module</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AttributeKind</maml:name> <maml:description> <maml:para>Specifies the type of attribute you want to find. Possible values are:</maml:para> <maml:para>- `DontShow`</maml:para> <maml:para>- `Experimental`</maml:para> <maml:para>- `HasValidation`</maml:para> <maml:para>- `SupportsWildcards`</maml:para> <maml:para>- `ValueFromPipeline`</maml:para> <maml:para>- `ValueFromRemaining`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ParameterAttributeKind</command:parameterValue> <dev:type> <maml:name>ParameterAttributeKind</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>CommandName</maml:name> <maml:description> <maml:para>The name of the command you want to search. If you don't specify a value, the cmdlet searches all commands.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupBy</maml:name> <maml:description> <maml:para>This parameter specifies how the cmdlet groups the results for output. The default value is `None`. Possible values are:</maml:para> <maml:para>- `Cmdlet`</maml:para> <maml:para>- `Parameter`</maml:para> <maml:para>- `None`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DontShowAttributeInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ExperimentalAttributeInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HasValidationAttributeInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>SupportsWildcardsAttributeInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValueFromPipelineAttributeInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValueFromRemainingAttributeInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Find all cmdlets with parameters that get their value from the remaining arguments</maml:title> <dev:code>Find-ParameterWithAttribute -AttributeKind ValueFromRemaining Cmdlet Parameter ValueFromRemainingArguments ParameterSetName ------ --------- --------------------------- ---------------- ForEach-Object RemainingScripts True ScriptBlockSet ForEach-Object ArgumentList True PropertyAndMethodSet Get-Command ArgumentList True __AllParameterSets Join-Path AdditionalChildPath True __AllParameterSets New-Module ArgumentList True __AllParameterSets Read-Host Prompt True __AllParameterSets Trace-Command ArgumentList True commandSet Write-Host Object True __AllParameterSets Write-Output InputObject True __AllParameterSets</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Find all cmdlets with parameters that get their value from the pipeline</maml:title> <dev:code>Find-ParameterWithAttribute -AttributeKind ValueFromPipeline -CommandName Get-Process Cmdlet Parameter Pipeline ParameterSetName ------ --------- -------- ---------------- Get-Process Name ByValue(False), ByName(True) Name, NameWithUserName Get-Process Id ByValue(False), ByName(True) Id, IdWithUserName Get-Process InputObject ByValue(True), ByName(False) InputObject, InputObjectWithUserName</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Find all cmdlets with parameters that support wildcards</maml:title> <dev:code>Find-ParameterWithAttribute -AttributeKind SupportsWildcards Cmdlet Parameter SupportsWildcards ParameterSetName ------ --------- ----------------- ---------------- ConvertTo-Contraction Path True __AllParameterSets Find-ParameterWithAttribute CommandName True __AllParameterSets Get-BranchStatus GitLocation True __AllParameterSets Get-DocumentLink IncludeKind True FilterByKind Get-DocumentLink ExcludeKind True FilterByKind Get-DocumentLink MatchMarkdown True __AllParameterSets Get-DocumentLink MatchText True __AllParameterSets Get-DocumentLink MatchDestination True __AllParameterSets Get-DocumentLink MatchReferenceID True __AllParameterSets Get-DocumentLink NotMatchMarkdown True __AllParameterSets Get-DocumentLink NotMatchText True __AllParameterSets Get-DocumentLink NotMatchDestination True __AllParameterSets Get-DocumentLink NotMatchReferenceID True __AllParameterSets Get-Metadata Path True AsYaml, AsObject, AsHash Get-ValeStyle Name True ByName Remove-Metadata Path True __AllParameterSets Set-Metadata Path True __AllParameterSets Update-Headings Path True __AllParameterSets Update-Metadata Path True __AllParameterSets Update-ParameterOrder Path True __AllParameterSets</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/find-parameterwithattribute</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ParameterInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ParameterInfo</command:name> <command:verb>Get</command:verb> <command:noun>ParameterInfo</command:noun> <maml:description> <maml:para>Gets information about a cmdlet parameter in Markdown format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets information about one or more parameters for a cmdlet formatted as Markdown that's compatible with cmdlet reference documentation. You can also get the information a a PowerShell object.</maml:para> <maml:para>This cmdlet is useful for updating existing parameters that have changed or adding new parameter when a cmdlet has been updated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ParameterInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ParameterName</maml:name> <maml:description> <maml:para>The name of one or more parameters belonging to the CmdletName .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CmdletName</maml:name> <maml:description> <maml:para>The name of the cmdlet that has the specified ParameterName .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsObject</maml:name> <maml:description> <maml:para>This parameter causes the cmdlet to return a PowerShell object instead of Markdown text.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ParameterInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ParameterName</maml:name> <maml:description> <maml:para>The name of one or more parameters belonging to the CmdletName .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CmdletName</maml:name> <maml:description> <maml:para>The name of the cmdlet that has the specified ParameterName .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowAll</maml:name> <maml:description> <maml:para>By default the cmdlet markdown that is compatible with PlatyPS v0.14.x. When you specify this parameter the output includes extra parameter metadata that is supported by PlatyPS v2.x.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsObject</maml:name> <maml:description> <maml:para>This parameter causes the cmdlet to return a PowerShell object instead of Markdown text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CmdletName</maml:name> <maml:description> <maml:para>The name of the cmdlet that has the specified ParameterName .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ParameterName</maml:name> <maml:description> <maml:para>The name of one or more parameters belonging to the CmdletName .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowAll</maml:name> <maml:description> <maml:para>By default the cmdlet markdown that is compatible with PlatyPS v0.14.x. When you specify this parameter the output includes extra parameter metadata that is supported by PlatyPS v2.x.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ParameterInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1 - Parameter information as an object --------</maml:title> <dev:code>Get-ParameterInfo -ParameterName Path -CmdletName Get-Metadata -AsObject Name : Path HelpText : {{Placeholder}}} Type : System.String ParameterSet : (All) Aliases : Required : False Position : FromRemaining : False Pipeline : ByValue (False), ByName (False) Dynamic : False Wildcard : True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2 - Parameter information as Markdown --------</maml:title> <dev:code>Get-ParameterInfo -ParameterName LiteralPath, Stream -CmdletName Remove-Item</dev:code> <dev:remarks> <maml:para>~~~Output</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------------- -LiteralPath -------------------------</maml:title> <dev:code>Type: System.String[] Parameter Sets: LiteralPath Aliases: PSPath, LP Required: True Position: Named Default value: None Value From Remaining: False Accept pipeline input: ByValue (False), ByName (True) Dynamic: False Accept wildcard characters: False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------------------- -Stream ---------------------------</maml:title> <dev:code>Type: System.String[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Value From Remaining: False Accept pipeline input: ByValue (False), ByName (False) Dynamic: True (FileSystem provider) Accept wildcard characters: False</dev:code> <dev:remarks> <maml:para>~~~</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/get-parameterinfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Syntax</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ShortDescription</command:name> <command:verb>Get</command:verb> <command:noun>ShortDescription</command:noun> <maml:description> <maml:para>Creates Markdown source listing each of cmdlet files in the folder and their SYNOPSIS text.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet creates Markdown source listing each of cmdlet files in the folder and their SYNOPSIS text. This text is useful for updating the module Markdown file created by PlatyPS.</maml:para> <maml:para>The cmdlet must be run in the folder containing the Markdown files for all the cmdlets in the module. The output can be sent to the clipboard for easy pasting into the `module.md` file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ShortDescription</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>There are no parameter for this cmdlet.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1 - Get the short descriptions for all cmdlets ----</maml:title> <dev:code>Get-ShortDescription | Set-Clipboard</dev:code> <dev:remarks> <maml:para>The output is copied to the Clipboard for easy pasting into the `module.md` file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/get-shortdescription</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Syntax</command:name> <command:verb>Get</command:verb> <command:noun>Syntax</command:noun> <maml:description> <maml:para>Displays the syntax of a cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet is similar to the output you get from `Get-Command -Syntax`. By default, the syntax information is returned as an object. You can also return it as formatted Markdown source that can be easily pasted into a cmdlet Markdown file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Syntax</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CmdletName</maml:name> <maml:description> <maml:para>The name of the cmdlet for which you want syntax information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Markdown</maml:name> <maml:description> <maml:para>Outputs the syntax information as formatted Markdown. The Markdown is suitable for updating the syntax blocks in a `cmdlet.md` file.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CmdletName</maml:name> <maml:description> <maml:para>The name of the cmdlet for which you want syntax information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Markdown</maml:name> <maml:description> <maml:para>Outputs the syntax information as formatted Markdown. The Markdown is suitable for updating the syntax blocks in a `cmdlet.md` file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1 - Get the syntax of a command as Markdown text ---</maml:title> <dev:code>Get-Syntax Get-Command -Markdown</dev:code> <dev:remarks> <maml:para>~~~markdown</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------------- CmdletSet (Default) ---------------------</maml:title> <dev:code>Get-Command [[-ArgumentList] <Object[]>] [-Verb <string[]>] [-Noun <string[]>] [-Module <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>] [-TotalCount <int>] [-Syntax] [-ShowCommandInfo] [-All] [-ListImported] [-ParameterName <string[]>] [-ParameterType <PSTypeName[]>]</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------------ AllCommandSet ------------------------</maml:title> <dev:code>Get-Command [[-Name] <string[]>] [[-ArgumentList] <Object[]>] [-Module <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>] [-CommandType <CommandTypes>] [-TotalCount <int>] [-Syntax] [-ShowCommandInfo] [-All] [-ListImported] [-ParameterName <string[]>] [-ParameterType <PSTypeName[]>] [-UseFuzzyMatching] [-UseAbbreviationExpansion]</dev:code> <dev:remarks> <maml:para>~~~</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 2 - Get the syntax of a command as an object -----</maml:title> <dev:code>Get-Syntax Get-Command | Format-Table -Wrap Cmdlet ParameterSetName IsDefault Parameters ------ ---------------- --------- ---------- Get-Command CmdletSet True [[-ArgumentList] <Object[]>] [-Verb <string[]>] [-Noun <string[]>] [-Module <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>] [-TotalCount <int>] [-Syntax] [-ShowCommandInfo] [-All] [-ListImported] [-ParameterName <string[]>] [-ParameterType <PSTypeName[]>] [<CommonParameters>] Get-Command AllCommandSet False [[-Name] <string[]>] [[-ArgumentList] <Object[]>] [-Module <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>] [-CommandType <CommandTypes>] [-TotalCount <int>] [-Syntax] [-ShowCommandInfo] [-All] [-ListImported] [-ParameterName <string[]>] [-ParameterType <PSTypeName[]>] [-UseFuzzyMatching] [-UseAbbreviationExpansion] [<CommonParameters>]</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/get-syntax</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-NewMDHelp</command:name> <command:verb>Invoke</command:verb> <command:noun>NewMDHelp</command:noun> <maml:description> <maml:para>Creates Markdown help files for the cmdlets in a module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is a wrapper for the `New-MarkdownHelp` cmdlet from the PlatyPS module. It runs `New-MarkdownHelp` with the standard set of parameters we use for our documentation at Microsoft.</maml:para> <maml:para>The target module must be loaded in your current session and you must have the PlatyPS module installed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-NewMDHelp</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The name of the module that you want to document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>The location where you want to write the Markdown files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The name of the module that you want to document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>The location where you want to write the Markdown files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-NewMDHelp -Module Documentarian -OutPath .\Documentarian</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/invoke-newmdhelp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>PlatyPS</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/utility-modules/platyps/overview</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-Pandoc</command:name> <command:verb>Invoke</command:verb> <command:noun>Pandoc</command:noun> <maml:description> <maml:para>Invokes Pandoc to convert Markdown files to plain text files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is a wrapper for Pandoc , a command-line tool that converts documents from one format to another. The cmdlet runs `pandoc.exe` with the standard set of parameters we use for our documentation at Microsoft. Pandoc is the tool we use to convert PowerShell `about_*.md` files to plain text, which is the format required by the PowerShell help system.</maml:para> <maml:para>This cmdlet requires that you have Pandoc installed on your system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-Pandoc</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The location of the Markdown files you want to convert. This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The location where you want to write the plain text files. The default location is the current directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When provided, the cmdlet also search all subfolders matching the pattern provided by the Path parameter.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The location where you want to write the plain text files. The default location is the current directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The location of the Markdown files you want to convert. This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When provided, the cmdlet also search all subfolders matching the pattern provided by the Path parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The plain text file is created with a name compatible with the PowerShell help system. For an input file named `about_subject.md`, the output filename is `about_subject.help.txt`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1 - Convert a Markdown file to plain text ------</maml:title> <dev:code>Invoke-Pandoc .\reference\5.1\Microsoft.PowerShell.Core\About\about_ANSI_Terminals.md Directory: D:\Git\PS-Docs\PowerShell-Docs Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 2/7/2023 1:16 PM 1475 about_ANSI_Terminals.help.txt</dev:code> <dev:remarks> <maml:para>The cmdlet shows the newly created plain text file. The name of the text file is formatted to support the PowerShell help system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/invoke-pandoc</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Pandoc</maml:linkText> <maml:uri>https://pandoc.org</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-Headings</command:name> <command:verb>Update</command:verb> <command:noun>Headings</command:noun> <maml:description> <maml:para>Changes the standard headings in `about_` files and cmdlet reference to title case.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Changes the standard headings in `about_` files and cmdlet reference to title case.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-Headings</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the Markdown files to be updated. Wildards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Use this parameter to search all subfolders of the specified Path .</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the Markdown files to be updated. Wildards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Use this parameter to search all subfolders of the specified Path .</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> Example 1 - Update the heading for all files in a folder tree </maml:title> <dev:code>Update-Headings -Path ./reference/5.1/Microsoft.PowerShell.Core/*.md -Recurse</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/update-headings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-ParameterOrder</command:name> <command:verb>Update</command:verb> <command:noun>ParameterOrder</command:noun> <maml:description> <maml:para>Sorts the H3 parameter blocks of a cmdlet Markdown file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The PowerShell-Docs style guide recommends that the H3 parameter blocks of a cmdlet Markdown file be sorted alphabetically with the Confirm and WhatIf parameters at the end of the list. However, much of the existing reference content was created before this recommendation. Therefore, not all cmdlet files are ordered this way.</maml:para> <maml:para>This cmdlet allows you to easily reorder the parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-ParameterOrder</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the Markdown file. This can be a path to a folder containing Markdown files. Wildcards are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the Markdown file. This can be a path to a folder containing Markdown files. Wildcards are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns the FileInfo object for each Markdown file processed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1 - Sort the parameter blocks of all Markdown files in a folder</maml:title> <dev:code>Sort-Parameters .\7.1\Microsoft.PowerShell.Utility\*-*.md</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/moduleauthor/reference/cmdlets/sort-parameters</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |