The latest in our video series demonstrates how to work with PowerShell HelpWriter 2018™ to create a new help file for a single function. In this video we show you how to create a fully documented help file for a single function with: Synopsis Detailed Description Syntax Parameters Examples Notes Input / Output Types Resource […]
Category: PowerShell HelpWriter
PowerShell HelpWriter 2018: Create a Single Function Help File
PowerShell HelpWriter™ is an essential application to have in your toolbox, especially when working with existing scripts, functions, or modules. Eventually, your scripts will be shared or given to someone else to maintain, and no one wants to inherit a script that is hard to follow or difficult to understand. Including Help documentation with your […]
Updated Online PowerShell Reference
We’ve just updated our online PowerShell Reference by adding two new sections, 1,706 cmdlets (bringing the total to 5,187!), and some minor enhancements to the cmdlets section. PowerShell Reference contains help for Windows PowerShell and PowerShell modules. This tool allows you to search through Cmdlet Help, About Help, Provider Help, Aliases and Modules with just […]
PowerShell HelpWriter 2017: Service Release v2.1.34
Today we released a new build of PowerShell HelpWriter 2017 (v2.1.34). In this article, we will discuss the new features introduced in this build. Note: If you previously tried to generate help for a module and got an “Operation is not valid due to the current state of the object.” error, please update to […]
PowerShell HelpWriter 2017: What’s New? (Part 1)
PowerShell HelpWriter 2017 is released! PowerShell HelpWriter 2017 is included as part of the regular update cycle for our subscribers. We’ve 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? […]
Friday Puzzle: Phantom Help
On Friday, December 16, 2016, I posted the following puzzle on Twitter. It shows a function that has no comment-based help or XML help, but when you run Get-Help on the function, Get-Help displays both a description and notes for the function. What is the source of help for this function? I call this unintentional […]
New PowerShell Reference Tool
SAPIEN Technologies, Inc. is pleased to introduce our new online Windows PowerShell Reference tool, which is based on the reference section of iPowerShell Pro. To find it, on the SAPIEN web page, click Support and then click PowerShell Reference. Or, go directly to https://www.sapien.com/powershell. PowerShell Reference contains help for Windows PowerShell and PowerShell modules. This […]
SAPIEN Update service bulletin
Recently we introduced a new SAPIEN software update tool, which makes it easier to directly download and install SAPIEN software updates. The tool also updates itself when there is a newer version of the update tool. Unfortunately on some machines that may have caused that process to get stuck, because the file may now be […]
Writing XML Help for Advanced Functions
Follow @juneb_get_help The introduction of SAPIEN PowerShell HelpWriter has made writing XML help files as easy – actually easier – 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 […]
Introducing PowerShell HelpWriter 2015
The help system in Windows PowerShell is well known and much loved. But, it has been very difficult to create XML help files that comply with the PSMAML schema that the Get-Help cmdlet requires. Until now. Introducing PowerShell HelpWriter by SAPIEN Technologies, Inc., the first professional, fully featured help authoring studio for Windows PowerShell help. […]
