Obsługa pomocy online

Począwszy od programu PowerShell 3.0, istnieją dwa sposoby obsługi Get-Help funkcji online dla poleceń programu PowerShell. W tym temacie wyjaśniono, jak zaimplementować tę funkcję dla różnych typów poleceń.

Informacje o pomocy online

Pomoc online zawsze była istotną częścią programu PowerShell. Mimo że polecenie cmdlet wyświetla tematy pomocy w wierszu polecenia, wielu użytkowników preferuje środowisko czytania online, w tym kodowanie kolorami, hiperlinki i udostępnianie pomysłów w programie Community Zawartości i dokumentach opartych na Get-Help wiki. Najważniejsze jest to, że przed pojawieniem się pomocy z programem Updatable pomoc online zapewniała najnowszą wersję plików pomocy.

Wraz z pojawieniem się pomocy z możliwością ujedno jej w programie PowerShell 3.0 pomoc online nadal odgrywa istotną rolę. Oprócz elastycznego interfejsu użytkownika pomoc online zapewnia pomoc dla użytkowników, którzy nie korzystają lub nie mogą korzystać z Pomocy z możliwością ujednoznawnia, aby pobierać tematy pomocy.

Jak działa Get-Help -Online

Aby ułatwić użytkownikom znajdowanie tematów pomocy online dla poleceń, polecenie ma parametr Online, który otwiera wersję online tematu pomocy dla polecenia w domyślnej przeglądarce Get-Help internetowej użytkownika.

Na przykład następujące polecenie otwiera temat pomocy online dla Invoke-Command polecenia cmdlet .

Get-Help Invoke-Command -Online

Aby zaimplementować program , polecenie cmdlet szuka Uniform Resource Identifier (URI) dla tematu Get-Help -Online pomocy wersji online w następujących Get-Help lokalizacjach.

• Pierwszy link w sekcji Powiązane linki w temacie pomocy polecenia. Temat pomocy musi być zainstalowany na komputerze użytkownika. Ta funkcja została wprowadzona w programie PowerShell 2.0.

• Właściwość HelpUri dowolnego polecenia. Właściwość HelpUri jest dostępna nawet wtedy, gdy temat pomocy dla polecenia nie jest zainstalowany na komputerze użytkownika. Ta funkcja została wprowadzona w programie PowerShell 3.0.

  Get-HelpWyszukuje wartość URI w pierwszym wpisie w sekcji Powiązane linki przed uzyskaniem wartości właściwości HelpUri. Jeśli wartość właściwości jest nieprawidłowa lub została zmieniona, możesz ją zastąpić, wprowadzając inną wartość w pierwszym powiązanym linku. Jednak pierwszy powiązany link działa tylko wtedy, gdy tematy pomocy są zainstalowane na komputerze użytkownika.

Dodawanie URI do pierwszego powiązanego linku w temacie pomocy dotyczącej polecenia

Możesz obsługiwać dowolne polecenie, dodając prawidłowy adres URI do pierwszego wpisu w sekcji Powiązane linki tematu pomocy opartego na języku Get-Help -Online XML dla polecenia . Ta opcja jest prawidłowa tylko w tematach pomocy opartych na języku XML i działa tylko wtedy, gdy temat pomocy jest zainstalowany na komputerze użytkownika. Po zainstalowaniu tematu pomocy i wypełnieniu wartości URI ta wartość ma pierwszeństwo przed właściwością HelpUri polecenia.

Aby obsługiwać tę funkcję, w elemencie pod pierwszym elementem w elemencie musi znajdować się maml:uri maml:relatedLinks/maml:navigationLink ten maml:relatedLinks URI.

Poniższy kod XML przedstawia poprawne rozmieszczenie URI. Tekst Online version: w maml:linkText elemencie jest najlepszym rozwiązaniem, ale nie jest wymagany.

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

Dodawanie właściwości HelpUri do polecenia

W tej sekcji pokazano, jak dodać właściwość HelpUri do poleceń różnych typów.

Dodawanie właściwości HelpUri do polecenia cmdlet

W przypadku polecenia cmdlet napisanych w języku C# dodaj atrybut HelpUri do klasy cmdlet. Wartość atrybutu musi być wartością URI, która rozpoczyna się od http lub https .

Poniższy kod przedstawia atrybut HelpUri klasy Get-History polecenia cmdlet.

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

Dodawanie właściwości HelpUri do funkcji zaawansowanej

W przypadku funkcji zaawansowanych dodaj właściwość HelpUri do atrybutu CmdletBinding. Wartość właściwości musi być wartością URI, która rozpoczyna się od "http" lub "https".

Poniższy kod przedstawia atrybut HelpUri New-Calendar funkcji

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

Dodawanie atrybutu HelpUri do polecenia CIM

W przypadku poleceń CIM dodaj atrybut HelpUri do elementu CmdletMetadata w pliku CDXML. Wartość atrybutu musi być wartością URI, która rozpoczyna się od http lub https .

Poniższy kod przedstawia atrybut HelpUri polecenia Start-Debug CIM

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

Dodawanie atrybutu HelpUri do przepływu pracy

W przypadku przepływów pracy napisanych w języku programu PowerShell dodaj element . ExternalHelp, dyrektywa komentarza do kodu przepływu pracy. Wartość dyrektywy musi być wartością URI, która rozpoczyna się od http lub https .

Uwaga

Właściwość HelpUri nie jest obsługiwana w przypadku przepływów pracy opartych na języku XAML w programie PowerShell.

Poniższy kod przedstawia . Dyrektywa ExternalHelp w pliku przepływu pracy.

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