Jump to content



Photo

What tool do AutoIt developers use to document their Helpfile?


  • Please log in to reply
7 replies to this topic

#1 pacman1176

pacman1176

    Seeker

  • Active Members
  • 48 posts

Posted 18 January 2012 - 11:24 PM

I'm doing a senior project, and we'd really like to find out what type of software tools AutoIt uses to create their helpfile. It is the cleanest, most awesome helpfile I've probably ever read. Does anybody here know?





#2 water

water

    ?

  • MVPs
  • 10,693 posts

Posted 18 January 2012 - 11:30 PM

The UDF help files are created this way:
The function header files are extracted from the UDF file by a script named "BuildTemplates", a script named "Txt2htm" then creates the html help files.
I don't know how the CHM files are then created from this html files.
The formating of the html help files is controlled by CSS templates.

Edited by water, 18 January 2012 - 11:32 PM.

UDFs:

Active Directory (2012-10-12 - Version 1.3.0.0 released) - Download - General Help & Support - Example Scripts - Wiki

OutlookEX (2012-10-07 - Version 0.9.0.0 released) - Download - General Help & Support - Example Scripts - Wiki

ExcelChart (2013-01-21 - Version 0.3.1.1 released) - Download - General Help & Support - Example Scripts

WordEX (2012-12-29 - Version 1.3 released) - Download

ExcelEX (2013-05-11 - Alpha 4 released) - Download


#3 Valik

Valik

    Former developer.

  • Active Members
  • PipPipPipPipPipPip
  • 18,879 posts

Posted 19 January 2012 - 12:06 AM

The function header files are extracted from the UDF file by a script named "BuildTemplates", a script named "Txt2htm" then creates the html help files.

This is no longer true. The function headers are out of date and will be removed at some point. The TXT files are maintained directly.

#4 pacman1176

pacman1176

    Seeker

  • Active Members
  • 48 posts

Posted 19 January 2012 - 12:07 AM

Hey, cool thanks.

#5 Homes32

Homes32

    Wayfarer

  • Active Members
  • Pip
  • 51 posts

Posted 19 January 2012 - 07:25 PM

don't know how up2date this all is but here is some source code for the tools. last updated Dec 12, 2011
http://www.autoitscript.com/autoit3/files/beta/autoit/autoit-docs-v3.3.7.23-src.exe

Edited by Homes32, 19 January 2012 - 07:27 PM.


#6 AdmiralAlkex

AdmiralAlkex

    I'm on a boat

  • MVPs
  • 4,490 posts

Posted 19 January 2012 - 08:16 PM

don't know how up2date this all is but here is some source code for the tools. last updated Dec 12, 2011
http://www.autoitscript.com/autoit3/files/beta/autoit/autoit-docs-v3.3.7.23-src.exe

Wrong folder, 7.23 is in the beta (parent folder), not beta archive. And then there is the question why you would try to link someone to a old version instead of the current.

Archive > autoit-docs-v3.3.8.0-src.exe (seventh from top)

Edited by AdmiralAlkex, 19 January 2012 - 08:16 PM.


#7 Mat

Mat

    43 38 48 31 30 4E 34 4F 32

  • MVPs
  • 4,042 posts

Posted 20 January 2012 - 02:38 PM

I am a huge fan of doxygen, and use it in several projects.

Though from what you say you are less concerned about how the docs are generated and more concerned with their looks... Which *shouldn't* have anything to do with the generation itself. Doxygen I know allows for you to specify CSS files etc.

I don't know where I'm going, but I'm on my way.


#8 Sajen

Sajen

    Seeker

  • New Members
  • 1 posts

Posted 28 February 2012 - 01:55 PM

I think we can also compile CHM files using HTML Help Workshop. It takes HTML files for input.




0 user(s) are reading this topic

0 members, 0 guests, 0 anonymous users