Çevrimiçi Yardımı Destekleme

PowerShell 3.0'dan itibaren PowerShell komutları için Çevrimiçi özelliğini Get-Help desteklemenin iki yolu vardır. Bu konu, bu özelliğin farklı komut türleri için nasıl uygulandığını açıklar.

Çevrimiçi Yardım Hakkında

Çevrimiçi yardım her zaman PowerShell'in önemli bir parçası oldu. cmdlet'i komut isteminde yardım konularını görüntülese de, birçok kullanıcı renk kodlama, köprüler ve Community İçerik ve wiki tabanlı belgelerdeki fikir paylaşma gibi çevrimiçi okuma deneyimini Get-Help tercih eder. En önemlisi, Güncel Yardım'ın gelişi öncesinde, çevrimiçi yardım yardım dosyalarının en güncel sürümünü sağladı.

PowerShell 3.0'da Öne Alınamayan Yardım'ın gelişiyle, çevrimiçi yardım hala önemli bir rol oynar. Esnek kullanıcı deneyimine ek olarak, çevrimiçi yardım, yardım konularını indirmek için Güncelleştirme Yardım'ı kullanmayan veya kullanamayan kullanıcılara yardım sağlar.

-Online Get-Help Nasıl Çalışır?

Kullanıcıların komutlara ilişkin çevrimiçi yardım konularını bulmalarına yardımcı olmak için komutun, kullanıcının varsayılan internet tarayıcısında bir komutun çevrimiçi yardım konusunun çevrimiçi sürümünü açan bir Get-Help Çevrimiçi parametresi vardır.

Örneğin, aşağıdaki komut cmdlet'i için çevrimiçi Invoke-Command yardım konusunu açar.

Get-Help Invoke-Command -Online

uygulamak için, cmdlet aşağıdaki konumlarda çevrimiçi sürüm yardım konusu için tekdü Kaynak Tanımlayıcısı Get-Help -Online Get-Help (URI) için bir görünüme sahiptir.

• Komutun yardım konusunun İlgili Bağlantılar bölümündeki ilk bağlantı. Yardım konusu kullanıcının bilgisayarına yük olmalıdır. Bu özellik PowerShell 2.0'da tanıtıldı.

• Herhangi bir komutun HelpUri özelliği. Komutun yardım konusu kullanıcının bilgisayarına yüklenmese bile HelpUri özelliğine erişilebilir. Bu özellik PowerShell 3.0'da tanıtıldı.

  Get-Help HelpUri özellik değerini almadan önce İlgili Bağlantılar bölümündeki ilk girdide bir URI'yi okur. Özellik değeri yanlışsa veya değişmişse, ilk ilgili bağlantıya farklı bir değer girerek bunu geçersiz kılabilirsiniz. Ancak, ilk ilgili bağlantı yalnızca yardım konuları kullanıcının bilgisayarına yüklenirken çalışır.

Komut yardım konusunun ilk ilgili bağlantısına URI ekleme

Komutun XML tabanlı yardım konusunun İlgili Bağlantılar bölümündeki ilk girdiye geçerli bir URI ekleyerek herhangi bir komutu Get-Help -Online destekleyebilirsiniz. Bu seçenek yalnızca XML tabanlı yardım konularında geçerlidir ve yalnızca yardım konusu kullanıcının bilgisayarına yüklenirken çalışır. Yardım konusu yüklü olduğunda ve URI doldurulduğunda, bu değer komutun HelpUri özelliğine göre önceliklidir.

Bu özelliği desteklemek için, URI öğesinde maml:uri ilk öğenin maml:relatedLinks/maml:navigationLink altında öğesinde görün maml:relatedLinks gerekir.

Aşağıdaki XML, URI'nin doğru yerleşimini gösterir. öğesinde Online version: metin en iyi maml:linkText uygulamadır, ancak gerekli değildir.

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

Bir komuta HelpUri özelliğini ekleme

Bu bölümde, farklı türlerde komutlara HelpUri özelliğinin nasıl ekli olduğu gösterir.

Cmdlet'e HelpUri Özelliği Ekleme

C# ile yazılmış cmdlet'ler için Cmdlet sınıfına bir HelpUri özniteliği ekleyin. özniteliğinin değeri veya ile başlayan bir URI http olması https gerekir.

Aşağıdaki kod, cmdlet sınıfının HelpUri Get-History özniteliğini gösterir.

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

Gelişmiş İşleve HelpUri Özelliği Ekleme

Gelişmiş işlevler için CmdletBinding özniteliğine bir HelpUri özelliği ekleyin. Özelliğin değeri "http" veya "https" ile başlayan bir URI olması gerekir.

Aşağıdaki kod, işlevin HelpUri özniteliğini New-Calendar gösterir

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

CIM Komutuna HelpUri Özniteliği Ekleme

CIM komutları için CDXML dosyasındaki CmdletMetadata öğesine bir HelpUri özniteliği ekleyin. özniteliğinin değeri veya ile başlayan bir URI http olması https gerekir.

Aşağıdaki kod, CIM komutunun HelpUri Start-Debug özniteliğini gösterir

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

bir İş Akışına HelpUri Özniteliği Ekleme

PowerShell dilinde yazılmış iş akışları için bir ekleyin. İş akışı koduna ExternalHelp açıklama yönergesi. yönergesi değeri veya ile başlayan bir URI http olması https gerekir.

Aşağıdaki kod, kodunu gösterir. Bir iş akışı dosyasında ExternalHelp yönergesi.

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