Import-MamlHelp
Hiermee importeert u MAML-help uit een bestand en maakt u CommandHelp objecten voor elke opdracht in het bestand.
Syntaxis
Path (Standaard)
Import-MamlHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MamlHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Met deze opdracht kunt u CommandHelp objecten maken op basis van MAML Help-bestanden. Deze objecten kunnen worden gebruikt om Help-bestanden van Markdown te genereren. U kunt deze opdracht ook gebruiken om de geldigheid van de MAML-helpbestanden te testen.
Voorbeelden
Voorbeeld 1
Import-MamlHelp -Path .\maml\Microsoft.PowerShell.PlatyPS.dll-Help.xml
Parameters
-LiteralPath
Het pad naar het MAML-helpbestand. Specificeert een pad naar een of meer locaties. De waarde van LiteralPath wordt exact gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
Zie about_Quoting_Rulesvoor meer informatie.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
LiteralPath
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-Path
Het pad naar het MAML-helpbestand. Specificeert een pad naar een of meer locaties.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
Path
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
Invoerwaarden
String
Uitvoerwaarden
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Notities
De MAML-bestandsindeling biedt geen ondersteuning voor alle informatie die kan worden opgeslagen in een CommandHelp--object. Als u de geïmporteerde gegevens converteert naar markdown-indeling, is het resulterende Markdown-bestand geen volledige weergave van de oorspronkelijke opdracht.