Easier access of scripting command syntaxes

Features wanted...
Post Reply
LittleBiG
Posts: 1846
Joined: 08 Apr 2011 12:57
Location: Win10x64

Easier access of scripting command syntaxes

Post by LittleBiG »

Please consider a way to access the command syntax easier. It happens that I want to run a command and I start writing into the address bar, but it turns out that I don't remember the syntax precisely. I have to open the help, command reference, locate the command and check the syntax then go back to address bar.

I can imagine a tooltip when I write the command into the AB (when XY recognizes it). Or even simply a command which can show me the relevant part of the command reference. Like: syntax "selfilter"; Or anything which could help to check the command faster.

admin
Site Admin
Posts: 60288
Joined: 22 May 2004 16:48
Location: Win8.1 @100%, Win10 @100%
Contact:

Re: Easier access of scripting command syntaxes

Post by admin »

I'll consider it.

eil
Posts: 1609
Joined: 13 Jan 2011 19:44

Re: Easier access of scripting command syntaxes

Post by eil »

I find this feature useful too. As a temporary solution i'd advice Call specific help topic script, that helps to find-remind scripting commands faster.
Win 7 SP1 x64 100% 1366x768

admin
Site Admin
Posts: 60288
Joined: 22 May 2004 16:48
Location: Win8.1 @100%, Win10 @100%
Contact:

Re: Easier access of scripting command syntaxes

Post by admin »

I considered it: No, I won't do anything. The current scripting documentation is a lot of work, and it's great. Just use it.

You can do something for yourself though. Compile a TXT file with all syntax definitions, one per row. Then use editconf to open and filter it; even edit it on the fly.

Code: Select all

editconf ,,"E:\Test\XYS-Syntax.txt";
Attachments
2023-06-16_073950.png
2023-06-16_073950.png (13.69 KiB) Viewed 474 times

PeterH
Posts: 2776
Joined: 21 Nov 2005 20:39
Location: Germany

Re: Easier access of scripting command syntaxes

Post by PeterH »

Seeing this picture I had to laugh :lol:
It looks very like what I'm working on. :party:
(No wonder, it shows output by InputSelect().)

But it's:
- generated, there's a script to generate a current basic data file
- can show all commands on a general level (much like your picture)
- can be searched (as InputSelect() provides)
- can show commands grouped by what they do (by a hand-made control file)
- can show details up to each(?) operand description

But it's in "early alpha stage", and will need much more time until I can show it.
(I hope all problems can be solved...)
W7(x64) SP1 German
( +WXP SP3 )

admin
Site Admin
Posts: 60288
Joined: 22 May 2004 16:48
Location: Win8.1 @100%, Win10 @100%
Contact:

Re: Easier access of scripting command syntaxes

Post by admin »

Cool, good luck! :tup: :beer:

Filehero
Posts: 2644
Joined: 27 Feb 2012 18:50
Location: Windows 10 Pro x64

Re: Easier access of scripting command syntaxes

Post by Filehero »

@Don: How do you "generate" the CHM-help file?

Is it manually by hand or is there a structured input ("data model") which is fed into a generator to render the final layout output?

admin
Site Admin
Posts: 60288
Joined: 22 May 2004 16:48
Location: Win8.1 @100%, Win10 @100%
Contact:

Re: Easier access of scripting command syntaxes

Post by admin »

I use a software, "Help & Manual". I can provide an XML file of each Help topic. (But they look terrible, hard to parse.)

Filehero
Posts: 2644
Joined: 27 Feb 2012 18:50
Location: Windows 10 Pro x64

Re: Easier access of scripting command syntaxes

Post by Filehero »

I would like to have a look at it. Could be a task for the upcoming winter.

admin
Site Admin
Posts: 60288
Joined: 22 May 2004 16:48
Location: Win8.1 @100%, Win10 @100%
Contact:

Re: Easier access of scripting command syntaxes

Post by admin »

it's so big, it will keep you warm if you burn it :)
Attachments
IDH_Scripting_ComRef.zip
(163.43 KiB) Downloaded 20 times

Filehero
Posts: 2644
Joined: 27 Feb 2012 18:50
Location: Windows 10 Pro x64

Re: Easier access of scripting command syntaxes

Post by Filehero »

:tup:

Post Reply