AutoHotkey Community

[thefunnyman]

AutoHotkey Standard Library Functions
With the blessing of the AHK community, I'd like to help administer a centralized location for StdLib functions. I'm thinking Autohotkey.net would be the perfect place for function storage. In order to effectively organize and document a task such as this, a set of standards needs to be implemented for submitted functions.

StdLib Function Standards Suggestions
1. If a script for stdlib inclusion contains multiple functions, any functions that would only be called from within that script could have the prefix private_ or scriptname_. This will ensure that more complex scripts with backend functions won't interfere with functions contained in other StdLib scripts. Just a thought.

Steps for Function Submission to the StdLib
1. Identify strong candidate scripts and functions for the stdlib in this thread
2. The author or a volunteer should document each candidate.
3. Someone other than the author should perform some type of quality-assurance review of that item's function(s). This includes basic testing, but more importantly a review of the design to see that the syntax is efficient, user-friendly, and as future-proof as possible. This is because script-breaking changes made to the stdlib items after they're released could/would cause a lot of problems for users.

I'll be more than happy to help with testing and the like to the best of my abilities, but I'll be honest, some things slung around in this forum are just WAY over my head.

Todo:
Determine the best way to standardize the documentation process. We could create a link in the wiki with documentation for each function submitted for the stdlib. I personally tend to think that this would be a tedious process and might be asking too much from the stdlib function authors. Another possibility ( maybe easier ) would be to document each function inside of the code and use a tool ( such as Natural Docs ) to format the comments in each file into a nice organized html file. If all are willing to accept this as a documentation standard, I would be more than happy to keep the documentation file up to date and in an easily accessible place.

This simple sample function below demonstrates proper documentation as outlined using Natural Docs. Again, this is just a suggestion, I would definitely like some feedback on everyone's preferred documentation practices.

The original script that I have adapted for the standard library was originally referenced here.

[thefunnyman]

I think another good function for the StdLib would be Titan's Anchor.

This is a well-documented, very handy, script for automatic control resizing for your AHK Gui. I'm sure that if there were a way to determine hits/downloads of that script, one would notice that it's probably been thoroughly tested. Any comments/suggestions?

[thefunnyman]

There is a nice sticky at the top of this forum with a list of custom gui controls. I'd like everyone's opinion on whether a script with external dll dependencies ( ie. dll's not currently supplied with the OS ) should be included in the StdLib.

[engunneer]

Another useful one would be XPath by Titan. It does not quite conform to the standard library format, but could be easily updated.

I vote that a Lib function that needs an external DLL is fine, as long as it is packaged nicely. it may be tricky to get the relative paths worked out.

I wonder - does the standard library allow subfolders?
_________________

(Common Answers)

[thefunnyman]

[Chris]

The stdlib and userlib don't currently support subfolders. However, that capability is under consideration for a future version.

[Andreone]

I really like the idea of a standard lib.

What about making this thread a sticky? It may be more visible and accessible for forum people. Maybe there will be more contribution this way.

What about providing the stdlib as an archive (kind of "official" library, easy to install and keep up to date)?

About the tool to format comments, you could consider Doxygen.
I use it regularly and it's a great documentation generation tool.

[engunneer]

I vote Natural Docs over DOxygen - I think it will be easier to learn for most.

I expect this thread will be sticky once it contains a number of functions. For now, I think it is not ready.
_________________

(Common Answers)

[thefunnyman]

[fincs]

Hi,
I've seen this topic and I don't want to install a 60MB program (Natural Docs), because I use AHK in a 512MB USB flash drive and I normally got 3 MB of free space. For my submissions I would use a documentation style like AHK's helpfile.
_________________
fincs
Get SciTE4AutoHotkey v3.0.00 (Release Candidate)
[My project list]

[Andreone]

[majkinetor]

2 fincs
First, its not 60MB, but 12MB. Second you don't have to install anything but download compiled documentation somebody else will surely create for you as Ndoc is for person who maintance StdLib pack, not you (thats right, you don't need to have Ndoc to create it, and to read it, only browser, much better then lousy CHM Viewer as you have all browser features there (nice bookmarks, zoom, better search...) Third, when you find yourself without documentation you will be able to read it from the source code, and if you happen to have that magical 12MB on your hard disk and you are bored reading help from the source code, you can unpack archive and type mkdoc to have HTML help there. and then you can safely delete natural docs.

[Boo]

[fincs]

First of all I'm going to tell you my situation: I got two computers: a desktop and a laptop. I work the majority of time in the laptop. Then the laptop isn't mine, is of my mum and my dad (yes, I am only a child). I cannot install or write anything on this laptop. So I got a USB flash drive where AHK, scripts, programs and stuff of mine are. But I always got my flash drive with a few MB's of free space (3 MB's or more). So I download Natural Docs and got it in my desktop or on the laptop? If I use Natural Docs I would got it in my flash drive, but this program occupies too much. For that I don't want (or rather: I cannot) install Natural Docs.

[majkinetor]