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 files, which is a real advantage when you’re working with many people in a shared coding environment, like GitHub.
PowerShell HelpWriter makes it easy to create XML help files for all commands in a module, including the functions in a manifest module or script module: just click New/New Help File (from Module). But, you’re not quite done. It takes a few more steps to associate a function with the XML help file.
Read the full article in the SAPIEN Information Center.
Writing XML Help for Advanced Functions http://t.co/ON00ObFEfb #Sapien
New stuff from the SAPIEN blog: Writing XML Help for Advanced Functions http://t.co/5eSeH2otpE
Writing XML Help for Advanced Functions http://t.co/B1oB8B1oNb #PowerShell
RT @sapientech Writing XML Help for Advanced Functions using SAPIEN #PowerShell HelpWriter http://t.co/mk7db84gYB @juneb_get_help
RT @SAPIENTech: Writing XML Help for Advanced Functions: The introduction of SAPIEN PowerShell HelpWriter has made writing XML h… http://…
Writing XML Help for Advanced Functions http://t.co/9oZOjiTE0p
RT @SAPIENTech: Writing XML Help for Advanced Functions: The introduction of SAPIEN PowerShell HelpWriter has made writing XML h… http://…
Writing XML Help For Advanced Functions http://t.co/Op0TNesrt3 #PowerShell
Writing XML help for Windows #PowerShell Advanced Functions:
https://t.co/a6ubKw14PC
RT @juneb_get_help: Writing XML help for Windows #PowerShell Advanced Functions:
https://t.co/a6ubKw14PC
@mcnabbmh XML Help for #PowerShell Functions: https://t.co/a6ubKvJtr2 @SAPIENTech https://t.co/XJFKO1UhIZ
@mcnabbmh @xvorsx To associate a #PowerShell function with its help file (3.0 naming), add an .ExternalHelp comment. https://t.co/a6ubKvJtr2
@juneb_get_help @xvorsx @SAPIENTech I did that with one function, New-OneLoginToken. Regardless, I’m testing in v5 which shouldn’t need it
@mcnabbmh @xvorsx @SAPIENTech You’re using 3.0 naming, regardless of the local OS. Read the blog post.
@mcnabbmh @xvorsx @SAPIENTech To omit the ExternalHelp comment, name help file for module; no psm1. Works only on 4.0+.
@juneb_get_help @xvorsx @SAPIENTech Hey! That worked! Not totally clear in the article as it ssys you need to match the filename. Thanks!
@mcnabbmh @xvorsx @SAPIENTech 3.0 naming matches + ExternalHelp. 4.0+ matches module name. No ExternalHelp.
@juneb_get_help @xvorsx @SAPIENTech Ok, I see now what you’re getting at. There are two paragraphs in that article that are somewhat at odds
@juneb_get_help @xvorsx @SAPIENTech https://t.co/FE4rDs3HiZ
In v5, you don’t need .ExternalHelp ONLY when the XML help file is named for the module, e.g. OneLogin-help.xml, not the source file, e.g. OneLogin.psm1-help.xml.