Ondersteunende online help

Vanaf PowerShell 3.0 zijn er twee manieren om de onlinefunctie voor Get-Help PowerShell-opdrachten te ondersteunen. In dit onderwerp wordt uitgelegd hoe u deze functie implementeert voor verschillende opdrachttypen.

Over Online Help

Online help is altijd al een essentieel onderdeel van PowerShell geweest. Hoewel de cmdlet Help-onderwerpen we weergeven bij de opdrachtprompt, geven veel gebruikers de voorkeur aan de ervaring van online lezen, waaronder kleurcodering, hyperlinks en het delen van ideeën in Community-inhoud en Get-Help wiki-documenten. Het belangrijkste is dat, vóór de komst van de Help die kan worden bijgewerkt, online help de meest recente versie van de Help-bestanden heeft geleverd.

Met de komst van De help die kan worden bijwerkt in PowerShell 3.0, speelt onlinehulp nog steeds een belangrijke rol. Naast de flexibele gebruikerservaring biedt online-Help gebruikers hulp die geen of geen gebruik kunnen maken van De help die kan worden gebruikt om Help-onderwerpen te downloaden.

Hoe Get-Help -Online werkt

Om gebruikers te helpen de online Help-onderwerpen voor opdrachten te vinden, heeft de opdracht een onlineparameter die de onlineversie van het Help-onderwerp opent voor een opdracht in de Get-Help standaardinternetbrowser van de gebruiker.

Met de volgende opdracht wordt bijvoorbeeld het online Help-onderwerp voor de Invoke-Command cmdlet geopend.

Get-Help Invoke-Command -Online

Als u wilt implementeren, zoekt de cmdlet naar een Uniform Resource Identifier (URI) voor het Get-Help -Online Help-onderwerp over de Get-Help onlineversie op de volgende locaties.

• De eerste koppeling in de sectie Gerelateerde koppelingen van het Help-onderwerp voor de opdracht. Het Help-onderwerp moet zijn geïnstalleerd op de computer van de gebruiker. Deze functie is geïntroduceerd in PowerShell 2.0.

• De Eigenschap HelpUri van een opdracht. De eigenschap HelpUri is toegankelijk, zelfs wanneer het Help-onderwerp voor de opdracht niet is geïnstalleerd op de computer van de gebruiker. Deze functie is geïntroduceerd in PowerShell 3.0.

  Get-Help zoekt naar een URI in de eerste vermelding in de sectie Gerelateerde koppelingen voordat u de waarde van de HelpUri-eigenschap krijgt. Als de eigenschapswaarde onjuist is of is gewijzigd, kunt u deze overschrijven door in de eerste gerelateerde koppeling een andere waarde in te invoeren. De eerste gerelateerde koppeling werkt echter alleen wanneer de Help-onderwerpen op de computer van de gebruiker zijn geïnstalleerd.

Een URI toevoegen aan de eerste gerelateerde koppeling van een Help-onderwerp voor opdrachten

U kunt ondersteuning bieden voor elke opdracht door een geldige URI toe te voegen aan de eerste vermelding in de sectie Gerelateerde koppelingen van het help-onderwerp op basis van Get-Help -Online XML voor de opdracht. Deze optie is alleen geldig in helponderwerpen op basis van XML en werkt alleen wanneer het Help-onderwerp op de computer van de gebruiker is geïnstalleerd. Wanneer het Help-onderwerp is geïnstalleerd en de URI is ingevuld, heeft deze waarde voorrang op de eigenschap HelpUri van de opdracht.

Ter ondersteuning van deze functie moet de URI worden weergegeven in het maml:uri element onder het eerste element in het element maml:relatedLinks/maml:navigationLink maml:relatedLinks .

De volgende XML toont de juiste plaatsing van de URI. De Online version: tekst in het element is een maml:linkText best practice, maar dit is niet vereist.

<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>

De eigenschap HelpUri toevoegen aan een opdracht

In deze sectie ziet u hoe u de eigenschap HelpUri toevoegt aan opdrachten van verschillende typen.

Een HelpUri-eigenschap toevoegen aan een cmdlet

Voeg voor cmdlets die zijn geschreven in C# een HelpUri-kenmerk toe aan de cmdlet-klasse. De waarde van het kenmerk moet een URI zijn die begint met http of https .

De volgende code toont het kenmerk HelpUri van de Get-History cmdlet-klasse.

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

Een HelpUri-eigenschap toevoegen aan een geavanceerde functie

Voor geavanceerde functies voegt u de eigenschap HelpUri toe aan het kenmerk CmdletBinding. De waarde van de eigenschap moet een URI zijn die begint met 'http' of 'https'.

De volgende code toont het Kenmerk HelpUri van de New-Calendar functie

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

Een HelpUri-kenmerk toevoegen aan een CIM-opdracht

Voeg voor CIM-opdrachten een HelpUri-kenmerk toe aan het element CmdletMetadata in het CDXML-bestand. De waarde van het kenmerk moet een URI zijn die begint met http of https .

De volgende code toont het kenmerk HelpUri van de Start-Debug CIM-opdracht

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

Een HelpUri-kenmerk toevoegen aan een werkstroom

Voeg een toe voor werkstromen die zijn geschreven in de PowerShell-taal. ExternalHelp comment directive to the workflow code. De waarde van de -richtlijn moet een URI zijn die begint met http of https .

Notitie

De eigenschap HelpUri wordt niet ondersteund voor op XAML gebaseerde werkstromen in PowerShell.

De volgende code toont de . ExternalHelp-richtlijn in een werkstroombestand.

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