Vista Tutorial - adding ABOUT_ help

i know how to add the maml help files to my snapins etc, but i don't
know how to add the plain text about_ help files other than copying
them into the relevant powershell directory directly..

is there any other way to register these help files so that powershell
and get-help sees them?

On 27 Jan 2007 23:47:22 -0800, klumsy@xtra.co.nz wrote:

>i know how to add the maml help files to my snapins etc, but i don't
>know how to add the plain text about_ help files other than copying
>them into the relevant powershell directory directly..
>
>is there any other way to register these help files so that powershell
>and get-help sees them?

Hi,

Take a look in C:\WINDOWS\system32\windowspowershell\v1.0. You'll see
lots of the text files which underly about_something Help.

Just save a text file with the correct extension.

Andrew Watt MVP
Author Professional Windows PowerShell (Wrox)

Hi Klumsy,

about_help topics are handled much the same way as the maml help files. The
following blog will help you understand how the maml help file is loaded:

http://blogs.msdn.com/powershell/arc...25/583247.aspx

When help engine tries to load help file for a cmdlet, the help engine looks
for the help file relative to MshSnapIn "ApplicationBase" directory.
Remember this ApplicationBase is added to the registry during MshSnapIn
installation phase.

If you place your about help topic in your SnapIn's Application base
directory, then it will be searched and loaded if found.

--
Thanks
Krishna[MSFT]
Windows PowerShell Team
Microsoft Corporation
This posting is provided "AS IS" with no warranties, and confers no rights.


"Andrew Watt [MVP]" <SVGDeveloper@aol.com> wrote in message
news:q5tor2ppm3ifviea5vdud5nt86b0clk8v1@4ax.com...
> On 27 Jan 2007 23:47:22 -0800, klumsy@xtra.co.nz wrote:
>
>>i know how to add the maml help files to my snapins etc, but i don't
>>know how to add the plain text about_ help files other than copying
>>them into the relevant powershell directory directly..
>>
>>is there any other way to register these help files so that powershell
>>and get-help sees them?
>
> Hi,
>
> Take a look in C:\WINDOWS\system32\windowspowershell\v1.0. You'll see
> lots of the text files which underly about_something Help.
>
> Just save a text file with the correct extension.
>
> Andrew Watt MVP
> Author Professional Windows PowerShell (Wrox)

in my case i'm writing the host, and not loading a snapin, my cmdlets
are not in a snapin ,but added to the runspace configuration
dynamically..

i just want to somehow publish my about_ help files without having to
copy them into MS's directory

You can put them in any SNAPIN directory.
For instance PSCX is installed in C:\Program Files\PowerShell Community
Extensions
and there is a file there: about_pscx.help.txt
which you can get by typing: Help about_pscx

--
Jeffrey Snover [MSFT]
Windows PowerShell Architect
Microsoft Corporation
This posting is provided "AS IS" with no warranties, no confers rights.
Visit the Windows PowerShell Team blog at:
http://blogs.msdn.com/PowerShell
Visit the Windows PowerShell ScriptCenter at:
http://www.microsoft.com/technet/scr.../hubs/msh.mspx