Jump to content

Sky Slate Blueberry Blackcurrant Watermelon Strawberry Orange Banana Apple Emerald Chocolate
Photo

« AHK FAQ »


  • Please log in to reply
108 replies to this topic
jaco0646
  • Moderators
  • 3165 posts
  • Last active: Apr 01 2014 01:46 AM
  • Joined: 07 Oct 2006

Personally I'd prefer the first one and not the 1 2 3 style as the titles of the forum links also provide useful info at times

Agreed. Let's not create link soup. I believe there should be a limit on the number of links posted for each FAQ... maybe five. Even that might be too high. As I mentioned previously, the ideal is one. Since all of these questions are ostensibly FAQs, there should be a good, concise answer somewhere. If a question hasn't come up often enough for anyone to take the time and really answer it, perhaps it is not a FAQ after all.

Since this Wiki page will be used almost exclusively by the veterans, lets make it as easy for us to use as possible. Ideally, I'd like to go there to answer a question and find a link to the answer... not the ten answers. I can search the forum for quantity. If we do that now (together) and pare down to the quality, we don't have to do it individually over and over in the future (see step five in my first list: evaluating the links).

SoLong&Thx4AllTheFish
  • Members
  • 4999 posts
  • Last active:
  • Joined: 27 May 2007
Ok, I updated the first example I made:
<!-- m -->http://www.autohotke... ... 2C_Malware<!-- m -->

Suggested FAQ Format:

Question
[*:2nbz7sf0] (Very) Short description of problem
[*:2nbz7sf0] Useful search terms (CSV)
[*:2nbz7sf0]with 1-5 results, reference to Official faq if there is one (games for example)[*:2nbz7sf0]Related links
[*:2nbz7sf0]Useful AHK commands[/list]

jaco0646
  • Moderators
  • 3165 posts
  • Last active: Apr 01 2014 01:46 AM
  • Joined: 07 Oct 2006
Ok, I think the format is getting better. At the moment it looks like we have:[*:c0qw3lg2]Description[*:c0qw3lg2]Links[*:c0qw3lg2]Tips[*:c0qw3lg2]More linksIdeas:[*:c0qw3lg2]Since these are frequently asked questions, the description section should be in the form of a question, i.e. the actual question asked on the forum (this is how the official FAQ looks). For example: "My AV software flagged AHK as malware. Does it really contain a virus?"

[*:c0qw3lg2]We should be able to condense the links into one section. I think most FAQs will not have a clear-cut distinction between "categories" of answers. I guess it would be nice to have the links in order representing how important they are. That way I always know to start at #1.

[*:c0qw3lg2]Are tips necessary? Hopefully any important tips would be covered in the forum threads that are already linked to. Having a tip that doesn't include a link would seem to indicate that an important point has not been covered in any previous forum discussion.

SoLong&Thx4AllTheFish
  • Members
  • 4999 posts
  • Last active:
  • Joined: 27 May 2007
Something like this?
<!-- m -->http://www.autohotke... ... a_virus.3F<!-- m -->

(such long urls don't wrap well for smaller resolutions)

Added the Related commands as it may be useful for some FAQs as an example.

Here is one thread about autohotkey.exe, one about compiled scripts and two with additional info, seems reasonable. Besides it is a wiki, can easily be adjusted. I got the idea for the search terms from engunneer thread <!-- m -->http://www.autohotke...topic21919.html<!-- m --> which I think is helpful, sometimes a noob might not know the terms to use.

jaco0646
  • Moderators
  • 3165 posts
  • Last active: Apr 01 2014 01:46 AM
  • Joined: 07 Oct 2006
I like the search terms as well. Here is my updated version: http://www.autohotke...le=FAQ#Virus.3F. Does it make more sense to discuss this on the Wiki's discussion page, or stay here?

tomoe_uehara
  • Members
  • 2166 posts
  • Last active: Jun 11 2015 05:33 PM
  • Joined: 05 Sep 2009
Why not both? So user at the forum can share their thoughts too

jaco0646
  • Moderators
  • 3165 posts
  • Last active: Apr 01 2014 01:46 AM
  • Joined: 07 Oct 2006
redundancy = clutter
less is more
simplicity

SoLong&Thx4AllTheFish
  • Members
  • 4999 posts
  • Last active:
  • Joined: 27 May 2007
I like it and suggest that is the format to strive for for other FAQs.
Discussion can be kept here because not many will visit the wiki on a regular basis.

Next tasks:

- What is a FAQ? It really has to be asked on a regular basis, not just once or twice (if someone adds one that doesn't seem to be a FAQ we can discuss here or on the Wiki) I suggest to just start adding ones
- Which FAQs? Perhaps people can note in this thread which FAQ they would like to add so there will be no duplicate work?

I'll do:
- "Can't edit script, where is it, script gives error won't run anymore"

Edit: done:
<!-- m -->http://www.autohotke... ... _script.3F<!-- m -->
(no search terms as anything with edit, error, script provides many unrelated results but kept link to search.

Edit2:
and brought into practice here <!-- m -->http://www.autohotke... ... 156#373156<!-- m -->

Edit3:
believe it or not, FAQ used twice today
<!-- m -->http://www.autohotke... ... 231#373231<!-- m -->

Elesar
  • Members
  • 696 posts
  • Last active: May 08 2015 09:51 PM
  • Joined: 28 Jun 2007
I too like that format.

Not sure when I will have time to start adding stuff, as I am out of town this weekend, but I'll try and start helping out as soon as possible.

SoLong&Thx4AllTheFish
  • Members
  • 4999 posts
  • Last active:
  • Joined: 27 May 2007
This is the format in wiki code for a quick start

== Short heading ==

'''Question'''

[http] terms: ''keyword,keyword''

*:[url text]



jaco0646
  • Moderators
  • 3165 posts
  • Last active: Apr 01 2014 01:46 AM
  • Joined: 07 Oct 2006
It would be nice to categorize the FAQs as we go. For example, Virus shouldn't really be a heading, because it's too specific. There won't be any more FAQs in that small category. It should go under something like "About AutoHotkey" or "General Script Concerns." One list of categories was proposed on the last page. Also, the Contents tab of the Help file seems like a good list. Either way, I think it's easier to categorize as we go rather than enter information randomly and then try to clean it up after we've made a mess. :p

EDIT: The problem I run into is that looking through my precious list of 20 FAQs, half of them seem to be "General Script Concerns."

SoLong&Thx4AllTheFish
  • Members
  • 4999 posts
  • Last active:
  • Joined: 27 May 2007
Perhaps a "Security" heading could be:

- Current Virus FAQ

These could be combined into one FAQ:
- Password protect a script.
- Is the /NoDecompile option secure?
--> Can I protect my source code?

- Run while PC is locked

The "can't edit/find my script" could be "General Scripting" :?:

I've cleaned up the FAQ by removing all old content (can be put pack via history if someone disagrees or wants to see some of the trial & error)

<!-- m -->http://www.autohotke...x.php?title=FAQ<!-- m -->

jaco0646
  • Moderators
  • 3165 posts
  • Last active: Apr 01 2014 01:46 AM
  • Joined: 07 Oct 2006
Oh, Security is a good heading. I was going to delete all the material you did, except for How are threads implemented? That information should eventually be used in a multithreading FAQ, since it's a common question (e.g. How do I do two things simultaneously?).

SoLong&Thx4AllTheFish
  • Members
  • 4999 posts
  • Last active:
  • Joined: 27 May 2007

Oh, Security is a good heading. I was going to delete all the material you did, except for How are threads implemented? That information should eventually be used in a multithreading FAQ, since it's a common question (e.g. How do I do two things simultaneously?).

OK, put it back for you. I like the look of it in general 8)

Lexikos
  • Administrators
  • 9844 posts
  • AutoHotkey Foundation
  • Last active:
  • Joined: 17 Oct 2006
The information under "How are threads implemented" is incorrect. AutoHotkey does not "multiplex between [threads] from the main event loop." When an interesting message (hotkey, hotstring, OnMessage, GUI message, etc.) is received, the event loop recursively calls Line::ExecUntil to run the appropriate subroutine. In this way, an AutoHotkey quasi-thread is much closer to a synchronous function-call than an actual thread. For instance, no older thread can run until all newer threads "return." I may update the wiki myself if/when I get time, or someone else can.