Çevrimiçi Yardımın Desteklenmesi

Not

XML tabanlı yardımın manuel olarak yazılması çok zordur. PlatyPS modülü, Markdown'da yardım yazmanıza ve ardından bunu XML tabanlı yardıma dönüştürmenize olanak tanır. Bu, yardım yazmayı ve sürdürmeyi çok daha kolaylaştırır. PlatyPS ayrıca sizin için Güncellenebilir Yardım paketleri de oluşturabilir. Daha fazla bilgi için PlatyPS kullanarak XML tabanlı yardım oluşturma konusuna bakın.

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

Çevrimiçi Yardım Hakkında

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

PowerShell 3.0'da Güncellenebilir Yardım'ın kullanıma sunulmasıyla çevrimiçi yardım hala hayati bir rol oynamaya devam ediyor. Çevrimiçi yardım, esnek kullanıcı deneyimine ek olarak, yardım konularını indirmek için Güncellenebilir Yardım'ı kullanmayan veya kullanamayan kullanıcılara yardım sağlar.

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

Kullanıcıların komutlara ilişkin çevrimiçi yardım konularını bulmalarına yardımcı olmak için, Get-Help komutu, kullanıcının varsayılan internet tarayıcısındaki bir komut için yardım konusunun çevrimiçi sürümünü açan bir Çevrimiçi parametreye 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 -Online'u uygulamak için Get-Help cmdlet'i, aşağıdaki konumlarda çevrimiçi sürüm yardım konusuna yönelik bir Tekdüzen Kaynak Tanımlayıcısı (URI) arar.

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

    'deki ilk bağlantı Geçerli bir URI ekleyerek herhangi bir komut için Get-Help -Online'ı destekleyebilirsiniz. komutun XML tabanlı yardım konusunun İlgili Bağlantılar bölümündeki ilk girişe gidin. 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ğine göre öncelikli olur.

    Bu özelliği desteklemek için URI'nin, maml:tainedLinks içindeki ilk maml:tainedLinks/maml:navigationLink öğesinin altındaki maml:uri öğesinde görünmesi gerekir. kod > öğesi.

    Aşağıdaki XML, URI'nin doğru yerleşimini gösterir. maml:linkText öğesindeki Çevrimiçi sürüm: metni en iyi uygulamadır ancak zorunlu 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>

    HelpUri özelliğini bir komuta ekleme

    Bu bölümde HelpUri özelliğinin farklı türdeki komutlara nasıl ekleneceği gösterilmektedir.

    Bir Cmdlet'e HelpUri Özelliği Ekleme

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

    Aşağıdaki kod, Get-History cmdlet sınıfının HelpUri özelliğ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 özelliğine bir HelpUri özelliği ekleyin. Özelliğin değeri "http" veya "https" ile başlayan bir URI olmalıdır.

    Aşağıdaki kod, Yeni Takvim işlevinin HelpUri özelliğini gösterir

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

    Bir cim komutuna HelpUri niteliği ekleme

    CIM komutları için, CDXML dosyasındaki CmdletMetadata öğesine bir HelpUri niteliği ekleyin. Özelliğin değeri http veya https ile başlayan bir URI olmalıdır.

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

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

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

    PowerShell dilinde yazılan iş akışları için iş akışı koduna bir .ExternalHelp yorum yönergesi ekleyin. Yönergenin değeri http veya https ile başlayan bir URI olmalıdır.

    Not

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

    Aşağıdaki kod, bir iş akışı dosyasındaki .ExternalHelp yönergesini gösterir.

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

İlgili makaleler