 |
AutoHotkey Community Let's help each other out
|
| View previous topic :: View next topic |
| Author |
Message |
Lexikos
Joined: 17 Oct 2006 Posts: 2472 Location: Australia, Qld
|
Posted: Wed Mar 12, 2008 12:12 pm Post subject: LowLevel & Codegen preliminary documentation |
|
|
Edit: New version released; see the release thread.
(If at any point you don't know wth I'm talking about, don't be concerned.)
Since mid-January, I have been working on a project which I call "Codegen."
| Quote: | Code Generation Library, or code.ahk for short, facilitates run-time code generation. In other words, it allows an AutoHotkey script to create code - that is, functions, command-calls, expressions and control flow statements - while the script is running.
| It is not yet ready to be released, but it recently came up in discussion, and I'm anxious to get feedback from the preliminary documentation:
Code Generation Library
LowLevel (consider the public version pre-1.0)
Low-Level Script Structures
Functions which are documented have been written, but barely tested. I plan to add several examples of usage before releasing the code, and there are also a few small functions I have yet to write.
In general, I'd like to hear about:
- Any rendering problems or browser compatibility issues.
- Suggested improvements on the content, such as rewording or clarification.
- Suggested improvements to the interfaces (names, parameters) of the actual functions documented.
- Linkage between the three documents. For instance, since the three topics are so closely related, should they be merged? I would appreciate suggestions on how to do this while keeping them manageable.
- Preferred format, i.e. html, chm, pdf (not likely), etc.
- Any other problems, or other comments.
Note:
- The script for "tab" support in IE is based on Titan's XN-Docs.
- The style sheet is based directly on the official AutoHotkey documentation.
Last edited by Lexikos on Mon Jun 09, 2008 2:52 am; edited 2 times in total |
|
| Back to top |
|
 |
Laszlo
Joined: 14 Feb 2005 Posts: 3942 Location: Pittsburgh
|
Posted: Fri Mar 14, 2008 1:05 am Post subject: |
|
|
| It sounds fantastic. Would you need alpha testers? |
|
| Back to top |
|
 |
Lexikos
Joined: 17 Oct 2006 Posts: 2472 Location: Australia, Qld
|
Posted: Sat Mar 15, 2008 5:56 am Post subject: |
|
|
I decided to switch to HTML Help (chm), to make it easier to merge the three documents. I think you'd typically need to refer to functions from all three while using the codegen library.
Anyone who would like to test the script while I'm converting and completing the documentation may download the "pre-release" versions:
LowLevel.ahk
code.ahk
A few functions haven't yet been tested, and the remaining functions have been tested only briefly.
I've also updated the documentation to reflect some additions and changes that allow generated functions and labels to be accessed via dynamic function calls/dynamic labels.
Hopefully testing will also reveal any shortcomings of the documentation. 
Last edited by Lexikos on Sat Mar 15, 2008 11:56 am; edited 1 time in total |
|
| Back to top |
|
 |
majkinetor
Joined: 24 May 2006 Posts: 3592 Location: Belgrade
|
Posted: Sat Mar 15, 2008 11:22 am Post subject: |
|
|
U have a wrong link there, at code.ahk. _________________
 |
|
| Back to top |
|
 |
Lexikos
Joined: 17 Oct 2006 Posts: 2472 Location: Australia, Qld
|
Posted: Sat Mar 15, 2008 12:00 pm Post subject: |
|
|
Oh, html != ahk. Fixed.
Edit: Fixed automatic parameter counting in code_finalize. (I may not post or update the documentation for some changes, but I will keep a version history in code.ahk.)
Edit: Fixed code_finalize (was allocating too little memory for the codehandle.)  |
|
| Back to top |
|
 |
|
|
You can post new topics in this forum You can reply to topics in this forum
|
Powered by phpBB © 2001, 2005 phpBB Group
|