{"id":2731,"date":"2011-02-23T21:07:02","date_gmt":"2011-02-23T21:07:02","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/2011\/02\/23\/cmdlet-help-editor-v2-0-with-module-support\/"},"modified":"2019-02-18T13:05:49","modified_gmt":"2019-02-18T20:05:49","slug":"cmdlet-help-editor-v2-0-with-module-support","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/cmdlet-help-editor-v2-0-with-module-support\/","title":{"rendered":"Cmdlet Help Editor V2.0 with Module Support"},"content":{"rendered":"<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"color: #993366\"><span style=\"font-size: small\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">Hi,<\/span><\/span><\/span><\/span><\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"color: #993366\"><span style=\"font-size: small\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">I have updated the Cmdlet Help Editor tool to support Modules. The V1.0 version of this tool only supported PsSnapins.&nbsp;The original post&nbsp;can be found <\/span><\/span><\/span><\/span><\/span><\/span><a href=\"\" title=\"Cmdlet Help Editor v1.0\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">here<\/span><\/span><\/span><\/span><\/span><\/span><\/a><\/span><\/span><span style=\"color: #993366\"><span style=\"font-family: verdana,geneva\"><a href=\"\" title=\"Cmdlet Help Editor v1.0\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">&nbsp;<\/span><\/span><\/span><\/span><\/span><\/a><\/span><\/span><\/p>\n<p><span style=\"color: #1f497d\"><span style=\"font-size: small\"><span style=\"font-family: Calibri\"><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-size: 10pt\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">Cmdlet Help Editor enables you to create help topics for Windows PowerShell cmdlets in the XML format that Windows PowerShell supports. Help text created in Cmdlet Help Editor can be displayed immediately by a Windows PowerShell <i>get-help<\/i> command without any additional transforms or formatting.<\/span><\/span><\/span><\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">&nbsp;<\/span><\/span><\/span><\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-size: 10pt\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">By reflecting on a Windows PowerShell snap-in (PsSnapin) assembly or Module, Cmdlet Help Editor creates a customized documentation interface that includes the cmdlets, their parameters, and parameter attributes. <\/span><\/span><\/span><\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">&nbsp;<\/span><\/span><\/span><\/span><\/p>\n<p><span style=\"font-size: 10pt\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">Cmdlet Help Editor is designed for Windows PowerShell cmdlet developers to make it easy to create excellent cmdlet help. This tool is made available free of charge, but it is not warranted or supported by Microsoft.<\/span><\/span><\/span><\/span><\/p>\n<p><span style=\"font-size: 10pt\"><span style=\"font-family: verdana,geneva\"><span style=\"font-size: x-small\"><span style=\"color: #0a3b6c\">You can download the tool from here:<\/span><\/span><\/span><\/span><\/p>\n<p><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\"><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"color: #1f497d\"><span style=\"font-family: Calibri;font-size: small\">X64: <\/span><a href=\"http:\/\/www.wassimfayed.com\/PowerShell\/CmdletHelpEditorx64.zip\"><span style=\"font-family: Calibri;color: #0000ff;font-size: small\">http:\/\/www.wassimfayed.com\/PowerShell\/CmdletHelpEditorx64.zip<\/span><\/a><span style=\"font-size: small\"><span style=\"font-family: Calibri\"> <\/span><\/span><\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"color: #1f497d\"><span style=\"font-family: Calibri;font-size: small\">X86: <\/span><a href=\"http:\/\/www.wassimfayed.com\/PowerShell\/CmdletHelpEditorx86.zip\"><span style=\"font-family: Calibri;color: #0000ff;font-size: small\">http:\/\/www.wassimfayed.com\/PowerShell\/CmdletHelpEditorx86.zip<\/span><\/a><span style=\"font-size: small\"><span style=\"font-family: Calibri\"> <\/span><\/span><\/span><\/p>\n<p><\/span><\/p>\n<p><span style=\"color: #1f497d\"><font size=\"3\"><font face=\"Calibri\"><\/p>\n<p><p><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\"><\/span><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\"><b><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">System Requirements<\/span><\/b><\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">&nbsp;<\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">Cmdlet Help Editor V1.2 requires that the following operating systems and programs be installed on the computer:<\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">&nbsp;<\/span><\/p>\n<ul type=\"disc\" style=\"margin-top: 0in\">\n<li class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">Windows&nbsp;XP or Windows Server 2003, or a later version of Windows<\/span><\/li>\n<li class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">Windows PowerShell 1.0 or 2.0<\/span><\/li>\n<li class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">Microsoft .NET 2.0 (for Windows PowerShell 1.0 or 2.0)<\/span><\/li>\n<li class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">Microsoft .NET 3.0 (for Cmdlet Help Editor)<\/span><\/li>\n<\/ul>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">&nbsp;<\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">You can download Windows PowerShell 2.0 as part of&nbsp;the latest Windows Management Framework from here: <a href=\"http:\/\/support.microsoft.com\/kb\/968929\">http:\/\/support.microsoft.com\/kb\/968929<\/a>&nbsp;<\/span>&nbsp;<\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">For additional information and to report bugs\/issues with the tool, please contact <a href=\"mailto:Wfayed@Microsoft.com\"><span style=\"color: #0066dd\">Wfayed@Microsoft.com<\/span><\/a> <\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\"><\/span>&nbsp;<\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">Enjoy the tool,<\/span><\/p>\n<p class=\"MsoNormal\" style=\"margin: 0in 0in 0pt\"><span style=\"font-family: 'Verdana', 'sans-serif';font-size: 10pt\">Wassim [MSFT]<\/span><\/p>\n<\/p>\n<p><\/font><\/font><\/span><\/span><span style=\"color: #1f497d\"><font size=\"3\"><\/p>\n<p>&nbsp;<\/p>\n<p><\/font><\/span><\/span><\/span><\/p>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Hi, I have updated the Cmdlet Help Editor tool to support Modules. The V1.0 version of this tool only supported PsSnapins.&nbsp;The original post&nbsp;can be found here&nbsp; Cmdlet Help Editor enables you to create help topics for Windows PowerShell cmdlets in the XML format that Windows PowerShell supports. Help text created in Cmdlet Help Editor can [&hellip;]<\/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":[253],"class_list":["post-2731","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-powershell-cmdlet-help"],"acf":[],"blog_post_summary":"<p>Hi, I have updated the Cmdlet Help Editor tool to support Modules. The V1.0 version of this tool only supported PsSnapins.&nbsp;The original post&nbsp;can be found here&nbsp; Cmdlet Help Editor enables you to create help topics for Windows PowerShell cmdlets in the XML format that Windows PowerShell supports. Help text created in Cmdlet Help Editor can [&hellip;]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/2731","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=2731"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/2731\/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=2731"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=2731"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=2731"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}