Home Dashboard Directory Help
Search

Allow users to set one help file for an entire module by Shay Levi


Status: 

Closed
 as Fixed Help for as Fixed


20
9
Sign in
to vote
Type: Suggestion
ID: 668002
Opened: 5/11/2011 12:00:34 PM
Access Restriction: Public
1
Workaround(s)
view

Description

Say you have a module with a lot of functions in it and you use external XML file to document the functions. We need to add the following to each function:

<#
.ExternalHelp <PathToXmlFile>
#>


How about a new keyword in the module's psd1 file (e.g ExternalHelp) that would associate the external help file with the module?
Details
Sign in to post a comment.
Posted by MediaAndMicrocode on 5/11/2011 at 1:03 PM
I think this is a good core idea but has devils in too many details:

- Does this help override function help, if it's there?
- Does this mean that every module has to have all of its help in one MAML? What if there's nesting involved?
- Would this make PowerShell stop looking for function help?
- What would be the localization path for this (module manifest files aren't localized)?
- How would this different from existing localization fallbacks (i.e. looking for about topics in en-us).
Sign in to post a workaround.
Posted by namy1403 on 2/15/2014 at 6:55 PM
good......................................