{"id":13094,"date":"2017-01-17T10:00:45","date_gmt":"2017-01-17T18:00:45","guid":{"rendered":"https:\/\/www.sapien.com\/blog\/?p=13094"},"modified":"2017-01-20T13:15:39","modified_gmt":"2017-01-20T21:15:39","slug":"powershell-helpwriter-2017-what-new-part-1","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2017\/01\/17\/powershell-helpwriter-2017-what-new-part-1\/","title":{"rendered":"PowerShell HelpWriter 2017: What&#8217;s New? (Part 1)"},"content":{"rendered":"<p>PowerShell HelpWriter 2017 is released! PowerShell HelpWriter 2017 is included as part of the regular update cycle for our subscribers.<\/p>\n<p>We\u2019ve written a series of blog posts to introduce you to the newest features of the product and in this release, we made major changes to PowerShell HelpWriter.<\/p>\n<h3>What do we mean by major changes?<\/h3>\n<p>By major changes, we mean we completely rewrote the whole UI for the application from the ground up. We gave the application a complete overhaul to keep it in line with PowerShell Studio\u2019s interface.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/PowerShell-HelpWriter-2017.png\" target=\"_blank\"><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 2017\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/PowerShell-HelpWriter-2017_thumb.png\" alt=\"PowerShell HelpWriter 2017\" width=\"504\" height=\"307\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h1>What\u2019s New?<\/h1>\n<p>In this article we will discuss some of the major changes and additions in this series of What\u2019s New articles. Let\u2019s get started.<\/p>\n<p>&nbsp;<\/p>\n<h2>New Designer<\/h2>\n<p>We updated the designer and included various improvements to make editing your help files easier.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Designer-Cmdlet.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Designer Cmdlet\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Designer-Cmdlet_thumb.png\" alt=\"Designer Cmdlet\" width=\"504\" height=\"305\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h3>Expanding Edit Fields<\/h3>\n<p>One of the new additions is expanding edit fields that adjust to their content. This allows you to read the complete descriptions without requiring you to scroll within a tiny box.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Expanding-Edit-Fields.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Expanding Edit Fields\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Expanding-Edit-Fields_thumb.png\" alt=\"Expanding Edit Fields\" width=\"504\" height=\"213\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h3>Parameter Sets and Syntax Improvements<\/h3>\n<p>PowerShell HelpWriter now displays parameter set names and their corresponding syntax.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/ParameterSets-Designer.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"ParameterSets Designer\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/ParameterSets-Designer_thumb.png\" alt=\"ParameterSets Designer\" width=\"504\" height=\"197\" border=\"0\" \/><\/a><\/p>\n<p>To view a parameter set\u2019s parameters, simply select the parameter set in the list and the Parameters section will display the corresponding parameters.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/ParameterSets-Parameters.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"ParameterSets Parameters\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/ParameterSets-Parameters_thumb.png\" alt=\"ParameterSets Parameters\" width=\"504\" height=\"124\" border=\"0\" \/><\/a><\/p>\n<p>The Navigation panel also displays the parameter set names:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/ParameterSet-Names.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"ParameterSet Names\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/ParameterSet-Names_thumb.png\" alt=\"ParameterSet Names\" width=\"204\" height=\"212\" border=\"0\" \/><\/a><\/p>\n<p>You can also edit the parameter set names directly in the Navigation panel.<\/p>\n<p>&nbsp;<\/p>\n<h3>Context Menu Improvements<\/h3>\n<p>We added new context menus and options to make authoring help files easier and faster.<\/p>\n<p>For example, you can add existing parameters to a parameter set:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Context-Menu-Add-Existing-Parameter.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Context Menu - Add Existing Parameter\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Context-Menu-Add-Existing-Parameter_thumb.png\" alt=\"Context Menu - Add Existing Parameter\" width=\"556\" height=\"373\" border=\"0\" \/><\/a><\/p>\n<p>Or add a link to another cmdlet in the help file:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Context-Menu-Add-Link.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Context Menu - Add Link\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Context-Menu-Add-Link_thumb.png\" alt=\"Context Menu - Add Link\" width=\"531\" height=\"159\" border=\"0\" \/><\/a><\/p>\n<p>Or use the navigation context menu to visit a link\u2019s URL:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Context-Menu-Visit-Link-URL.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Context Menu - Visit Link URL\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Context-Menu-Visit-Link-URL_thumb.png\" alt=\"Context Menu - Visit Link URL\" width=\"327\" height=\"166\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h3>Breadcrumb Navigation<\/h3>\n<p>You can now use the breadcrumb control to navigate the help contents:<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Breadcrumb-Navigate-cmdlets.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Breadcrumb Navigate cmdlets\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Breadcrumb-Navigate-cmdlets_thumb.png\" alt=\"Breadcrumb Navigate cmdlets\" width=\"543\" height=\"177\" border=\"0\" \/><\/a><\/p>\n<p>It allows you to jump to various help objects through the document.<\/p>\n<p>&nbsp;<\/p>\n<h2>New XML Editor<\/h2>\n<p>We added a new XML editor that provides syntax help and display validation errors as you go.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/New-XML-Editor.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"New XML Editor\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/New-XML-Editor_thumb.png\" alt=\"New XML Editor\" width=\"504\" height=\"252\" border=\"0\" \/><\/a><\/p>\n<p>The new editor also supports formatting and provides XML PrimalSense for the MAML Schema.<\/p>\n<h3><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/XML-PrimalSense.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"XML PrimalSense\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/XML-PrimalSense_thumb.png\" alt=\"XML PrimalSense\" width=\"504\" height=\"236\" border=\"0\" \/><\/a><\/h3>\n<h2><\/h2>\n<h2>Module Selection Dialog<\/h2>\n<p>We also revamped the Module Selection Dialog for PowerShell HelpWriter.<\/p>\n<p>The dialog now displays the author and company in addition to the version for each module. You now have the option to filter the results using the search field.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Select-Module-Dialog.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Select Module Dialog\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Select-Module-Dialog_thumb.png\" alt=\"Select Module Dialog\" width=\"504\" height=\"278\" border=\"0\" \/><\/a><\/p>\n<p>PowerShell HelpWriter allows you to create help for specific versions of a module by simply selecting the desired version from the list.<\/p>\n<p>In the case where the module isn\u2019t located in a PSModulePath directory, you can instead select the module using the Browse button.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Browse-for-module.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Browse for module\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Browse-for-module_thumb.png\" alt=\"Browse for module\" width=\"504\" height=\"296\" border=\"0\" \/><\/a><\/p>\n<h2>Preview<\/h2>\n<p>The new Preview panel allows you to preview the selected cmdlet\u2019s full help without having to leave the application.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Preview-Panel.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Preview Panel\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Preview-Panel_thumb.png\" alt=\"Preview Panel\" width=\"504\" height=\"349\" border=\"0\" \/><\/a><\/p>\n<p>Any modifications made during editing will be reflected in the Preview panel.<\/p>\n<p>&nbsp;<\/p>\n<h2>About Topics<\/h2>\n<p>You can now create about topic files using PowerShell HelpWriter 2017. The about topic editor visually distinguishes headers from normal text in order to facilitate your editing experience.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/About_Topics.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"About_Topics\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/About_Topics_thumb.png\" alt=\"About_Topics\" width=\"504\" height=\"257\" border=\"0\" \/><\/a><\/p>\n<p>PowerShell HelpWriter 2017 provides you with a starting template that you can edit to fit your needs.<\/p>\n<p>&nbsp;<\/p>\n<h2>Auto Correct Help Files<\/h2>\n<p>PowerShell HelpWriter 2017 will automatically correct common structural issues to keep the file in compliance with the help schema. No user intervention needed.<\/p>\n<p><a href=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Autocorrect-file-structure.png\" target=\"_blank\"><img loading=\"lazy\" decoding=\"async\" style=\"background-image: none; padding-top: 0px; padding-left: 0px; display: inline; padding-right: 0px; border-width: 0px;\" title=\"Autocorrect file structure\" src=\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2017\/01\/Autocorrect-file-structure_thumb.png\" alt=\"Autocorrect file structure\" width=\"504\" height=\"202\" border=\"0\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h2>Improved Performance<\/h2>\n<p>PowerShell HelpWriter 2017\u2019s performance has improvement over the previous versions. We drastically reduced the load speeds of large help files (AWS I\u2019m looking at you!). We also reduced the transition time when switching between the designer and the XML editor. Saving the document is no longer necessary when switching between the two.<\/p>\n<p>&nbsp;<\/p>\n<p>Next in Part 2, we will cover the new project feature for PowerShell HelpWriter.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>PowerShell HelpWriter 2017 is released! PowerShell HelpWriter 2017 is included as part of the regular update cycle for our subscribers. We\u2019ve written a series of blog posts to introduce you to the newest features of the product and in this release, we made major changes to PowerShell HelpWriter. What do we mean by major changes? [&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":[952,624,21,632],"tags":[1179,28,953,645,155,141],"class_list":["post-13094","post","type-post","status-publish","format-standard","hentry","category-powershell-help-writer","category-service-build","category-software-news","category-whats-new-software-news","tag-1179","tag-powershell","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\/13094","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=13094"}],"version-history":[{"count":9,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/13094\/revisions"}],"predecessor-version":[{"id":13276,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/13094\/revisions\/13276"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=13094"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=13094"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=13094"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}