Windows Vista Forums
Vista Forums Home Join Vista Forums Windows 7 Forum Vista Tutorials Tags
Welcome to Windows Vista Forums. Our forum is dedicated to helping you find solutions with any problems, errors or issues you are experiencing with Windows Vista. The Vista forum also covers news and updates and has an extensive Windows Vista tutorial section that covers a wide range of tips and tricks.

Go Back   Vista Forums > Misc Newsgroups > PowerShell

Vista - Creating cmdlet help

Reply
 
Old 01-23-2007   #1 (permalink)
Jeffery Hicks


 
 

Creating cmdlet help

I've started developing cmdlets and the associated help file. The cmdlet
help file is in a specific XML format. Manually creating these XML help
files is one of the most mind-numbing tasks I've ever done. Does anyone
know of a faster or easier way to do this? The cmdlet can have parameter
information and help text. Is there a way to pull that information from the
cmdlet to help build the help file? I'm especially curious how the MS
PowerShell team generated their help file. I can't believe someone sat down
and manually typed up the XML.

--
Jeffery Hicks
SAPIEN Technologies - Scripting, Simplified. www.SAPIEN.com
VBScript & Windows PowerShell Training -
www.ScriptingTraining.com/classes.asp
Windows PowerShell? - www.SAPIENPress.com/powershell.asp

blog: http://blog.SAPIEN.com
blog: http://jdhitsolutions.blogspot.com

My System SpecsSystem Spec
Old 01-25-2007   #2 (permalink)
RichS


 
 

RE: Creating cmdlet help

Look at Get-cmdletMaml from the Powerhell Community Extensions it will create
the framework for your help file and extract what it can from the cmdlet to
start populating the help file. Its good.
--
Richard Siddaway

Please note that all scripts are supplied "as is" and with no warranty


"Jeffery Hicks" <"jhicks[at]SAPIEN.com" wrote:

> I've started developing cmdlets and the associated help file. The cmdlet
> help file is in a specific XML format. Manually creating these XML help
> files is one of the most mind-numbing tasks I've ever done. Does anyone
> know of a faster or easier way to do this? The cmdlet can have parameter
> information and help text. Is there a way to pull that information from the
> cmdlet to help build the help file? I'm especially curious how the MS
> PowerShell team generated their help file. I can't believe someone sat down
> and manually typed up the XML.
>
> --
> Jeffery Hicks
> SAPIEN Technologies - Scripting, Simplified. www.SAPIEN.com
> VBScript & Windows PowerShell Training -
> www.ScriptingTraining.com/classes.asp
> Windows PowerShell? - www.SAPIENPress.com/powershell.asp
>
> blog: http://blog.SAPIEN.com
> blog: http://jdhitsolutions.blogspot.com
>

My System SpecsSystem Spec
Old 01-25-2007   #3 (permalink)
Jeffery Hicks


 
 

Re: Creating cmdlet help

On Thu, 25 Jan 2007 02:12:01 -0800, RichS wrote:

> Look at Get-cmdletMaml from the Powerhell Community Extensions it will create
> the framework for your help file and extract what it can from the cmdlet to
> start populating the help file. Its good.


Thanks. I'm running the extensions but missed this cmdlet.

--
Jeffery Hicks
SAPIEN Technologies - Scripting, Simplified. www.SAPIEN.com
VBScript & Windows PowerShell Training -
www.ScriptingTraining.com/classes.asp
Windows PowerShell? - www.SAPIENPress.com/powershell.asp

blog: http://blog.SAPIEN.com
blog: http://jdhitsolutions.blogspot.com
My System SpecsSystem Spec
Reply

Thread Tools


Similar Threads
Thread Forum
Quest AD cmdlet -what is the cmdlet to remove computer object PowerShell
Invoking Cmdlet Get-Location from cmdlet,cant get Currnt Directory PowerShell
Creating a cmdlet using csc.exe - missing namespaces PowerShell
Whether a cmdlet derives from cmdlet or pscmdlet PowerShell
Creating new functions using new-item cmdlet PowerShell


Vista Forums is an independent web site and has not been authorized,
sponsored, or otherwise approved by Microsoft Corporation.
"Windows Vista", the Start Orb, and related materials are trademarks of Microsoft Corp.
© Designer Media Ltd

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46