Advanced.Help for AutoIt and UDFs

[water]

The F1 key in SciTE displays the documentation for the word on which the cursor is located. Up to now this was only available for AutoIt.
But times change and we change with them

With the "Simple Library Docs Generator" created by MrCreatoR and customized by me, any CHM help file (Compressed HTML Help) can be created (more about this later in a separate thread). The only prerequisite: All function names have to start with the same identifier (like _AD_, _OL_ etc.).
We have already created CHM help files for the following UDFs:

• Active Directory    AD-CHM.zip
• Outlook                  OutlookEX-CHM.zip
• TaskScheduler      TaskScheduler-CHM.zip
• WebDriver             Webdriver-CHM.zip
  Preliminary release of the WebDriver help file.
  This release is for you to play with. Please tell us what you like, what is missing or just what you think about it. For download please see the top of this post.

Other CHM help files come with existing UDFs:

• WinHTTP

The integration of these help files in SciTE is now done with the tool presented here.

Advanced.Help

This tool, created by BugFix from the german forum, allows custom CHM help files to be included in SciTE.

The existing help key is used to call either the AutoIt help or the corresponding custom help. Depending on which keyword the cursor is currently on. For unknown keywords the AutoIt help is called. For AutoIt a separate window is opened and for the user-defined UDFs another window is opened, so you can work with both helps at the same time.

The ZIP file contains an installation guide in German (Install_Deutsch.txt) and English (Install_English.txt) in which the installation and configuration is described in detail.

For download please check the download forum.

Edited December 11, 2021 by water
Added Advanced.Help 1.3, moved to the download forum

[water]

Next thing to come will be the WebDriver help file

[mLipok]

So I should review, rewrite, correct, suplement each function headers, which are part of _wd_capabilities.au3 UDF, as there is still many things to do.

[water]

No need to hurry
We will release a help file that holds WD_Core, WD_Helper and WD_CDP at the moment. So people have something to play with

Edit:

  Quote

We will release a help file ... for WebDriver

Expand  

Done. Please see post #1

Edited December 7, 2021 by water

[water]

I have added the preliminary release of the WebDriver help file to post #1.

[HighlanderSword]

Works Great , Many thanks !!!!

[water]

[argumentum]

  On 11/29/2021 at 8:10 AM, water said:

CHM help files (Compressed HTML Help) can be created (more about this later in a separate thread)

Expand  

..anxiously waiting. Never got how to get that done   

Edit: I guess I'll need the "html help workshop"
The only ones I've found are from 2003 ( htmlhelp.exe and helpdocs.zip ) at web.archive.org

Edited December 8, 2021 by argumentum
added link

[water]

This will be my next project.
No additional tools are needed - it's pure AutoIt  

Edit:
Wrong - It's not pure AutoIt. hhc.exe, hha.dll, itcc.dll from "HTML Help Workshop" are needed. The installation ZIP comes with all needed files.

Edited December 9, 2021 by water
Fixed my incorrect statement

[TheDcoder]

@water Very nice tool! I was going to create something like this many years ago but never got around to finishing it (I wasn't very good at that time), it was going to be a complete UDF manager which could maintain a registry of UDFs and integrate them into AutoIt as much as possible.

Also looking forward to your documentation generator, I think my Map UDF will be a very good candidate for testing as it has a good amount of functions along with documentation

 

[mLipok]

maybe  JSMN.au3 and winhttp.au3 ?
also ADO.au3 ? and XML.au3 ?

 

[water]

As soon as I have published my version of MrCreator's tool including documentation everyone will be able to create a CHM help file for his UDfs

[TheDcoder]

  On 12/9/2021 at 9:52 AM, mLipok said:

winhttp.au3

Expand  

WinHTTP already comes with a neat CHM file in AutoIt style

[Danp2]

@TheDcoderYes, there is an existing help file for WinHTTP UDF. However, it doesn't match the style / format of the AutoIt help file.

I was actually looking at this earlier today. I wonder how different @MrCreatoR's tool is from the one in @trancexx's GH repo.

[water]

I have extracted the CSS from the AutoIt CHM. So the CHM files generated with MrCreatoR's tool should come quite close to the Autoit help file

Edited December 9, 2021 by water

[Danp2]

@waterThere still seem to be some minor differences from the AutoIt CHM. Is that intentional?

[water]

Except for the formatting of the example scripts I tried to come as close as possible to the AutoIt CHM.
If you find differences, please let me know. Maybe I can fix them

[Danp2]

@water These are the few minor differences that I noticed --

• The text in the yellow "syntax" box appears to be bold in the AI help file
• The border around the parameter entries in more defined in the AI help file

[water]

Can you please post a screenshot? I can not see any difference.

[Danp2]

Here's my version --

What OS are you running? I'm running W10 v21H2

P.S. I also just noticed that there are differences in the menu and buttons. 😉

Edited December 9, 2021 by Danp2