[Semi-SOLVED] **Topical** API Help on API Keyword using F1 help key

Got an idea for enhancing PureBasic? New command(s) you'd like to see?
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

[Semi-SOLVED] **Topical** API Help on API Keyword using F1 help key

Post by Randy Walker »

The topical help we get when pressing F1 key while the cursor is resting on a PB keyword in the IDE is such an enabling feature -- Its just Brilliant!
It would be equally fantastic to have the same ability to get help on Windows API keywords. The main reason I'm still stuck on the JaPBe alternative IDE, although it does have a few other features I really like a lot too.

PS: Added the word **Topical** to the topic line to emphsize this request is for "topical help built-into the IDE" and not a request for some add-on workaround.

Marked [Semi-SOLVED] Because BarryG provided a feasible workaround solution, however the "Help folder" itself is missing in the default installation of PureBasic, AND it is missing the Win32.hlp file which makes it all happen as needed.
Last edited by Randy Walker on Mon Jun 16, 2025 12:41 am, edited 2 times in total.
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
User avatar
Caronte3D
Addict
Addict
Posts: 1355
Joined: Fri Jan 22, 2016 5:33 pm
Location: Some Universe

Re: API Help on API Keyword using F1 help key

Post by Caronte3D »

AZJIO
Addict
Addict
Posts: 2141
Joined: Sun May 14, 2017 1:48 am

Re: API Help on API Keyword using F1 help key

Post by AZJIO »

BarryG
Addict
Addict
Posts: 4122
Joined: Thu Apr 18, 2019 8:17 am

Re: API Help on API Keyword using F1 help key

Post by BarryG »

The IDE already supports this. Just put "Win32.hlp" in the "Help" folder and pressing F1 on an API command will open it in that doc. ;)
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

Caronte3D wrote: Sun Jun 15, 2025 6:31 pm Take a look:
viewtopic.php?t=87093
Thanks Caronte3D, but that doesn't work at all. I'm asking for "topical help" on API keywords that actually looks at the cursor position and gives 'topical" help on that specific keyword same as we get now if the cursor is resting on a PB keyword and we press F1.
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

BarryG wrote: Sun Jun 15, 2025 10:10 pm The IDE already supports this. Just put "Win32.hlp" in the "Help" folder and pressing F1 on an API command will open it in that doc. ;)
Hi BarryG: Tried that but it's not working. At least not working in 5.40 or 6.20 PB release.
Last edited by Randy Walker on Mon Jun 16, 2025 12:02 am, edited 1 time in total.
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

AZJIO wrote: Sun Jun 15, 2025 7:21 pm viewtopic.php?t=81335
video how it works
Hi AZJIO and thanks for the post, but I'm unable to read between the lines well enough to figure out what all that means -- It is not topical API help "built-into" the PB IDE which was my original request.
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

Randy Walker wrote: Sun Jun 15, 2025 11:59 pm
BarryG wrote: Sun Jun 15, 2025 10:10 pm The IDE already supports this. Just put "Win32.hlp" in the "Help" folder and pressing F1 on an API command will open it in that doc. ;)
Hi BarryG: Tried that but it's not working. At least not working in 5.40 or 6.20 PB release.
OH WOW!! BarryG. You did say "in the Help folder". Duhh, I just put it into the main PureBasic folder. Then I read your post again and saw that you said put it "in the Help folder", UH!! but there was no Help folder -- I created the folder, moved the Win32.hlp file into the Help folder and VIOLA!!, It works!! Also worked with 5.62 and 6,20 installations. This is fantastic!
THANKS AGAIN!!! BarryG. WOW!
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
AZJIO
Addict
Addict
Posts: 2141
Joined: Sun May 14, 2017 1:48 am

Re: API Help on API Keyword using F1 help key

Post by AZJIO »

Randy Walker wrote: Mon Jun 16, 2025 12:12 am what all that means
If you have a help file in CHM format, then you can assign the Alt+F1 hotkey to launch the tool, which will open the help file and paste the selected word into the search field.
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

AZJIO wrote: Mon Jun 16, 2025 12:37 am
Randy Walker wrote: Mon Jun 16, 2025 12:12 am what all that means
If you have a help file in CHM format, then you can assign the Alt+F1 hotkey to launch the tool, which will open the help file and paste the selected word into the search field.
Sorry AZJIO, but that is a very lame workaround. Look up above for the practical workaround solution provided by BarryG. It does exactly what I was asking for - no copy/paste BS.
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
AZJIO
Addict
Addict
Posts: 2141
Joined: Sun May 14, 2017 1:48 am

Re: API Help on API Keyword using F1 help key

Post by AZJIO »

Randy Walker wrote: Mon Jun 16, 2025 12:46 am Sorry AZJIO, but that is a very lame workaround. Look up above for the practical workaround solution provided by BarryG. It does exactly what I was asking for - no copy/paste BS.
If it worked for you, that's fine with me, you don't have to contrast the possibilities as one good and one bad. It's not like I can guess that someone will suggest a better solution for you. If my help aggravates you, I may not offer you my options for solutions, I have no problem with that.
Randy Walker wrote: Mon Jun 16, 2025 12:46 am no copy/paste BS.
my tool copies and pastes on its own, and even presses Enter.
Watch the video how it works, it just opens the desired section and that's it, where did you see copy and paste there?
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

AZJIO wrote: Mon Jun 16, 2025 12:58 am
Randy Walker wrote: Mon Jun 16, 2025 12:46 am Sorry AZJIO, but that is a very lame workaround. Look up above for the practical workaround solution provided by BarryG. It does exactly what I was asking for - no copy/paste BS.
If it worked for you, that's fine with me, you don't have to contrast the possibilities as one good and one bad. It's not like I can guess that someone will suggest a better solution for you. If my help aggravates you, I may not offer you my options for solutions, I have no problem with that.
Not like that at all. I thought this was a forum for suggestions and requests. I was not asking for assistance or workarounds. Little did i know the feature was already built-in, but just lacking the critical components - the Win32.hlp file and the Help folder itself. These deficiencies have made it impossible in the past for me to transition onto the native PB IDE -- hence the "request".
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
AZJIO
Addict
Addict
Posts: 2141
Joined: Sun May 14, 2017 1:48 am

Re: API Help on API Keyword using F1 help key

Post by AZJIO »

Randy Walker wrote: Mon Jun 16, 2025 1:18 am I was not asking for assistance or workarounds
1. Why do you consider it a workaround? This is a common path when you write a program that performs complex actions for you. I don't think it's a workaround.
2. I wanted to try Win32.hlp, but the system says you need to install updates, as WinHlp32.exe is bundled for Win8.1 only. We've had updates banned for a couple years, and yes updates were throwing off the system settings, I had to disable them, and then the system writes that the update resource is not running, so it can't install the package, which means now I can't even check if the file works.
3. I found an analog of this file WIN32.CHM, I don't see anything outstanding there that I couldn't find on the official WinAPI site.
4. The white style is used, and I have a "Dark Reader" plugin in my browser, so even to use WIN32.CHM, I will have to repackage it to change the style to black. The "workaround" here is the right way, and the normal way is unnecessary.
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

AZJIO wrote: Mon Jun 16, 2025 1:42 am
Randy Walker wrote: Mon Jun 16, 2025 1:18 am I was not asking for assistance or workarounds
1. Why do you consider it a workaround? This is a common path when you write a program that performs complex actions for you. I don't think it's a workaround.
Is it built-into the IDE? I don't think so, and so to provide the same net result it is by definition a workaround.
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
Randy Walker
Addict
Addict
Posts: 989
Joined: Sun Jul 25, 2004 4:21 pm
Location: USoA

Re: API Help on API Keyword using F1 help key

Post by Randy Walker »

AZJIO wrote: Mon Jun 16, 2025 1:42 am
Randy Walker wrote: Mon Jun 16, 2025 1:18 am I was not asking for assistance or workarounds
2. I wanted to try Win32.hlp, but the system says you need to install updates, as WinHlp32.exe is bundled for Win8.1 only. We've had updates banned for a couple years, and yes updates were throwing off the system settings, I had to disable them, and then the system writes that the update resource is not running, so it can't install the package, which means now I can't even check if the file works.
If you can't find it and would like a working copy of the win32.hlp file compatible on Win 11 and various releases of pureBasic for Windows, I'm sure there is a way I could upload it somewhere for you to grab it.
- - - - - - - - - - - - - - - -
Randy
I *never* claimed to be a programmer.
Post Reply