Suggestions on documentation improvements

Propose new features and changes
JDN
Posts: 9
Joined: 09 May 2018, 01:33

Re: Suggestions on documentation improvements

19 May 2018, 10:16

As Lexicos pointed out in the following thread:

https://autohotkey.com/boards/viewtopic.php?f=5&t=49224

I was mistaken in posting that you can remove the Hidden attribute from the C:\ProgramData folder by using the Folder Options from Windows Explorer or the Control Panel. It enables one to see that folder when using Windows Explorer but it does not change the Hidden Status.

I had spent several hours trying to update my Startup folder and was only able to do it when I discovered that freeware Startup utility. I guess I was very tired and got confused.

I want to thank Lexicos for correcting my errors.
User avatar
Flipeador
Posts: 780
Joined: 15 Nov 2014, 21:31
GitHub: Flipeador
Location: Argentina
Contact:

Re: Suggestions on documentation improvements

26 May 2018, 15:26

Windws 1♂ Pro 64-Bits I make scripts for AHKv2 (my v2 compiler) & WIN_7+ Spanish Argentina SublimeText 3 & AHKv2
joefiesta
Posts: 141
Joined: 24 Jan 2016, 13:54

WORD WRAP in GUI TEXT control

29 May 2018, 08:19

I would like to see the documentation for GUI, ADD, TEXT include the following:

When automatic word-wrapping is enable in a TEXT control, any words which by necessity would need to be split (at the end of a row) are, instead, truncated.

(or, of course, some similar language)

Thank you

Joe Petree
joefiesta
Posts: 141
Joined: 24 Jan 2016, 13:54

what does "=" do?

01 Jun 2018, 15:03

At the documentation for OPERATORS In EXPRESSIONS (part of VARIABLES AND EXPRESSIONS), =, while it is shown, IS NOT DEFINED. There the doc states:

Equal (=), case-sensitive-equal (==), and not-equal (<> or !=). The operators != and <> are identical in function. The == operator behaves identically to = except when either of the inputs is not a number, in which case == is always case sensitive and = is always case insensitive (the method of insensitivity depends on StringCaseSense). By contrast, <> and != obey StringCaseSense.


This does not say what = does. I find this especially confusing since = can also be used for assignment.
joefiesta
Posts: 141
Joined: 24 Jan 2016, 13:54

What is a PARENT window?

02 Jun 2018, 13:21

The documentation for +PARENT (found in the GUI topic) says the following:
Parent [v1.1.03+]: Use +Parent immediately followed by the name or number of an existing Gui or the HWND of any window or control to use it as the parent of this window. To convert the Gui back into a top-level window, use -Parent. This option works even after the window is created.


That is all it says. This does not tell me what a PARENT gui is or does.
swagfag
Posts: 739
Joined: 11 Jan 2017, 17:59

Re: What is a PARENT window?

02 Jun 2018, 17:01

joefiesta wrote:The documentation for +PARENT (found in the GUI topic) says the following:
Parent [v1.1.03+]: Use +Parent immediately followed by the name or number of an existing Gui or the HWND of any window or control to use it as the parent of this window. To convert the Gui back into a top-level window, use -Parent. This option works even after the window is created.


That is all it says. This does not tell me what a PARENT gui is or does.

using the option implies prior awareness of the window creation hierarchy. i dont think it should be explained here, really. i dont think it even could be, without introducing bloat that is. maybe link to https://msdn.microsoft.com/en-us/library/ms632599(v=VS.85).aspx for those wanting to dig deeper, but a downside to that is that u never know when MS will 404 it
User avatar
jeeswg
Posts: 4504
Joined: 19 Dec 2016, 01:58
Location: UK

Re: Suggestions on documentation improvements

05 Jun 2018, 00:01

SORT
- This quote from the Sort command page has caused me a lot of confusion.
When the function deems the first parameter to be greater than the second, it should return a positive integer
- I might suggest something like:
When the function deems that the first parameter should be placed later in the final/sorted list than the second, it should return a positive integer
- Also, the page does not warn about stable v. unstable sort, which again caused much confusion for me.
- I've collected a list of rules of useful info for custom sort functions, here (including comments on stable v. unstable sort):
Numerically AND Alphabetically sorting data - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=5&t=50104&p=222183#p222183

FORMAT
- The Format function page could do with some more examples. I've collected some here:
jeeswg's characters tutorial - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=7&t=26486
- One tricky thing to do is to produce a number of the form '6.6' e.g. 000123.456000 or -000123.456000.

REGEX QUICK REFERENCE
The AHK v2 version of this AHK v1 page:
Regular Expressions (RegEx) - Quick Reference
https://autohotkey.com/docs/misc/RegEx-QuickRef.htm
mentions these: LS/line separator/chr(0x2028) and PS/paragraph separator/chr(0x2029), which I believe are applicable to AHK v1 also, but not mentioned. Also, the AHK v1 page does not mention the O (object) mode.

INPUTBOX
InputBox
https://autohotkey.com/docs/commands/InputBox.htm
Default values of W375 H189 are mentioned.
On Windows 7 I get: W384 H204 (window), and W368 H166 (client).
What do the numbers refer to?

GUI (AHK V2)
This page lacks a Related Pages section at the bottom:
GuiControl Object
https://lexikos.github.io/v2/docs/objects/GuiControl.htm
E.g. this page does have a Related Pages section:
GUI Control Types
https://lexikos.github.io/v2/docs/commands/GuiControls.htm
Perhaps all pages could consistently use 'Related' or 'Related Pages'. 'Related Pages' would be better because you could skip to it directly by doing Ctrl+F, 'Related P', whereas 'Related' could appear in the document in other places.
joefiesta
Posts: 141
Joined: 24 Jan 2016, 13:54

GUI shortcut keys

12 Jun 2018, 09:09

At the doc for GUI, ADD for controltype TEXT the use of a shortcut key (letter preceded by ampersand to indicate keyboard shortcut) in the TEXT parameter is mentioned and a pointer (link) to "shortcut key" at "Keyboard navigation" exists.

However, none of the other GUI ADD control types' documentation includes this (except GUI ADD BUTTON).

This is inconsistent. Each control type that allows a shortcut key should include the reference to a shortcut key.

One should not have to read about GUI ADD TEXT to learn about GUI ADD CHECKBOX etc. If information of a general or all-inclusive nature is to be included for individual control types, I believe it should PRECEDE all the specific information.

( the shortcut key is also valid for CHECKBOX and BUTTON. There may be others.)
User avatar
hoppfrosch
Posts: 317
Joined: 07 Oct 2013, 04:05
GitHub: hoppfrosch
Location: Rhine-Maine-Area, Hesse, Germany
Contact:

V2-Docu: FileCreateDir is missing

18 Jun 2018, 02:30

Within V2-Documentation, the command "FileCreateDir" is undocumented. The command is still referenced on page "Script Compatibility".

The command "FileCreateDir" seems to be replaced with "DirCreate" - nevertheless the command is still available in V2
Helgef
Posts: 2990
Joined: 17 Jul 2016, 01:02
Contact:

Re: Suggestions on documentation improvements

18 Jun 2018, 03:39

nevertheless the command is still available in V2
I get call to non-existent function,
User avatar
jeeswg
Posts: 4504
Joined: 19 Dec 2016, 01:58
Location: UK

Re: Suggestions on documentation improvements

18 Jun 2018, 05:30

@hoppfrosch: Which version of AHK v2 are you using? I tried FileCreateDir as a command and function in AHK v2.0-a096 and got the same error as Helgef.
User avatar
hoppfrosch
Posts: 317
Joined: 07 Oct 2013, 04:05
GitHub: hoppfrosch
Location: Rhine-Maine-Area, Hesse, Germany
Contact:

Re: Suggestions on documentation improvements

18 Jun 2018, 06:25

:oops: My fault - just ignore my request

Return to “Wish List”

Who is online

Users browsing this forum: No registered users and 1 guest