Bir yardım bilgisi XML dosyası nasıl adlandırılır?

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.

Bu konu, genellikle HelpInfo XML dosyaları olarak bilinen Güncelleştirilebilir Yardım Bilgileri dosyaları için gerekli ad biçimini açıklamaktadır. HelpInfo XML dosyasının aşağıdaki formatta bir adı olmalıdır.

<ModuleName>_<ModuleGUID>_HelpInfo.xml

İsmin unsurları aşağıdaki gibidir.

  • <ModuleName> - Get-Module cmdlet'inin döndürdüğü ModuleInfo nesnesinin Name özelliğinin değeri.

  • <ModuleGUID> - Modül bildirimindeki GUID anahtarının değeri.

Örneğin, modül adı "TestModule" ise ve modül GUID'si 9cabb9ad-f2ac-4914-a46b-bfc1bebf07f9 ise, modülün HelpInfo XML dosyasının adı şöyle olacaktır:

TestModule_9cabb9ad-f2ac-4914-a46b-bfc1bebf07f9_HelpInfo.xml

İlgili makaleler