Çevrimiçi Yardımı Destekleme

Makale
2025-03-25

Uyarı

XML tabanlı yardımın el ile yazılması çok zordur. PlatyPS modülü, Markdown'da yardım yazmanızı ve xml tabanlı yardıma dönüştürmenizi sağlar. Bu, yardım yazmayı ve sürdürmeyi çok daha kolay hale getirir. PlatyPS sizin için Güncelleştirilebilir Yardım paketlerini de oluşturabilir. Daha fazla bilgi için PlatyPSkullanarak XML tabanlı yardım oluşturma bölümüne bakın.

PowerShell 3.0'da başlayarak, PowerShell komutları için Get-Help Online özelliğini desteklemenin iki yolu vardır. Bu konuda, bu özelliğin farklı komut türleri için nasıl uygulanacakları açıklanmaktadır.

Çevrimiçi Yardım hakkında

Çevrimiçi yardım her zaman PowerShell'in önemli bir parçası olmuştur. Get-Help cmdlet'i komut isteminde yardım konuları görüntülese de, birçok kullanıcı renk kodlaması, köprüler ve Topluluk İçeriği ve wiki tabanlı belgelerde fikir paylaşımı gibi çevrimiçi okuma deneyimini tercih eder. En önemlisi, Güncelleştirilebilir Yardım'ın ortaya çıkmasından önce çevrimiçi yardım, yardım dosyalarının en up-togüncel sürümünü sağladı.

PowerShell 3.0'da Güncelleştirilebilir Yardım'ın ortaya çıkmasıyla, ç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ştirilebilir Yardım'ı kullanmayan veya kullanamayan kullanıcılara yardım sağlar.

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

Kullanıcıların komutlarla ilgili çevrimiçi yardım konularını bulmasına yardımcı olmak için, Get-Help komutu, kullanıcının varsayılan internet tarayıcısında bir komut için yardım konusunun çevrimiçi sürümünü açan bir Çevrimiçi parametresine sahiptir.

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

Get-Help Invoke-Command -Online

Get-Help -Onlineuygulamak için, Get-Help cmdlet'i aşağıdaki konumlarda çevrimiçi sürüm yardım konusu için bir Tekdüzen Kaynak Tanımlayıcısı (URI) arar.

komutu için yardım konusunun İlgili Bağlantılar bölümündeki ilk bağlantı. Yardım konusu kullanıcının bilgisayarına yüklenmelidir. Bu özellik PowerShell 2.0'da kullanıma sunulmuştur.
Herhangi bir komutun HelpUri özelliği. HelpUri özelliğine, komutun yardım konusu kullanıcının bilgisayarında yüklü olmasa bile erişilebilir. Bu özellik PowerShell 3.0'da kullanıma sunulmuştur.

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

Komutun XML tabanlı yardım konusunun İlgili Bağlantılar bölümündeki ilk girdiye geçerli bir URI ekleyerek herhangi bir komut için 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üklendiğinde çalışır. Yardım konusu yüklendiğinde ve URI doldurulduğunda, bu değer komutun HelpUri özelliğinden önceliklidir.

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

Aşağıdaki XML, URI'nin doğru yerleşimini gösterir. maml:linkText öğesindeki Online version: metin en iyi yöntemdir, 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ürlerdeki komutlara HelpUri özelliğinin nasıl ekleneceği gösterilmektedir.

Cmdlet'e HelpUri Özelliği Ekleme

C# dilinde yazılan cmdlet'ler için Cmdlet sınıfına HelpUri özniteliği ekleyin. özniteliğinin değeri, http veya httpsile başlayan bir URI olmalıdır.

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

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

Gelişmiş bir işleve HelpUri özelliği ekleme

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

Aşağıdaki kod, New-Calendar işlevinin HelpUri özniteliğini 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, http veya httpsile başlayan bir URI olmalıdır.

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

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

İş akışına HelpUri özniteliği ekleme

PowerShell dilinde yazılmış iş akışları için iş akışı koduna bir .EXTERNALHELP açıklama anahtar sözcüğü ekleyin. anahtar sözcüğün değeri, http veya httpsile başlayan bir URI olmalıdır.

Uyarı

HelpUri özelliği PowerShell'deki XAML tabanlı iş akışları için desteklenmez.

Aşağıdaki kod, bir iş akışı dosyasındaki .EXTERNALHELP anahtar sözcüğünü gösterir.

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

Aracılığıyla paylaş