Today I have published a new version of PowerShell Cmdlet Help Editor which includes only one major change and number of minor changes.

Notable changes

Main change is tabbed document introduction:

image

Closable tab control is adopted from this blog series: WPF- TabControl Series. I significantly reviewed and rewrote the code, so it is (at least, should be) more stable. Common tab hotkeys (Ctrl + T and Ctrl + W and Ctrl + Tab) are added too.

Other changes

Besides this main change, several important issues are addressed too.

1) There was an issue in the inherited code, which incorrectly read existing XML help file. It separated topic paragraphs by using ‘\n’ character and generated XML didn’t looked as expected in the PowerShell console. I changed the code by reading paragraph by paragraph and separate them with double ‘\r\n’ sequence. That is, in order to create a separate paragraph, press Enter button twice. So, you can visually identify and construct paragraphs which will displayed correctly in the PowerShell console.

2) When I introduced PSHPROJ project file format, I forgot to include parameterset information, as the result, editor crashed when you tried to generate XML file for offline module (which is not loaded). I redesigned PSHPROJ file format by including parameterset information and changing several properties and attributes.

PSHPROJ transition is done automatically: load existing project (module must be online and loaded) and save it. You are not allowed to save project or generate XML if the project file is not upgraded and the module associated with the project is offline (not loaded).

3) Now you can migrate from comment-based help to a XML-based help. Create new project, select the module to import and then Actions –> Import From Comment-based Help. The code internally loads the module and reads the output from Get-Help cmdlet. Note that editor do not modify existing module, you will have to remove comment-based help manually.

4) Sometimes, you need to copy the command name, so I added a context menu to the command list where you can copy command name to a clipboard.

Feedback

Since, it is Beta version, I would like to ask you to test this version and report issues on project page on CodePlex. I’ve tested this version as much as I could, but certain things may be broken.

>> Download Link <<


Share this article:

Comments:

J.  Provencher
J. Provencher 28.08.2019 21:50 (GMT+3) PS Cmdlet Help Editor v3.3.5.0 Beta

This is no longer available.  I found it on github, but it is only source with no downloadable release.  Is there one available?

Vadims Podāns
Vadims Podāns 28.08.2019 22:56 (GMT+3) PS Cmdlet Help Editor v3.3.5.0 Beta

Yeah, sounds like it was burried there. When I get a time, I will upload compiled version.


Post your comment:

Please, solve this little equation and enter result below. Captcha