Posts Tagged ‘Help’


HelpUri v. HelpInfoUri

Tuesday, August 16th, 2016 by June Blender
Although the names are similar and often confused, these properties are different. If you confuse them, the help for your PowerShell commands and modules won't work. The HelpUri property stores the URL (http or https) of online help for a command. It's a property of commands (cmdlets, functions, workflows). When a user runs Get-Help -Online, Get-Help opens the default browser to the HelpUri property value. The HelpInfoUri property of modules stores the URL of the online location of the HelpInfo XML file that enables updatable help for the module. In fact, a non-null value of HelpInfoUri indicates that the module…   More »

Writing Help for Dynamic Parameters

Monday, August 8th, 2016 by June Blender
Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has the dynamic parameters. This makes sense in theory, but, in practice, it's not discoverable and it's very confusing for users. To write help for the dynamic parameters that you add to cmdlets and functions, you need to sneak it into the description. I'll show you…   More »

PowerShell HelpWriter – Service Release v1.0.16

Monday, November 2nd, 2015 by David Corrales
In the latest service release of PowerShell HelpWriter 2015, you will notice a few changes to the Select Module dialog that appears when creating a new help file. The updated dialog includes several new features.   Sorting Modules The module list can now be sorted by clicking on the respective column headers. In addition, we now added a new column that displays the module’s company information.     Filtering Modules   Tired of scrolling down a long list of modules? No more. You now can filter the modules by company using the new drop down list: Choose to display all…   More »

Advanced Help for Advanced Functions – #PSBlogWeek

Friday, April 3rd, 2015 by June Blender
Follow @juneb_get_help Writing help is often the last thing you do for an advanced function. But, instead of treating it as a disposable chore, write your help first -- in advance -- before you write your advanced function. Then, use the help as a design specification. The result is a better designed function and a better user experience. If you're using a test framework, like Pester, you can also use your help examples as test cases. In this post, I'll write help for the New-ValidationDynamicParam function that Adam Bertram (@adbertram) shares in #PSBloggingWeek – Dynamic Parameters and Parameter Validation. But…   More »

PowerShell Help Community Edition updated

Thursday, January 16th, 2014 by Alex Riedel
One of our most popular community tools received a long awaited update. All the content was brought up to speed and now contains the latest help text from Windows Server 2012 and PowerShell 4.0. Here is a reminder why this tool is a must-have in every PowerShell users toolbox: Easier reading and scrolling through help content than in a console. Ability to query and import help for modules not on your machine. You can attach notes to topics, so if you had your “EUREKA” moment you don’t have to rediscover it the next time you use that cmdlet. About files,…   More »

Get help for modules on other machines

Wednesday, October 10th, 2012 by Alex Riedel
When you develop scripts for other computers you don’t always have the luxury of installing the relevant modules on your own computer. In many cases they simply won’t install because you are running the wrong OS or don’t have some required server software running. Luckily the context sensitive help in PrimalScript or PowerShell Studio doesn’t rely on the actual module being installed like PowerShell’s Get-Help does. In this post we will show you how to export a help file from your target machine and add it to the SAPIEN Document Explorer locally. As an example we will use the Microsoft.WSMan.Management…   More »

PrimalForms 2011: Getting Form Control Help

Monday, April 9th, 2012 by David Corrales
Frequently users wonder how they can get help for form controls and discover all the properties, methods and events they can use. In this article we will cover a number of ways to access information about Form controls. Spotlight on Control Articles: You can find help of the Form controls right here on our blog. The Spotlight on Controls series covers individual Form Control and list the important properties and methods as well as code samples written in PowerShell. MSDN Library: The primary resource for .NET help is the Microsoft Developer Network (MSDN) Library. The MSDN is an invaluable resource…   More »

Feature Peek 2011: Can I get some help here?

Friday, November 5th, 2010 by Alex Riedel
One of the most important things for any type of development is quick and efficient access to help information. No matter whether you are a seasoned developer or just started to write scripts longer than five lines, at some point you will need help.Maybe you just need a reminder about what the parameters of a function are for or you need a detailed sample of how to use this newfangled cmdlet to produce meaningful output. PrimalScript had built-in context sensitive help for generations and PrimalForms equally had its built-in access to PowerShell help, but these took screen real estate away…   More »

Powershell Help 2.0 Community Edition

Monday, November 16th, 2009 by Alex Riedel
Our Powershell Help tool has been a favorite download for quite some time now. The built-in help command in the Powershell console is helpful if you need just some quick lookup, but for browsing and reading the console just isn't good enough. The CHM file Microsoft released is a pretty nice graphical way of getting help for the built-in cmdlets but it's a closed file and information for third party or even other Microsoft snapins is not available and cannot be added. Cmdlets organized by popular verbs This new version of our popular Powershell help tool allows importing any xml…   More »

PrimalForms 2009: Integrated Help

Thursday, October 1st, 2009 by David Corrales
PrimalForms 2009 features integrated help to assist users with their form scripting. This blog covers some of its features. Help Documentation: (Fig 1: Click on the Help button or press F1 key to access the help documentation.) PrimalForms allows users to access help on any panel or window simply by pressing the F1 key. Depending on the active window, help will take the user to the corresponding Help topic. For example, if a user would like more information on the Assemblies Panel, the user simply have to click on the Assemblies Panel and press the F1 key. The Help document…   More »