[Archived, Locked] Suggestions on documentation improvements

Share your ideas as to how the documentation can be improved.
User avatar
joedf
Posts: 8940
Joined: 29 Sep 2013, 17:08
Location: Canada
Contact:

Re: Suggestions on documentation improvements

01 Mar 2016, 16:06

TheDewd wrote:
jNizM wrote:Should we host it (mpress) on autohotkey.com?
+1

I found another mirror by HotKeyIt... Located in the following archive in the "Compiler" folder:
https://github.com/HotKeyIt/ahkdll-v1-r ... master.zip
:+1:
https://autohotkey.com/mpress/
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500, NVIDIA GTX 1060 6GB, 2x16GB Kingston FURY Beast - DDR4 3200 MHz | [About Me] | [About the AHK Foundation] | [Courses on AutoHotkey]
[ASPDM - StdLib Distribution] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library]
User avatar
jNizM
Posts: 3183
Joined: 30 Sep 2013, 01:33
Contact:

Re: Suggestions on documentation improvements

02 Mar 2016, 02:37

Now the docs need to be changed (direct-link to zip)
[AHK] v2.0.5 | [WIN] 11 Pro (Version 22H2) | [GitHub] Profile
User avatar
joedf
Posts: 8940
Joined: 29 Sep 2013, 17:08
Location: Canada
Contact:

Re: Suggestions on documentation improvements

02 Mar 2016, 03:45

Hmmm, would you do the honours to submit à pull request in github? :)
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500, NVIDIA GTX 1060 6GB, 2x16GB Kingston FURY Beast - DDR4 3200 MHz | [About Me] | [About the AHK Foundation] | [Courses on AutoHotkey]
[ASPDM - StdLib Distribution] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library]
User avatar
SnowFlake
Posts: 368
Joined: 28 Apr 2015, 05:41
Contact:

Re: Suggestions on documentation improvements

08 Apr 2016, 17:23

Hey

I wish that the current/up to date version of Autothokey were listed on the downloader button or beside it so you know what the latest version is without need to download it it and then see the version

Image
:yawn:
User avatar
joedf
Posts: 8940
Joined: 29 Sep 2013, 17:08
Location: Canada
Contact:

Re: Suggestions on documentation improvements

08 Apr 2016, 20:37

This has been discussed before. but there were too many problems with permissions. However, we do have it on the forum's topbar ;b
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500, NVIDIA GTX 1060 6GB, 2x16GB Kingston FURY Beast - DDR4 3200 MHz | [About Me] | [About the AHK Foundation] | [Courses on AutoHotkey]
[ASPDM - StdLib Distribution] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library]
Bruttosozialprodukt
Posts: 463
Joined: 24 Jan 2014, 22:28

Re: Suggestions on documentation improvements

20 Apr 2016, 07:47

I just cloned the repo to add pages for SubStr etc... when I saw that someone had already done this 2 month ago.
Hmm, maybe I'll write some examples for pages that don't yet have very good ones instead. Or is there something else with more priority at the moment?
lexikos
Posts: 9560
Joined: 30 Sep 2013, 04:07
Contact:

Re: Suggestions on documentation improvements

27 Apr 2016, 23:00

@Bruttosozialprodukt: Progress on low priority items is better than no progress. Do whatever takes your interest.
Bruttosozialprodukt
Posts: 463
Joined: 24 Jan 2014, 22:28

Re: Suggestions on documentation improvements

20 May 2016, 06:13

What is your opinion on adding screenshots to the docs?
lexikos
Posts: 9560
Joined: 30 Sep 2013, 04:07
Contact:

Re: Suggestions on documentation improvements

21 May 2016, 06:23

Perhaps some example pages with screenshots would help to show their value.
victorel
Posts: 21
Joined: 09 Jun 2016, 14:44
Location: Canada

Re: Suggestions on documentation improvements

10 Jun 2016, 16:59

This topic/thread "Suggestions on documentation improvements" is way too big to be a single topic/thread. Let us make it a subforum, or subfolder of "Wish List" (or even a separate forum?). So that inside the new "DOCUMENTATION SUGGESTIONS" folder, people could create separate topics for: QuickStart Tutorial; Basic Usage and Syntax; etc.

The reason is that, when a topic/thread is too big in scope , then when someone replies with a new idea there, before there will be enough replies to it, someone else will post a totally different idea underneath. So that the former idea will not get enough attention and replies, and so will not get traction and a chance at serious consideration.
In addition, the current situation does not allow for polls (votings) for a particular change.
lexikos
Posts: 9560
Joined: 30 Sep 2013, 04:07
Contact:

Re: Suggestions on documentation improvements

24 Jun 2016, 22:08

I have updated the Send documentation to clarify Raw mode and the usage of modifier symbols. Along the way, I noticed that the key list is (perhaps incompletely) duplicated on the Send page. Does anyone else think the list of keys (but not Send-specific options like Click, Blind and Raw) should be removed from the Send page, or are they worth keeping there simply so that the reader doesn't have to mentally add {braces}? It might be worth at least separating the Send-specific options from the general key names (currently they are mixed together).
User avatar
haichen
Posts: 631
Joined: 09 Feb 2014, 08:24

Re: Suggestions on documentation improvements

25 Jun 2016, 05:31

Recently i used send but forgot the keyname i wanted to use. It was the Send page where i looked. Please don't remove the key list. Send and Keylist have to stick together i think.
lexikos
Posts: 9560
Joined: 30 Sep 2013, 04:07
Contact:

Re: Suggestions on documentation improvements

25 Jun 2016, 20:56

So should every page's content be duplicated on every other page where a user is likely to look for it?

Would you have been unable to find the key name if you looked on the Send page and found only a link to the key list? I suppose that mightn't help if you were searching (Ctrl+F) that page for some term related to the key (or searching for the key name to find related notes), but in that case a global search will likely do the job.
User avatar
haichen
Posts: 631
Joined: 09 Feb 2014, 08:24

Re: Suggestions on documentation improvements

26 Jun 2016, 16:09

?? why did you ask the forum ??
lexikos
Posts: 9560
Joined: 30 Sep 2013, 04:07
Contact:

Re: Suggestions on documentation improvements

26 Jun 2016, 21:30

To get answers. :eh: Why do you think I asked subsequent questions? I don't mind if you don't answer them, but it means that I won't understand your point of view as well as I could.
User avatar
joedf
Posts: 8940
Joined: 29 Sep 2013, 17:08
Location: Canada
Contact:

Re: Suggestions on documentation improvements

26 Jun 2016, 22:44

I'll just sit here and... Admire this moment of social awkwardness... **eats popcorn** :troll:
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500, NVIDIA GTX 1060 6GB, 2x16GB Kingston FURY Beast - DDR4 3200 MHz | [About Me] | [About the AHK Foundation] | [Courses on AutoHotkey]
[ASPDM - StdLib Distribution] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library]
User avatar
haichen
Posts: 631
Joined: 09 Feb 2014, 08:24

Re: Suggestions on documentation improvements

27 Jun 2016, 04:33

I just wanted to give a statement (meaning) that you should leave it as it is although it is redundant. Nothing more. I like it as it is. But of course there may be reasons to remove this. And may be I will like this even more.
The Autohotkey documentation of is really good and helpful. But also the good could get better.

(Your Questions are rhetoric (sorry for my english). "So should every page's content be duplicated on every other page where a user is likely to look for it? Would you have been unable to find the key name if you looked on the Send page and found only a link to the key list?" You could only answer No and No.)

But nevertheless i want to say thank you for your work!
And also to all the scriptwriter!
I use Autohotkey everyday and it has given me my job! :D
Keep it up!

And now popcorn for the EM 2016 !
lexikos
Posts: 9560
Joined: 30 Sep 2013, 04:07
Contact:

Re: Suggestions on documentation improvements

27 Jun 2016, 22:22

They were not rhetorical. You could have answered "Yes, I would still have been unable to find the key name because xxx."

If someone asks me to do something for a reason that makes no sense to me, I will question it.
TAC109
Posts: 1099
Joined: 02 Oct 2013, 19:41
Location: New Zealand

Re: Suggestions on documentation improvements

17 Jul 2016, 17:55

There is no mention of the built-in variables 'true' and 'false' under 'variables and expressions' -> 'built-in variables' -> 'special characters' (or elsewhere under 'built-in variables').
My scripts:-
XRef - Produces Cross Reference lists for scripts
ReClip - A Text Reformatting and Clip Management utility
ScriptGuard - Protects Compiled Scripts from Decompilation
I also maintain Ahk2Exe

Return to “Suggestions on Documentation Improvements”

Who is online

Users browsing this forum: sanmaodo and 7 guests