Help file for the AD UDF - similar to the AutoIt help file

[water]

Due to corona I have a  lot of spare time at the moment. So I started to create a "real" help file fo the AD UDF (MS Active Directory).
This help file should look/work like the AutoIt help file.

Attached you find the first beta of the AD help file.

 

Done so far:

• Similar functions have been assigned to a group (example: mail, mailbox and Exchange related functions have been assigned to the "EMail" group)
• Content, Search and Index tabs work
• Formatting is similar to the AutoIt help file
• Introduction page

ToDo:

• Fill index tab
• Use folder icons
• Set the correct font size for the TOC
• Enhance the CSS to fully match the formatting of the AutoIt help file
• Create a documentation so you can create CHM files for other homegrown UDFs
• Create pages for the chapters - return an error message at the moment
• Upgrade to the latest version of Microsoft HTML Workshop Seems 1.3 is the latest

What do you think?
Is something still missing on the ToDo-list?

Comments please

AD.chm

Edited March 31, 2020 by water
Modified font and font size of the TOC

[Gianni]

Hi water, good idea,
downloaded the file, I can see the tree on the left panel, but no content is shown on the right panel,
only a message for any  leaf of the tree saying something like "can't show the page"

Edited March 30, 2020 by Chimp

[water]

Copy the CHM file to a local drive and try again - that's a Windows security restriction.

[Gianni]

placed the AD.chm file in c:\temp, got same issue.
the downloaded AD.chm file is (only) 151 Kb is that ok?

[seadoggie01]

Same issue here. Placed into downloads folder and even unblocked the file from the properties

[water]

I downloaded the file to the local download directory, unblocked the file and then double clicked it.
I get an error message (in the left pane "Function Reference" is selected) - that's expected because the page für the topic has not yet been created.
Then I expand "Function Reference" and "General". When I select "_AD_Close" I get the help for function _AD_Close on the right pane.

How far do you get?

[Jos]

@water

There is a hard reference in de pages to drive H:  eg: res://ieframe.dll/dnserrordiagoff.htm#file:///H:/tools/AutoIt3/AD/Txt2htm/Web/html/libfunctions/_AD_Close.htm

This needs to be relative!

Jos

[water]

I see. I use Precision Helper to create the CHM file.
Will have to check how to create a selfcontained CHM file.

[water]

Absolute path bug has been fixed.
Please find the latest CHM file in the OP.

[Jos]

Function pages work fine now but the default page still gives an error Page not found:

AD.chm::/StartingPage.htm

Jos

[water]

Fixed a minute ago

[Jos]

Nice  

[water]

@Jos
I assume there is no easy way to create html pages using the same formatting as for the AutoIt help pages?
I use "BuildTemplates" and "Txt2Htm" (don't ask me where I got them from ) but even with the CSS as used in the AutoIt help file the formatting looks different.

[Jos]

So you have part of the buildprocess scripts but am missing some to build the actual helpfile?

[water]

I use very, very old versions of this tools. I noticed that the generated html source is quite different compared to the html source of the AutoIt help file.
I had a look at the build code in the SVN repository but left very, very confused 😜
At the moment I think I'll have to create a tool to convert the txt files to html myself.

Edited March 30, 2020 by water