Import-MamlHelp
Imports MAML help from a file and creates CommandHelp objects for each command in the file.
Syntax
Path (Default)
Import-MamlHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MamlHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
This command can be used to create CommandHelp objects from MAML help files. These objects can be used to generate Markdown help files. You can also use this command to test the validity of the MAML help files.
Examples
Example 1
Import-MamlHelp -Path .\maml\Microsoft.PowerShell.PlatyPS.dll-Help.xml
Parameters
-LiteralPath
The path to the MAML help file. Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.
For more information, see about_Quoting_Rules.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Parameter sets
LiteralPath
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Path
The path to the MAML help file. Specifies a path to one or more locations.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
Path
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Notes
The MAML file format doesn't support all the information that can be stored in a CommandHelp object. If you convert the imported information to markdown format, the resulting markdown file is not a complete representation of the original command.