{"id":9003,"date":"2015-04-01T06:00:00","date_gmt":"2015-04-01T13:00:00","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/?p=9003"},"modified":"2016-09-27T12:06:23","modified_gmt":"2016-09-27T19:06:23","slug":"writing-xml-help-for-advanced-functions","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/","title":{"rendered":"Writing XML Help for Advanced Functions"},"content":{"rendered":"<p><a class=\"twitter-follow-button\" href=\"https:\/\/twitter.com\/juneb_get_help\" data-lang=\"en\">Follow @juneb_get_help<\/a><\/p>\n<p>The introduction of SAPIEN <a href=\"https:\/\/www.sapien.com\/software\/powershell_helpwriter\" target=\"_blank\">PowerShell HelpWriter<\/a> has made writing XML help files as easy \u2013 actually easier \u2013 than writing comment-based help. XML help is more robust and less error-prone than comment-based help. It supports updatable help and help in multiple languages, and it lets you separate help files from script and modules files, which is a real advantage when you&#8217;re working with many people in a shared coding environment, like GitHub.<\/p>\n<p>PowerShell HelpWriter makes it easy to create XML help files for all commands in a module, including the functions in a manifest module or script module: just click <strong>New<\/strong>\/<strong>New Help File (from Module)<\/strong>. But, you&#8217;re not quite done. It takes a few more steps to associate a function with the XML help file.<\/p>\n<p>Read the full article in the <a href=\"http:\/\/info.sapien.com\/index.php\/scripting\/scripting-help\/writing-xml-help-for-advanced-functions\">SAPIEN Information Center<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Follow @juneb_get_help The introduction of SAPIEN PowerShell HelpWriter has made writing XML help files as easy \u2013 actually easier \u2013 than writing comment-based help. XML help is more robust and less error-prone than comment-based help. It supports updatable help and help in multiple languages, and it lets you separate help files from script and modules [&hellip;]<\/p>\n","protected":false},"author":31,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[952,25],"tags":[934,28,953],"class_list":["post-9003","post","type-post","status-publish","format-standard","hentry","category-powershell-help-writer","category-windows-powershell","tag-juneb","tag-powershell","tag-powershell-help-writer"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/9003","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/31"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=9003"}],"version-history":[{"count":37,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/9003\/revisions"}],"predecessor-version":[{"id":12724,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/9003\/revisions\/12724"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=9003"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=9003"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=9003"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}