New-MarkdownHelp

Modul:
platyPS Module

Skapar hjälp i markdown-format.

Syntax

FromModule 

New-MarkdownHelp
    -Module <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-WithModulePage]
    [-ModulePagePath <String>]
    [-Locale <String>]
    [-HelpVersion <String>]
    [-FwLink <String>]
    [-ExcludeDontShow]
    [<CommonParameters>]

FromCommand 

New-MarkdownHelp
    -Command <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-OnlineVersionUrl <String>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-ExcludeDontShow]
    [<CommonParameters>]

FromMaml 

New-MarkdownHelp
    -MamlFile <String[]>
    -OutputFolder <String>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-WithModulePage]
    [-ModulePagePath <String>]
    [-Locale <String>]
    [-HelpVersion <String>]
    [-FwLink <String>]
    [-ModuleName <String>]
    [-ModuleGuid <String>]
    [-ExcludeDontShow]
    [<CommonParameters>]

Description

Cmdleten New-MarkdownHelp skapar hjälp i markdown-format baserat på en modul, ett kommando eller en fil i MAML-format (Microsoft Assistance Markup Language).

Exempel

Exempel 1: Skapa hjälp från ett kommando

PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"


    Directory: D:\Working\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:53 PM            664 Command03.md

Det första kommandot skapar en funktion med namnet Command03 med windows PowerShell-standardsyntax.

Det andra kommandot skapar hjälp för stub-funktionen i mappen .\docs.

Exempel 2: Skapa hjälp från en modul

PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force


    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

Det första kommandot läser in modulen PlatyPS i den aktuella sessionen med hjälp av cmdleten Import-Module.

Det andra kommandot skapar hjälp för alla cmdletar i PlatyPS-modulen. De lagras i mappen .\docs. Det här kommandot anger force-parametern. Därför skriver den över befintliga hjälpmarkeringsfiler som har samma namn.

Exempel 3: Skapa hjälp från en befintlig MAML-fil

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'

    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:56 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:56 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM          15320 Set-PSReadLineOption.md

Det här kommandot skapar hjälp i markdown-format för den angivna MAML-hjälpfilen. Du behöver inte läsa in modulen, som i föregående exempel. Om modulen redan har lästs in skapar det här kommandot hjälp baserat på MAML-filen, inte på den modul som för närvarande är installerad.

Exempel 4: Skapa hjälp från en befintlig MAML-fil för användning i en CAB-fil

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage  -Force -ModuleName "PSReadLine"


    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:59 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:59 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM          15320 Set-PSReadLineOption.md
-a----        5/22/2016   6:59 PM            942 PSReadLine.md

Det här kommandot skapar hjälp i markdown-format för den angivna MAML-hjälpfilen, som i föregående exempel. Det här kommandot anger även parametern WithModulePage och parametern ModuleName. Kommandot skapar en fil med namnet PSReadLine.md som innehåller länkar till de andra markdown-filerna i den här modulen och metadata som kan användas för att skapa .cab filer.

Parametrar

-AlphabeticParamsOrder

Ordna parametrar alfabetiskt efter namn i avsnittet PARAMETRAR. Det finns fem undantag: -Confirm, -WhatIf, -IncludeTotalCount, -Skipoch -First parametrar blir de sista. Dessa parametrar är vanliga och har därför ett väldefinierat beteende.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Command

Anger namnet på ett kommando i den aktuella sessionen. Det kan vara valfritt kommando som stöds av PowerShell-hjälpen, till exempel en cmdlet eller en funktion.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromCommand
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ConvertDoubleDashLists

Anger att den här cmdleten konverterar punktlistor med dubbla bindestreck till punkter med ett bindestreck. Listor med dubbla bindestreck är vanliga i Windows PowerShell-dokumentationen. Markdown accepterar enkla bindestreck för listor.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ConvertNotesToList

Anger att denna cmdlet formaterar flera styckeobjekt i avsnittet NOTES som enstaka listobjekt.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Encoding

Anger teckenkodning för den externa hjälpfilen. Ange ett System.Text.Encoding-objekt. Mer information finns i about_Character_Encoding.

Parameteregenskaper

Typ:Encoding
Standardvärde:UTF8 without BOM
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ExcludeDontShow

Undanta parametrarna som har markerats med DontShow i parameterattributet från hjälpinnehållet.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Force

Anger att den här cmdleten skriver över befintliga filer som har samma namn.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-FwLink

Anger länken framåt för modulsidan. Det här värdet krävs för att skapa .cab fil. Det här värdet används som markdown-huvudmetadata på modulsidan.

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
FromModule
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-HelpVersion

Anger vilken version av din hjälp du har. Det här värdet krävs för att skapa .cab fil. Det här värdet används som markdown-huvudmetadata på modulsidan.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Locale

Anger språkvarianten för din hjälp. Det här värdet krävs för att skapa .cab fil. Det här värdet används som markdown-huvudmetadata på modulsidan.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-MamlFile

Anger en matris med sökvägar för MAML-.xml hjälpfiler.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromMaml
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Metadata

Anger metadata som den här cmdleten innehåller i hjälpmarkeringsfilerna som en hash-tabell med nyckel/värde-par med sträng-till-sting. Den här cmdleten skriver metadata i rubriken för varje markdown-hjälpfil.

Cmdleten New-ExternalHelp använder inte dessa metadata. Externa verktyg kan använda dessa metadata.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Module

Anger en matris med namn på moduler som den här cmdleten skapar hjälp för i markdown-format.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ModuleGuid

Anger GUID för modulen i din hjälp. Det här värdet krävs för att skapa .cab fil. Det här värdet används som markdown-huvudmetadata på modulsidan.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ModuleName

Anger namnet på modulen för din hjälp. Det här värdet krävs för att skapa .cab fil. Det här värdet används som markdown-huvudmetadata på modulsidan.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ModulePagePath

När WithModule parameter används som standard placerar den .md-filen på samma plats som alla andra dokument. Med den här parametern kan du ange nytt namn/plats som ger bättre placeringsalternativ.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-NoMetadata

Anger att den här cmdleten inte skriver några metadata i den genererade markdownen.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-OnlineVersionUrl

Anger adressen där den uppdateringsbara hjälpfunktionen laddar ned uppdaterad hjälp. Om du inte anger något värde använder cmdleten en tom sträng.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromCommand
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-OutputFolder

Anger sökvägen till mappen där den här cmdleten skapar markdown-hjälpfilerna.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Session

Ger stöd för fjärrkommandon. Skicka sessionen som du använde för att skapa kommandona med Import-PSSession. Detta krävs för att få korrekta parametrar metadata från fjärrsessionen.

Parameteregenskaper

Typ:PSSession
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
FromCommand
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-UseFullTypeName

Anger att måldokumentet använder ett fullständigt typnamn i stället för ett kort namn för parametrar.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WithModulePage

Anger att den här cmdleten skapar en modulsida i utdatamappen. Den här filen har det namn som parametern ModuleName anger. Om du inte angav parametern anger cmdleten standardnamnet MamlModule. Du kan skriva över den här inställningen med ModulePagePath- som gör att du kan definiera olika sökvägar för modulsidan

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
FromMaml
Position:Named
Obligatorisk:False
Värde från pipeline:False
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

Du kan skicka modulnamn till den här cmdleten. Det här är modulerna som den här cmdleten skapar hjälpmarkering från.

Utdata

FileInfo

Den här cmdleten returnerar ett FileInfo[]-objekt för skapade filer.