Implementing HelpWriter Help files

Use this forum to ask questions after your subscription maintenance expires or before you buy. Need information on licensing or pricing? Questions about a trial version? This is the right place for you. No scripting questions, please.
Forum rules
DO NOT POST SUBSCRIPTION NUMBERS, LICENSE 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.
User avatar
imdwalrus
Posts: 10
Joined: Sat Feb 04, 2012 5:11 am

Implementing HelpWriter Help files

Post by imdwalrus »

I used a trial version of HelpWriter 1.0.15 to create an xml help file for an existing module that had no comment-based help. I saved the xml file to the module folder (the folder containing the .psm1 file). After removing and reimporting that module, I still don't see the help info I just created. What do I need to do to make this work now?

User avatar
SAPIEN Support Forums
Posts: 945
Joined: Wed Dec 03, 2014 2:26 pm

Implementing HelpWriter Help files

Post by SAPIEN Support Forums »

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

Thank you for posting, imdwalrus.

Did you remember to include the following?
  • 1. Product, version and build (e.g. Product: PrimalScript 2014, Version & Build: 7.0.46. 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
imdwalrus
Posts: 10
Joined: Sat Feb 04, 2012 5:11 am

Re: Implementing HelpWriter Help files

Post by imdwalrus »

I've now added the # .ExternalHelp command, also to no effect.

User avatar
davidc
Posts: 5913
Joined: Thu Aug 18, 2011 4:56 am

Re: Implementing HelpWriter Help files

Post by davidc »

Where is it that you can't see the help?

Is this using Get-Help in the console or the help in PowerShell Studio or PrimalScript?

Also verify that the naming convention is correct. For example:

modulename.psm1-help.xml


David
David
SAPIEN Technologies, Inc.

User avatar
imdwalrus
Posts: 10
Joined: Sat Feb 04, 2012 5:11 am

Re: Implementing HelpWriter Help files

Post by imdwalrus »

Hi David,

I wasn't seeing any help from the Get-Help command in the console. I finally solved the problem by creating a en-US folder within the module folder and dropping the xml file into it.

Regards,

Mike

User avatar
juneblender
Posts: 93
Joined: Thu Jul 24, 2014 3:26 pm

Re: Implementing HelpWriter Help files

Post by juneblender »

Hi, Mike. You solved it. If you're stuck again, try this blog post. I'll add it to the HelpWriter help.

Writing XML Help for Advanced Functions

(https://www.sapien.com/blog/2015/04/01/ ... functions/)