Stöd för onlinehjälp

  • Artikel
  • 3 minuter för att läsa

Från och med PowerShell 3.0 finns det två sätt att stödja Get-Help onlinefunktionen för PowerShell-kommandon. Det här avsnittet beskriver hur du implementerar den här funktionen för olika kommandotyper.

Om onlinehjälp

Onlinehjälp har alltid varit en viktig del av PowerShell. Även om cmdleten visar hjälpavsnitt i kommandotolken föredrar många användare att läsa online, inklusive färgkodning, hyperlänkar och delning av idéer i communityinnehåll och Get-Help wiki-baserade dokument. Det viktigaste är att onlinehjälpen före införandet av uppdatabel hjälp tillhandahöll den senaste versionen av hjälpfilerna.

I och med framväxten av uppdatabel hjälp i PowerShell 3.0 spelar onlinehjälpen fortfarande en viktig roll. Förutom den flexibla användarupplevelsen ger onlinehjälpen hjälp till användare som inte eller inte kan använda uppdatabel hjälp för att ladda ned hjälpavsnitt.

Så Get-Help -Online Works

För att hjälpa användarna att hitta onlinehjälpavsnitten för kommandon har kommandot en onlineparameter som öppnar onlineversionen av hjälpavsnittet för ett kommando i Get-Help användarens standardwebbläsare.

Följande kommando öppnar till exempel onlinehjälpavsnittet för Invoke-Command cmdleten .

Get-Help Invoke-Command -Online

För att Get-Help -Online implementera letar Get-Help cmdleten efter en Uniform Resource Identifier (URI) för onlineversionshjälpavsnittet på följande platser.

  • Den första länken i avsnittet Relaterade länkar i hjälpavsnittet för kommandot. Hjälpavsnittet måste installeras på användarens dator. Den här funktionen introducerades i PowerShell 2.0.

  • Egenskapen HelpUri för alla kommandon. Egenskapen HelpUri är tillgänglig även om hjälpavsnittet för kommandot inte är installerat på användarens dator. Den här funktionen introducerades i PowerShell 3.0.

    Get-Helpsöker efter en URI i den första posten i avsnittet Relaterade länkar innan du hämtar värdet för HelpUri-egenskapen. Om egenskapsvärdet är felaktigt eller har ändrats kan du åsidosätta det genom att ange ett annat värde i den första relaterade länken. Den första relaterade länken fungerar dock bara när hjälpavsnitten är installerade på användarens dator.

Du kan stödja alla kommandon genom att lägga till en giltig URI till den första posten i avsnittet Relaterade länkar i Get-Help -Online det XML-baserade hjälpavsnittet för kommandot. Det här alternativet är endast giltigt i XML-baserade hjälpavsnitt och fungerar bara när hjälpavsnittet är installerat på användarens dator. När hjälpavsnittet har installerats och URI:en har fyllts i, har det här värdet företräde framför helpUri-egenskapen för kommandot.

För att stödja den här funktionen måste URI:en visas maml:uri i elementet under det första elementet i elementet maml:relatedLinks/maml:navigationLink maml:relatedLinks .

Följande XML visar korrekt placering av URI:en. Texten Online version: i elementet är en bra maml:linkText metod, men den är inte obligatorisk.

<maml:relatedLinks>
    <maml:navigationLink>
        <maml:linkText>Online version:</maml:linkText>
        <maml:uri>https://go.microsoft.com/fwlink/?LinkID=113279</maml:uri>
    </maml:navigationLink>
    <maml:navigationLink>
        <maml:linkText>about_History</maml:linkText>
        <maml:uri/>
    </maml:navigationLink>
</maml:relatedLinks>

Lägga till egenskapen HelpUri i ett kommando

Det här avsnittet visar hur du lägger till egenskapen HelpUri i kommandon av olika typer.

Lägga till en HelpUri-egenskap i en cmdlet

För cmdlets skrivna i C# lägger du till ett HelpUri-attribut i cmdlet-klassen. Värdet för attributet måste vara en URI som börjar med http eller https .

Följande kod visar HelpUri-attributet för Get-History cmdlet-klassen.

[Cmdlet(VerbsCommon.Get, "History", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=001122")]

Lägga till en HelpUri-egenskap i en avancerad funktion

För avancerade funktioner lägger du till en HelpUri-egenskap i attributet CmdletBinding. Värdet för egenskapen måste vara en URI som börjar med "http" eller "https".

Följande kod visar helpuri-attributet för New-Calendar funktionen

function New-Calendar {
    [CmdletBinding(SupportsShouldProcess=$true,
    HelpURI="https://go.microsoft.com/fwlink/?LinkID=01122")]

Lägga till ett HelpUri-attribut i ett CIM-kommando

För CIM-kommandon lägger du till ett HelpUri-attribut till elementet CmdletMetadata i CDXML-filen. Värdet för attributet måste vara en URI som börjar med http eller https .

Följande kod visar HelpUri-attributet för Start-Debug CIM-kommandot

<CmdletMetadata Verb="Debug" HelpUri="https://go.microsoft.com/fwlink/?LinkID=001122"/>

Lägga till ett HelpUri-attribut i ett arbetsflöde

För arbetsflöden som är skrivna på PowerShell-språket lägger du till en . ExternalHelp-kommentarsdirektiv till arbetsflödeskoden. Värdet för direktivet måste vara en URI som börjar med http eller https .

Anteckning

Egenskapen HelpUri stöds inte för XAML-baserade arbetsflöden i PowerShell.

Följande kod visar . ExternalHelp-direktiv i en arbetsflödesfil.

# .ExternalHelp "https://go.microsoft.com/fwlink/?LinkID=138338"