As you\u2019ve probably picked up by now \u2013 Advanced Functions are super important. We’ve been showing a bunch of scripts that have embedded help using comments and dot-tags. Let me take a second and drill into this.<\/p>\n
We believe that PS will be used in a wide range of; scenarios: simple one liners; personal ad hoc scripts; scripts you share with your friends; scripts you share with the community; scripts you in your commercial product. It is our goal to have a single mechanism with progressively richer and richer optional features to support this entire range of scenarios. We\u2019ve been showing you the Community Help experience but we have also designed it so that commercial products can ship PS scripts. In particular, we support the ability to have external MAML help which can be localized into multiple languages. This is not implemented in CTP3 but we expect to support it in V2.<\/p>\n
Below is an excerpt from Refaat Issa\u2019s spec.<\/p>\n
Enjoy!<\/p>\n
Jeffrey Snover [MSFT]\nWindows Management Partner Architect\nVisit the Windows PowerShell Team blog at: http:\/\/blogs.msdn.com\/PowerShell<\/a>\nVisit the Windows PowerShell ScriptCenter at: http:\/\/www.microsoft.com\/technet\/scriptcenter\/hubs\/msh.mspx<\/a><\/p>\n External MAML Help<\/span><\/strong><\/p>\n When a full-fledged MAML file is required, or when localization into other languages is essential, a script author can add external MAML help to a function.<\/p>\n Traditionally, MAML help files for cmdlets were packaged in the snap-in, along with the cmdlets themselves. The snap-in installation process placed the MAML files into the folder $pshome\\en-US. The culture-specific folder (en-US) varies according to the operating system\u2019s UI culture.<\/p>\n Functions should not use the same folder to place their MAML files because $pshome requires administrative rights, which the script author may not have. However, the Get-Help language folder hierarchy and fallback mechanism will be used for functions as well.\nSyntax: .ExternalHelp C:\\MyScripts\\MyHelpfile.xmlThe external MAML help file name & path are indicated in the ExternalHelp inline help directive.<\/p>\n The argument value (C:\\MyScripts\\MyHelpfile.xml) is resolved in the following order:<\/p>\n Notes:<\/p>\n As you\u2019ve probably picked up by now \u2013 Advanced Functions are super important. We’ve been showing a bunch of scripts that have embedded help using comments and dot-tags. Let me take a second and drill into this. We believe that PS will be used in a wide range of; scenarios: simple one liners; personal ad […]<\/p>\n","protected":false},"author":600,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[137,194,210],"class_list":["post-17818","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-ctp3","tag-helpfile","tag-jeffrey-snover"],"acf":[],"blog_post_summary":" As you\u2019ve probably picked up by now \u2013 Advanced Functions are super important. We’ve been showing a bunch of scripts that have embedded help using comments and dot-tags. Let me take a second and drill into this. We believe that PS will be used in a wide range of; scenarios: simple one liners; personal ad […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/17818","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/600"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=17818"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/17818\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=17818"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=17818"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=17818"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
\n