Yardım dosyalarını dönüştürün ve yayımlayın

Bu noktada, Markdown yardım dosyalarını oluşturmayı, düzenlemeyi ve test etmeyi bitirmiş olmalısınız. Sonraki adım, Markdown kaynak dosyalarını MAML yardım dosyalarına dönüştürmek ve modülünüz için yayımlamaktır.

Markdown dosyalarını MAML'ye dönüştürme

Aşağıdaki örnek, dizindeki .\WidgetModule Markdown yardım dosyalarını içeri aktarır ve ardından komutu dizindeki .\maml MAML biçimine dışarı aktarır help .

Measure-PlatyPSMarkdown -Path .\WidgetModule\*.md |
    Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Export-MamlCommandHelp -OutputFolder .\maml

Yardım dosyalarını yayımlama

İki yayımlama seçeneği vardır:

• Yardım dosyalarını modüle dahil et
• Güncellenebilir Yardım için yardım dosyalarını paketleme

1. Seçenek: Yardım dosyalarını modüle dahil etme

Cmdlet, Get-Help modül dizininin dile özgü alt dizinlerinde modül Yardım konusu dosyalarını arar. MAML yardım dosyalarını ve tüm about_*.help.txt dosyaları modül dizinindeki dile özgü bir klasöre kopyalayın. Klasör adı, gibi en-USkültür kodu biçimini kullanmalıdır. Örneğin, aşağıdaki dizin yapısı diyagramı WidgetModule modülünün Yardım konularının konumunu gösterir.

<PSModulePath>/
└── WidgetModule/
    └── en-US/
        ├── about_WidgetModule.help.txt
        ├── WidgetModule-Help.xml
        └── NestedWidgetModule.dll-Help.xml

Uyarı

Örnekte yer tutucu, ortam değişkenindeki <PSModulePath> yollardan birini (örneğin$env:PSModulePath, $HOME\Documents\Modules , $PSHOME\Modulesveya kullanıcı tarafından belirtilen özel bir yol) temsil eder.

Başka dillerde yardım oluşturduysanız, her dil için ek klasörler oluşturun.

2. Seçenek: Güncelleştirilebilir Yardım için yardım dosyalarını paketleme

Güncelleştirilebilir Yardım'ı desteklemek için, yardım dosyasını (hem MAML hem de metin tabanlı yardım) bir arşiv dosyasında paketlemeniz ve yardım içeriğinin indirme konumunu, yardım sürümünü ve kullanılabilir dilleri içeren bir HelpInfo.xml dosya oluşturmanız gerekir.

Ayrıca yardım içeriğini HTTPS'yi destekleyen bir web sunucusunda barındırmanız gerekir. Modülün bir modül bildirimi olmalıdır. Bildirimdeki HelpInfoUri özelliği, dosyanın bulunduğu web sunucusundaki klasör konumunun URL'sini HelpInfo.xml içermelidir. Bu URL, dosyanın tam yolu HelpInfo.xml değil, klasör konumu olmalı ve eğik çizgi (/) karakteriyle bitmelidir.

Daha fazla bilgi için bkz: Güncelleştirilebilir Yardım Yazma.

PlatyPS bu süreci kolaylaştırır. Modül Markdown dosyasını oluşturduğunuzda modül bildirimi HelpInfoUri özelliğini içeriyorsa, PlatyPS gerekli meta verileri otomatik olarak Markdown dosyasına ekler. Güncelleştirilebilir Yardım paketini oluşturmak için aşağıdaki örneği kullanın.

$params = @{
    CabinetFilesFolder = '.\maml\WidgetModule'
    MarkdownModuleFile = '.\WidgetModule\WidgetModule.md'
    OutputFolder       = '.\helppackage'
}
New-HelpCabinetFile @params

CabinetFilesFolder parametresi, pakete eklenecek MAML ve metin tabanlı yardım dosyalarını içeren klasörü belirtir. MarkdownModuleFile parametresi, dosyayı oluşturmak HelpInfo.xml için gereken meta verileri içeren modül Markdown dosyasını belirtir. OutputFolder parametresi, .cab ve .zip dosyalarının ve HelpInfo.xml dosyanın oluşturulduğu klasörü belirtir. Bu dosyaları özelliği tarafından belirtilen konumdaki web sunucusuna kopyalayın HelpInfoUri .

Bildirimdeki HelpInfoUri özelliği, dosyanın bulunduğu web sunucusundaki klasör konumunun URL'sini HelpInfo.xml içermelidir. Cmdlet Update-Help , dosyanın tam yolunu HelpInfo.xml oluşturmak için bu konumu kullanır. Cmdlet Update-Help , yardım içerik dosyalarının tam yolunu oluşturmak için dosyadaki HelpInfo.xml bilgileri kullanır.

Daha fazla bilgi için bkz: Güncelleştirilebilir Yardım Nasıl Çalışır?.