Custom Module Help Text

This forum can be browsed by the general public. Posting is limited to current SAPIEN license holders with active maintenance and does not offer a response time guarantee.
Forum rules
DO NOT POST LICENSE NUMBERS, ACTIVATION KEYS OR ANY OTHER LICENSING INFORMATION IN THIS FORUM.
Only the original author and our tech personnel can reply to a topic that is created in this forum. If you find a topic that relates to an issue you are having, please create a new topic and reference the other in your post.

Any code longer than three lines should be added as code using the 'Select Code' dropdown menu or attached as a file.
This topic is 9 years and 2 months old and has exceeded the time allowed for comments. Please begin a new topic or use the search feature to find a similar but newer topic.
User avatar
nsepulveda
Posts: 2
Last visit: Mon Jun 27, 2016 7:16 am

Custom Module Help Text

Post by nsepulveda »

Hi,

I have downloaded the NTFSSecurity module and placed it inside of my C:\Windows\System32\WindowsPowerShell\v1.0\Modules path such that it loads automatically into PowerShell Studio and in the object browser.

My problem is that the help menu is not available within PowerShell Studio. There is help text for these cmdlets but when I click on the cmdlet in the object browser the help panel remains blank.

Image

Anyone have any idea how I can correct this?
User avatar
SAPIEN Support Forums
Posts: 945
Last visit: Thu Oct 22, 2015 1:10 pm

Custom Module Help Text

Post by SAPIEN Support Forums »

This is an automated post. A real person will respond soon.

Thank you for posting, nsepulveda.

Did you remember to include the following?
  • 1. Product, version and build (e.g. Product: PowerShell Studio 2014, Version & Build: 4.1.71. Version and build information can be found in the product's About box accessed by clicking the blue icon with the 'i' in the upper right hand corner of the ribbon.)
    2. Specify if you are running a 32 or 64 bit version
    3. Specify your operating system and if it is 32 or 64 bit.
    4. Attach a screenshot if your issue can be seen on the screen
    5. Attach a zip file if you have multiple files (crash reports, log entries, etc.) related to your issue.
If not, please take a moment to edit your original post or reply to this one.

*** Make sure you do not post any licensing information ***
User avatar
davidc
Posts: 5913
Last visit: Mon Jul 08, 2019 8:55 am
Been upvoted: 2 times

Re: Custom Module Help Text

Post by davidc »

If the module contains a help XML file, you can import it using the SAPIEN Document Explorer. Once imported the help should display.

Please refer to the following article:

http://www.sapien.com/blog/2012/10/10/g ... -machines/

David
David
SAPIEN Technologies, Inc.
User avatar
nsepulveda
Posts: 2
Last visit: Mon Jun 27, 2016 7:16 am

Re: Custom Module Help Text

Post by nsepulveda »

Thanks. I understand what you're saying.

I am trying this procedure now with the Quest ActiveRoles snapin but when I import the help file the document explorer is telling me that parsing failed.

I've attached the xml. Is that the correct one?
Attachments
Quest.ActiveRoles.ArsPowerShellSnapIn.dll-Help.zip
(284.3 KiB) Downloaded 122 times
This topic is 9 years and 2 months old and has exceeded the time allowed for comments. Please begin a new topic or use the search feature to find a similar but newer topic.