Active Directory UDF - create CHM help file

[water]

Currently the Active Directory UDF comes with two different types of help files:

• <functionname>.htm (example: _AD_Open.htm): HTML file for each function of the UDF.
• AD.htm: Single HTML file generated by HTMHelp for all functions of the UDF.

With the help of MrCreator's "Simple Library Docs Generator" I was able to create a CHM file. This looks like the CHM help file provided with AutoIt.
You still can't use this help file from SciTE but at least you get

• the same look and feel as the AutoIt help file
• ability to search the full help file

With the next release of the AD UDF I plan to replace all current help files with the new CHM help file.
Edit: Done. Please download the AD UDF version 1.6.0.0 or newer to get the latest CHM help file (for download please have a look at my signature below).

Could you please have a look at the attached CHM help file and tell me what you think?

 

 

Edited November 27, 2021 by water
The content tab now groups the functions

[Subz]

Needed to unblock the file before using it, copying the examples isn't working correctly, either manually or using the "Copy to Clipboard" button, it doesn't include any of the new line characters for _AD_HasFullRights example:

#AutoIt3Wrapper_AU3Check_Parameters= -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6#AutoIt3Wrapper_AU3Check_Stop_OnWarning=Y; *****************************************************************************; Example 1; Get a list of groups the current user is a member of. Then check for the; first group in the array if the current user has full rights for the group.; *****************************************************************************#include <AD.au3>; Open Connection to the Active Directory_AD_Open()If @error Then Exit MsgBox(16, "Active Directory Example Skript", "Function _AD_Open encountered a problem. @error = " & @error & ", @extended = " & @extended); Get a list of groups the current user is a member ofGlobal $aMemberOf = _AD_GetUserGroups(); Check if the current user has full rights on the first group in the arrayGlobal $sUser = @UserNameIf _AD_HasFullRights($aMemberOf[1], $sUser) Then  MsgBox(64, "Active Directory Functions", "User '" & $sUser & "' has full rights on group '" & $aMemberOf[1] & "'")Else  MsgBox(64, "Active Directory Functions", "User '" & $sUser & "' does not have full rights on group '" & $aMemberOf[1] & "'")EndIf; Close Connection to the Active Directory_AD_Close()

 

[Musashi]

12 hours ago, water said:

Could you please have a look at the attached CHM help file and tell me what you think?

Confirmation only (System : Windows 7 SP1, 64 Bit :

As already mentioned by @Subz :

One has to remove the zone information from saved file attachments by clicking Unblock on the file’s Properties tab or by clicking to select a check box in the Security Warning dialog box ( information-about-the-attachment-manager ).

5 hours ago, Subz said:

either manually or using the "Copy to Clipboard" button, it doesn't include any of the new line characters for _AD_HasFullRights example:

This applies to ALL function examples.

[Gianni]

I can see the full list of function on the left panel, but when i click or doubleclick on each of them the right panel shows nothing and remains white.

[water]

I had the same problem when running from a network drive.
It was caused by a security setting. As soon as I copied the file to a local drive it worked without problem.
Can you please test and post the result?

[water]

Unblocking the file will be no longer needed when the CHM file is part of the full AD UDF package (ZIP-file).

[Musashi]

 

1 hour ago, water said:

Unblocking the file will be no longer needed when the CHM file is part of the full AD UDF package (ZIP-file).

BTW, for those interested in "Alternate Data Streams" in general or "Zone.Identifier" in particular, there is a nice tool :

alternate-data-streams-viewer created by @trancexx

( @water : Apologies for going a little off topic )

EDIT : A file loses its Zone.Identifier when it gets zipped.

Edited November 4, 2021 by Musashi

[water]

The "Copy to Clipboard" problem is solved when the Examples get formatted.

[Musashi]

15 minutes ago, water said:

The "Copy to Clipboard" problem is solved when the Examples get formatted.

Confirmed 👍 Both "Copy to Clipboard" and copying via CTRL-C/-V work.

[water]

Next step will be to modify the CSS to make the CHM look like AutoIt's CHM

[Gianni]

10 hours ago, water said:

I had the same problem when running from a network drive.
It was caused by a security setting. As soon as I copied the file to a local drive it worked without problem.
Can you please test and post the result?

The file is already saved on local HD, the problem was, as already said by Subz and Musashi, having to remove the check from the option "always warn before opening this file" from the security warning window that appears when opening a file downloaded from the web. Removing that check and then opening the file, then the content of the right panel is displayed correctly. Sorry

[Subz]

@water - you probably already know this, but you can use 7-Zip to unpack the .chm files to access the css file..

[Zedna]

CHM decompile can be achieved by hh.exe (-decompile commandline parameter) which is standard Windows' component.

So you don't need any external application for this. 

[water]

Thanks Subsz and Zedna.
I found the HH way this evening and will play with it during the weekend. Hopefully I (and you) will be satisfied with the result

[water]

On 11/4/2021 at 4:26 PM, water said:

Next step will be to modify the CSS to make the CHM look like AutoIt's CHM

Done!

I have posted the latest version of the CHM file in post #1.
Any comments?

In the next step I will update the Example code box. Should then work like in the AutoIt help file.

[Subz]

Excellent work Water, like how the links to internal functions point back at the AutoIt online help.

[water]

This work is entirely based on tools created by MrCreatoR:

• Simple Library Docs Generator
• AutoIt Syntax Highlight

I simply modified some CSS definitions to make the result look like the original AutoIt CHM.
Therefore all the praise goes to MrCreator

[Gianni]

12 hours ago, water said:

I have posted the latest version of the CHM file in post #1.
Any comments?

good job!

12 hours ago, water said:

In the next step I will update the Example code box. Should then work like in the AutoIt help file.

it would be even better

24 minutes ago, water said:

This work is entirely based on tools created by MrCreatoR:

• Simple Library Docs Generator
• AutoIt Syntax Highlight

could you add the link to the "Simple Library Docs Generator" topic as well please?
Thanks

[water]

I will.
As soon as I can remember where I downloaded the tool from 🤔

[water]

21 hours ago, water said:

In the next step I will update the Example code box. Should then work like in the AutoIt help file.

Done!

I have posted the latest version of the CHM file in post #1.
Please unpack the ZIP file and the AD CHM file should work like the AutoIt help file
"Open this Script" and "Copy to Clipboard have been added.

Any comments?