Import-MamlHelp
Importerar MAML-hjälpen från en fil och skapar CommandHelp objekt för varje kommando i filen.
Syntax
Path (Standard)
Import-MamlHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MamlHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Det här kommandot kan användas för att skapa CommandHelp objekt från MAML-hjälpfiler. Dessa objekt kan användas för att generera Markdown-hjälpfiler. Du kan också använda det här kommandot för att testa giltigheten för MAML-hjälpfilerna.
Exempel
Exempel 1
Import-MamlHelp -Path .\maml\Microsoft.PowerShell.PlatyPS.dll-Help.xml
Parametrar
-LiteralPath
Sökvägen till MAML-hjälpfilen. Anger en sökväg till en eller flera platser. Värdet för LiteralPath används exakt som det skrivs. Inga tecken tolkas som wildcards. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.
Mer information finns i about_Quoting_Rules.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | PSPath, SP |
Parameteruppsättningar
LiteralPath
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | True |
| Värde från återstående argument: | False |
-Path
Sökvägen till MAML-hjälpfilen. Anger en sökväg till en eller flera platser.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | True |
| DontShow: | False |
Parameteruppsättningar
Path
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
Indata
String
Utdata
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Kommentarer
MAML-filformatet stöder inte all information som kan lagras i ett CommandHelp--objekt. Om du konverterar den importerade informationen till markdown-format är den resulterande markdown-filen inte en fullständig representation av det ursprungliga kommandot.