Jump to content

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


Recommended Posts

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.

663771605_Helpfile.thumb.png.49be5a9c73057c85efdf5e976dfbd96d.png

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 by water
Modified font and font size of the TOC

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites

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 by Chimp

 

image.jpeg.9f1a974c98e9f77d824b358729b089b0.jpeg Chimp

small minds discuss people average minds discuss events great minds discuss ideas.... and use AutoIt....

Link to post
Share on other sites

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

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites

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

All my code provided is Public Domain... but it may not work. ;) Use it, change it, break it, whatever you want.

Spoiler

My Humble Contributions:
Personal Function Documentation - A personal HelpFile for your functions
Acro.au3 UDF - Automating Acrobat Pro
ToDo Finder - Find #ToDo: lines in your scripts
UI-SimpleWrappers UDF - Use UI Automation more Simply-er
KeePass UDF - Automate KeePass, a password manager

Link to post
Share on other sites

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?

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites
  • Developers

@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

SciTE4AutoIt3 Full installer Download page   - Beta files       Read before posting     How to post scriptsource   Forum etiquette  Forum Rules 
 
Live for the present,
Dream of the future,
Learn from the past.
  :)

Link to post
Share on other sites

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

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites

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

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites
  • Developers

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

AD.chm::/StartingPage.htm

Jos

SciTE4AutoIt3 Full installer Download page   - Beta files       Read before posting     How to post scriptsource   Forum etiquette  Forum Rules 
 
Live for the present,
Dream of the future,
Learn from the past.
  :)

Link to post
Share on other sites

Fixed a minute ago ;)

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites

@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.

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites

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.

BuildTemplates.png.bb5a0293cddd128670d6c239da2f3d9a.pngTxt2htm.png.16836e6d50e914e1ccc691d056d37b2f.png

Edited by water

My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2022-02-19 - Version 1.6.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2017-07-21 - Version 0.4.0.1) - Download - General Help & Support - Example Scripts
OutlookEX (2021-11-16 - Version 1.7.0.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX_GUI (2021-04-13 - Version 1.4.0.0) - Download
Outlook Tools (2019-07-22 - Version 0.6.0.0) - Download - General Help & Support - Wiki
PowerPoint (2021-08-31 - Version 1.5.0.0) - Download - General Help & Support - Example Scripts - Wiki
Task Scheduler (2019-12-03 - Version 1.5.1.0) - Download - General Help & Support - Wiki

Standard UDFs:
Excel - Example Scripts - Wiki
Word - Wiki

Tutorials:
ADO - Wiki
WebDriver - Wiki

 

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By water
      ATTENTION! THIS IS STILL WORK IN PROGRESS!
      This is the modified version of MrCreatoR's "Simple Library Docs Generator".
      It allows to create CHM help files that look like the AutoIt help file.
      In additon this CHM files can then be used with Advanced.Help.
      This a very early alpha version - so it is miles away from being perfect. It's just something for you to play with.
      The documentation is in the making and will be published as soon as possible.
       
      BTW: If you like this UDF please click the "I like this" button. This tells me where to next put my development effort
    • By 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.
    • By seadoggie01
      I went to go edit my Au3Check parameters today, opened the SciTE4AutoIt3 helpfile to review the options, and could only find this:
      #AutoIt3Wrapper_Au3Check_Parameters= ;Au3Check parameters...see SciTE4AutoIt3 Helpfile for options Am I missing them elsewhere in the helpfile, or is this a circular reference?  (My helpfile was last updated in the history on 23-3-2021)
    • By DagSa
      Try to find a solution for help files to my autoit executable.
      Its installed from simple XP-POS cash computers to desktop with windows 7, 8, 10.
      The compiled AutoIt program itself work everywhere, but the help file??
      I need a help file called from from the program and I don't really know what working best in all OS platforms.
      1. A wordfile is helpful enough, but word is not installed everywhere.
      2. RTF is very big files with pictures.
      3. I could save it as pdf, but not all have it either.
      4. Tried  .MHT file, but downside is browser could cover hole screen if browser closed this way. I have not found any way to resize it to specific size when open up.
      5. Use of IE.au3 lib. Well it could open mht files ,but always got question about use it as default browser or not. Think this also make IE browser lose control so I could not resize.
      6. Look at making a  .CHM file, but I don't think its the future do use that format. (.hlp is no no and old)

      Any tips of do it in autoit or make a call to open up in some nice format working everywhere.
       
    • By oceanwind
      Want to call .net func _Help::ShowHelpIndex.Here is the link in msdn:https://msdn.microsoft.com/en-us//library/system.windows.forms.help.showhelpindex.
      I wrote the script below:
      $dll = DllOpen("C:\Program Files\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.Windows.Forms.dll")
      $result = DllCall($dll, "none", "ShowHelpIndex","HWND", 0,"wstr","D:\Program Files\AutoIt3\AutoIt3CHS.chm")
      _check_result()
      DllClose($dll)
      Func _check_result()
              If @error Then
                      ConsoleWrite(">--|error:=" & @error & "|--<")
                      ConsoleWrite(@LF)
              Else        
                      ConsoleWrite(">--|$result:=" & $result[0] & "|--<")
                      ConsoleWrite(@LF)
              EndIf        
      EndFunc
      Can someone give some advices?
      tks in advance
×
×
  • Create New...