{"id":14267,"date":"2018-02-08T08:00:12","date_gmt":"2018-02-08T16:00:12","guid":{"rendered":"https:\/\/www.sapien.com\/blog\/?p=14267"},"modified":"2018-02-05T14:55:21","modified_gmt":"2018-02-05T22:55:21","slug":"powershell-helpwriter-2018-released","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2018\/02\/08\/powershell-helpwriter-2018-released\/","title":{"rendered":"PowerShell HelpWriter 2018: Released!"},"content":{"rendered":"<p>We are happy to announce the release of PowerShell HelpWriter 2018, which is included as part of the regular update cycle for our subscribers.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/PowerShell-HelpWriter-2018.png\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"PowerShell HelpWriter 2018\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/PowerShell-HelpWriter-2018_thumb.png\" alt=\"PowerShell HelpWriter 2018\" width=\"644\" height=\"386\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h2>New Features<\/h2>\n<p style=\"background: white; margin: 0in 0in 7.5pt;\">These new features provide more flexibility and control over your PowerShell help.<\/p>\n<p>&nbsp;<\/p>\n<h3>Parameter &#8211; Accepted Values<\/h3>\n<p>You can now edit, add and remove accepted values for parameters:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Accepted-Values.png\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Accepted Values\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Accepted-Values_thumb.png\" alt=\"Accepted Values\" width=\"644\" height=\"385\" border=\"0\" \/><\/a><\/p>\n<p>When generating a help file, PowerShell HelpWriter will load the accepted values list using the Validation Set values, or in the case of an enumerator (Enum), it will use the enumerator values.<\/p>\n<p>The accepted values are now included in the exported <strong>HTML<\/strong> and <strong>Markdown<\/strong>:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/HTML-Preview-Accepted-Values.png\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"HTML Preview - Accepted Values\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/HTML-Preview-Accepted-Values_thumb.png\" alt=\"HTML Preview - Accepted Values\" width=\"644\" height=\"439\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<p>Note: If you use PowerShell Studio\u2019s <strong>New Module from Help File<\/strong> feature, it will automatically create a ValidationSet using the accepted values.<\/p>\n<p>&nbsp;<\/p>\n<h3>Parameter &#8211; Value Required<\/h3>\n<p>You can specify if a parameter\u2019s value is required. In other words, if you use the parameter you must define a value.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Value-Required.png\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Value Required\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Value-Required_thumb.png\" alt=\"Value Required\" width=\"568\" height=\"484\" border=\"0\" \/><\/a><\/p>\n<p><strong>Value Required<\/strong> is not the same as a required parameter. According to Microsoft\u2019s documentation:<\/p>\n<blockquote><p>\u201cThe Required attribute of a parameter value is different from the Required attribute of a parameter.<\/p>\n<p>The required attribute of a parameter indicates whether the parameter (and its value) must be included when invoking the cmdlet. In contrast, the required attribute of a parameter value is used only when the parameter is included in the command. It indicates whether that particular value must be used with the parameter.<\/p>\n<p>Typically, parameter values that are placeholders are required and parameter values that are literal are not required, because they are one of several values that might be used with the parameter.\u201d<\/p><\/blockquote>\n<p>Source: <a title=\"https:\/\/msdn.microsoft.com\/en-us\/library\/bb525442(v=vs.85).aspx\" href=\"https:\/\/msdn.microsoft.com\/en-us\/library\/bb525442(v=vs.85).aspx\">https:\/\/msdn.microsoft.com\/en-us\/library\/bb525442(v=vs.85).aspx<\/a><\/p>\n<p>&nbsp;<\/p>\n<h3>Parameter View \u2013 Help Tooltips<\/h3>\n<p>We added help tooltips explaining the purpose of each field in the designer\u2019s parameter view.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Parameter-View-Tooltips.png\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Parameter View - Tooltips\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Parameter-View-Tooltips_thumb.png\" alt=\"Parameter View - Tooltips\" width=\"644\" height=\"298\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h3>Output Panel \u2013 Coloring<\/h3>\n<p>PowerShell HelpWriter will now change the color of the text to denote errors and warnings in the Output Panel, making important messages stand out.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Output-Pane-Colored-Output.png\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Output Pane - Colored Output\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Output-Pane-Colored-Output_thumb.png\" alt=\"Output Pane - Colored Output\" width=\"644\" height=\"173\" border=\"0\" \/><\/a><\/p>\n<p>Validate errors are also colored:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Output-Pane-Validation.png\" target=\"_blank\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Output Pane - Validation\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/12\/Output-Pane-Validation_thumb.png\" alt=\"Output Pane - Validation\" width=\"644\" height=\"161\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<p>Please continue providing your feedback. Many of the new features included in the service builds are suggestions from users like you. Submit your suggestions or feature requests on the <a href=\"https:\/\/www.sapien.com\/forums\/viewforum.php?f=9\">Wish List and Feature Requests<\/a> forum or the new <a href=\"https:\/\/www.sapien.com\/requests\">Feature Request<\/a> page.<\/p>\n<p>You can view the complete service build log <a href=\"https:\/\/www.sapien.com\/software\/version_history\">here<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>We are happy to announce the release of PowerShell HelpWriter 2018, which is included as part of the regular update cycle for our subscribers. &nbsp; New Features These new features provide more flexibility and control over your PowerShell help. &nbsp; Parameter &#8211; Accepted Values You can now edit, add and remove accepted values for parameters: [&hellip;]<\/p>\n","protected":false},"author":10,"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":[1038,624,21,632],"tags":[1233,953,645,155,141],"class_list":["post-14267","post","type-post","status-publish","format-standard","hentry","category-powershell-helpwriter","category-service-build","category-software-news","category-whats-new-software-news","tag-1233","tag-powershell-help-writer","tag-service-build-2","tag-service-release","tag-whats-new"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/14267","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\/10"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=14267"}],"version-history":[{"count":12,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/14267\/revisions"}],"predecessor-version":[{"id":14445,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/14267\/revisions\/14445"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=14267"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=14267"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=14267"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}