AutoHotkey Community
It is currently May 27th, 2012, 4:21 am

View unanswered posts | View active topics


Board index » AutoHotkey » Scripts

All times are UTC [ DST ]



Post new topic Reply to topic  Page 1 of 1
  [ 8 posts ] 
  Print view | E-mail friend Previous topic | Next topic 
Author Message
derRaphael
PostPosted: February 22nd, 2010, 11:15 pm 
Offline

Joined: November 23rd, 2007, 10:23 am
Posts: 841
Location: ~/.
Hi all,
    Doc-O-Matic is a script, capable of tracking functions in a different AHK script and generating a HTML documentation from it.

    It also supports Syntax Hiliting and inline linking to functions used by the script. A documentation to stdLib files and ahk's documentation is on the feature list for rc1, same as a stylesheet editor for a better customizing of
    the look and feel.

    See a Live Sample / DOWNLOAD


    Code:
    ; Released under the Terms of EUPL 1.1 or later
    ; Also released under the Terms of GPL V3 or later
    ; (w) 2010 by derRaphael

    ; The software is hereby free of any guarantees
    ; It has been tested and developed under winxp and ahk 1.0.48.05

    ; If it works, good for you. If as a result your wife wants to
    ; get divorced - not my beer.

    ; There are numerous bugs and many caveats
    ; the entire script is subject to change for a better functionality
    ; and feature design. for now only the core functionality is to
    ; be tested.

    ; Usage Limitation: Leave the Generated by Hint intact.


    Closer Future Planned features:
    • Customizable Syntax hiliting
    • Custome StyleSheet Editor
    • Support of multiple Files
    • Support for detecting StdLib functions
    • Support for linking to official documentation
    • Plugin Structure
    • Better landing organization of the HTML (instead of a large function list)
    • Customize which data to see

    Far Future Planned features:
    • Label / HotKey / String detection
    • Script Flow analysis for automatic behaviour documentation
    • Much more...

    I ask everybody who uses this script, to leave the bottom block intact, so that interested user's may be abled to see where to get the software.

    See a Live Sample / DOWNLOAD

    Known Bugs:
    • Syntax Lexer gets comments too good (such as MsgBox aaa; bbb), thx fincs
    • unknown if it works with ahk_l or ahk_u
    • functionnames containing numbers wont get catched internally by the lexer


Have fun and please post feedback to improve this script!

8)
dR

_________________
Image
    All scripts, unless otherwise noted, are hereby released under CC-BY


Last edited by derRaphael on February 23rd, 2010, 9:02 am, edited 3 times in total.

Report this post
Top
 Profile  
Reply with quote  
derRaphael
 Post subject:
PostPosted: February 22nd, 2010, 11:22 pm 
Offline

Joined: November 23rd, 2007, 10:23 am
Posts: 841
Location: ~/.
-reserved for plugins index-

_________________
Image
    All scripts, unless otherwise noted, are hereby released under CC-BY


Report this post
Top
 Profile  
Reply with quote  
tank
 Post subject:
PostPosted: February 23rd, 2010, 3:33 am 
Offline
User avatar

Joined: December 21st, 2007, 3:14 pm
Posts: 3826
Location: Louisville KY USA
$%^&* in my mouth thats frakkin cool as shit i love this

Thank you

_________________
No matter what your oppinion Please join this discussion
Formal request to Polyethene
Image


Report this post
Top
 Profile  
Reply with quote  
doyle
 Post subject:
PostPosted: February 23rd, 2010, 2:37 pm 
Offline

Joined: November 14th, 2007, 2:47 pm
Posts: 335
Location: London, England
Very cool. :)


Report this post
Top
 Profile  
Reply with quote  
Tuncay
 Post subject:
PostPosted: March 6th, 2010, 1:01 pm 
Offline

Joined: November 7th, 2006, 9:47 pm
Posts: 1934
Location: Germany
I will use a modified version of your script to generate on the fly documentation in my public collection of libraries. I am including the script in tools folder for automatically accessing from my script. Here are the currently changed lines, for automation reason to avoid user prompt:

Quote:
Code:
;?add 2010-03-06 MODIFIED for automation by Tuncay, all changes are marked with ;? comments.

Code:
   ;?out FileSelectFile, ScriptPath, 1, %A_ScriptDir%, Select an AHK Script
   
   ;?add-begin
   ScriptPath = %1%
   ;?add-end

Code:
   ;?mod-begin
   version := "0.5.2-mod_by_Tuncay" ;?original "0.5.2"
   ;?mod-end

Code:
   ;?out FileSelectFile, FileName, S16,,Name where To save the HTML

   ;?add-begin
   FileName = %2%
   ;?add-end

Code:
   ;?out run, % FileName

Thats all. Its a really really great and cool script. I love it! Thx.

Hope it is ok that I`ll include it in my package.

Notes:
?out = outcommented
?mod = modified
?add = added

_________________
{1:"ahkstdlib", 2:"my libs", 3:"my apps", 4:"my license"}
--> Don't feed the troll! <--


Report this post
Top
 Profile  
Reply with quote  
Tuncay
 Post subject:
PostPosted: March 6th, 2010, 1:15 pm 
Offline

Joined: November 7th, 2006, 9:47 pm
Posts: 1934
Location: Germany
Does not work on my ini library:
http://www.autohotkey.com/forum/viewtopic.php?t=46226

_________________
{1:"ahkstdlib", 2:"my libs", 3:"my apps", 4:"my license"}
--> Don't feed the troll! <--


Report this post
Top
 Profile  
Reply with quote  
derRaphael
 Post subject:
PostPosted: March 6th, 2010, 3:49 pm 
Offline

Joined: November 23rd, 2007, 10:23 am
Posts: 841
Location: ~/.
this beta does not work with your ini library because of the preamble you used. since there are lines which start directly with an opening perenthesis, the script interprets it as a continuation section and produces rubbish. this is a major flaw of the script's design and it might take a while to get around that bug. sorry. thanks for finding it though.

dR

_________________
Image
    All scripts, unless otherwise noted, are hereby released under CC-BY


Report this post
Top
 Profile  
Reply with quote  
tic
 Post subject:
PostPosted: April 13th, 2010, 5:24 pm 
Offline

Joined: April 22nd, 2007, 6:33 pm
Posts: 1833
A very clever script indeed....2 thumbs up


Report this post
Top
 Profile  
Reply with quote  
Display posts from previous:  Sort by  
Post new topic Reply to topic  Page 1 of 1
  [ 8 posts ] 

Board index » AutoHotkey » Scripts

All times are UTC [ DST ]

Who is online

Users browsing this forum: Stigg and 8 guests

You can post new topics in this forum
You can reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Powered by phpBB® Forum Software © phpBB Group