{"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":{"om_disable_all_campaigns":false,"_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"],"aioseo_notices":[],"aioseo_head":"\n\t\t<!-- All in One SEO 5.0.1 - aioseo.com -->\n\t<meta name=\"description\" content=\"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\" \/>\n\t<meta name=\"robots\" content=\"max-image-preview:large\" \/>\n\t<meta name=\"author\" content=\"June Blender\"\/>\n\t<link rel=\"canonical\" href=\"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/\" \/>\n\t<meta name=\"generator\" content=\"All in One SEO (AIOSEO) 5.0.1\" \/>\n\t\t<meta property=\"og:locale\" content=\"en_US\" \/>\n\t\t<meta property=\"og:site_name\" content=\"DEV SAPIEN Blog - Tools for IT Success\" \/>\n\t\t<meta property=\"og:type\" content=\"article\" \/>\n\t\t<meta property=\"og:title\" content=\"Writing XML Help for Advanced Functions - DEV SAPIEN Blog\" \/>\n\t\t<meta property=\"og:description\" content=\"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\" \/>\n\t\t<meta property=\"og:url\" content=\"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/\" \/>\n\t\t<meta property=\"article:published_time\" content=\"2015-04-01T13:00:00+00:00\" \/>\n\t\t<meta property=\"article:modified_time\" content=\"2016-09-27T19:06:23+00:00\" \/>\n\t\t<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n\t\t<meta name=\"twitter:title\" content=\"Writing XML Help for Advanced Functions - DEV SAPIEN Blog\" \/>\n\t\t<meta name=\"twitter:description\" content=\"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\" \/>\n\t\t<script type=\"application\/ld+json\" class=\"aioseo-schema\">\n\t\t\t{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"BlogPosting\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#blogposting\",\"name\":\"Writing XML Help for Advanced Functions - DEV SAPIEN Blog\",\"headline\":\"Writing XML Help for Advanced Functions\",\"author\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\"},\"publisher\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#organization\"},\"datePublished\":\"2015-04-01T06:00:00-07:00\",\"dateModified\":\"2016-09-27T12:06:23-07:00\",\"inLanguage\":\"en-US\",\"commentCount\":21,\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#webpage\"},\"isPartOf\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#webpage\"},\"articleSection\":\"PowerShell HelpWriter, Windows PowerShell, juneb, powershell, PowerShell HelpWriter\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#breadcrumblist\",\"itemListElement\":[{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog#listItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/dev.sapien.com\\\/blog\",\"nextItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/windows-powershell\\\/#listItem\",\"name\":\"Windows PowerShell\"}},{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/windows-powershell\\\/#listItem\",\"position\":2,\"name\":\"Windows PowerShell\",\"item\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/windows-powershell\\\/\",\"nextItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#listItem\",\"name\":\"Writing XML Help for Advanced Functions\"},\"previousItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog#listItem\",\"name\":\"Home\"}},{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#listItem\",\"position\":3,\"name\":\"Writing XML Help for Advanced Functions\",\"previousItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/windows-powershell\\\/#listItem\",\"name\":\"Windows PowerShell\"}}]},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#organization\",\"name\":\"DEV SAPIEN Blog\",\"description\":\"Tools for IT Success\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/\",\"name\":\"June Blender\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#webpage\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/\",\"name\":\"Writing XML Help for Advanced Functions - DEV SAPIEN Blog\",\"description\":\"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\",\"inLanguage\":\"en-US\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#website\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2015\\\/04\\\/01\\\/writing-xml-help-for-advanced-functions\\\/#breadcrumblist\"},\"author\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\"},\"creator\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\"},\"datePublished\":\"2015-04-01T06:00:00-07:00\",\"dateModified\":\"2016-09-27T12:06:23-07:00\"},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/\",\"name\":\"DEV SAPIEN Blog\",\"description\":\"Tools for IT Success\",\"inLanguage\":\"en-US\",\"publisher\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#organization\"}}]}\n\t\t<\/script>\n\t\t<!-- All in One SEO -->\n\n","aioseo_head_json":{"title":"Writing XML Help for Advanced Functions - DEV SAPIEN Blog","description":"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","canonical_url":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/","robots":"max-image-preview:large","keywords":"","webmasterTools":{"miscellaneous":""},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"BlogPosting","@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#blogposting","name":"Writing XML Help for Advanced Functions - DEV SAPIEN Blog","headline":"Writing XML Help for Advanced Functions","author":{"@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author"},"publisher":{"@id":"https:\/\/dev.sapien.com\/blog\/#organization"},"datePublished":"2015-04-01T06:00:00-07:00","dateModified":"2016-09-27T12:06:23-07:00","inLanguage":"en-US","commentCount":21,"mainEntityOfPage":{"@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#webpage"},"isPartOf":{"@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#webpage"},"articleSection":"PowerShell HelpWriter, Windows PowerShell, juneb, powershell, PowerShell HelpWriter"},{"@type":"BreadcrumbList","@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#breadcrumblist","itemListElement":[{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog#listItem","position":1,"name":"Home","item":"https:\/\/dev.sapien.com\/blog","nextItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/topics\/windows-powershell\/#listItem","name":"Windows PowerShell"}},{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/topics\/windows-powershell\/#listItem","position":2,"name":"Windows PowerShell","item":"https:\/\/dev.sapien.com\/blog\/topics\/windows-powershell\/","nextItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#listItem","name":"Writing XML Help for Advanced Functions"},"previousItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog#listItem","name":"Home"}},{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#listItem","position":3,"name":"Writing XML Help for Advanced Functions","previousItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/topics\/windows-powershell\/#listItem","name":"Windows PowerShell"}}]},{"@type":"Organization","@id":"https:\/\/dev.sapien.com\/blog\/#organization","name":"DEV SAPIEN Blog","description":"Tools for IT Success","url":"https:\/\/dev.sapien.com\/blog\/"},{"@type":"Person","@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author","url":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/","name":"June Blender"},{"@type":"WebPage","@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#webpage","url":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/","name":"Writing XML Help for Advanced Functions - DEV SAPIEN Blog","description":"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","inLanguage":"en-US","isPartOf":{"@id":"https:\/\/dev.sapien.com\/blog\/#website"},"breadcrumb":{"@id":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/#breadcrumblist"},"author":{"@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author"},"creator":{"@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author"},"datePublished":"2015-04-01T06:00:00-07:00","dateModified":"2016-09-27T12:06:23-07:00"},{"@type":"WebSite","@id":"https:\/\/dev.sapien.com\/blog\/#website","url":"https:\/\/dev.sapien.com\/blog\/","name":"DEV SAPIEN Blog","description":"Tools for IT Success","inLanguage":"en-US","publisher":{"@id":"https:\/\/dev.sapien.com\/blog\/#organization"}}]},"og:locale":"en_US","og:site_name":"DEV SAPIEN Blog - Tools for IT Success","og:type":"article","og:title":"Writing XML Help for Advanced Functions - DEV SAPIEN Blog","og:description":"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","og:url":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/","article:published_time":"2015-04-01T13:00:00+00:00","article:modified_time":"2016-09-27T19:06:23+00:00","twitter:card":"summary_large_image","twitter:title":"Writing XML Help for Advanced Functions - DEV SAPIEN Blog","twitter:description":"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"},"aioseo_meta_data":{"post_id":"9003","title":null,"description":null,"keywords":null,"keyphrases":null,"focus_keyword":null,"additional_keywords":null,"truseo_locale":null,"primary_term":null,"canonical_url":null,"og_title":null,"og_description":null,"og_object_type":"default","og_image_type":"default","og_image_custom_url":null,"og_image_custom_fields":null,"og_image_url":null,"og_image_width":null,"og_image_height":null,"og_video":null,"og_custom_url":null,"og_article_section":null,"og_article_tags":null,"twitter_use_og":false,"twitter_card":"default","twitter_image_type":"default","twitter_image_custom_url":null,"twitter_image_custom_fields":null,"twitter_image_url":null,"twitter_title":null,"twitter_description":null,"schema_type":"default","schema_type_options":null,"schema":{"blockGraphs":[],"customGraphs":[],"default":{"data":{"Article":[],"Course":[],"Dataset":[],"FAQPage":[],"Movie":[],"Person":[],"Product":[],"ProductReview":[],"Car":[],"Recipe":[],"Service":[],"SoftwareApplication":[],"WebPage":[]},"graphName":"","isEnabled":true},"graphs":[]},"pillar_content":false,"robots_default":true,"robots_noindex":false,"robots_noarchive":false,"robots_nosnippet":false,"robots_nofollow":false,"robots_noimageindex":false,"robots_noodp":false,"robots_notranslate":false,"robots_max_snippet":null,"robots_max_videopreview":null,"robots_max_imagepreview":"large","priority":null,"frequency":null,"local_seo":null,"limit_modified_date":false,"ai":null,"breadcrumb_settings":null,"seo_analyzer_scan_date":null,"created":"2026-08-28 15:55:23","updated":"2026-08-28 15:55:23"},"aioseo_breadcrumb":"<div class=\"aioseo-breadcrumbs\"><span class=\"aioseo-breadcrumb\">\n\t\t\t<a href=\"https:\/\/dev.sapien.com\/blog\" title=\"Home\">Home<\/a>\n\t\t<\/span><span class=\"aioseo-breadcrumb-separator\">&raquo;<\/span><span class=\"aioseo-breadcrumb\">\n\t\t\t<a href=\"https:\/\/dev.sapien.com\/blog\/topics\/windows-powershell\/\" title=\"Windows PowerShell\">Windows PowerShell<\/a>\n\t\t<\/span><span class=\"aioseo-breadcrumb-separator\">&raquo;<\/span><span class=\"aioseo-breadcrumb\">\n\t\t\tWriting XML Help for Advanced Functions\n\t\t<\/span><\/div>","aioseo_breadcrumb_json":[{"label":"Home","link":"https:\/\/dev.sapien.com\/blog"},{"label":"Windows PowerShell","link":"https:\/\/dev.sapien.com\/blog\/topics\/windows-powershell\/"},{"label":"Writing XML Help for Advanced Functions","link":"https:\/\/dev.sapien.com\/blog\/2015\/04\/01\/writing-xml-help-for-advanced-functions\/"}],"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}]}}