Page 1 of 1

Easier access of scripting command syntaxes

Posted: 26 Sep 2022 11:43
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.

Re: Easier access of scripting command syntaxes

Posted: 15 Jun 2023 15:02
by admin
I'll consider it.

Re: Easier access of scripting command syntaxes

Posted: 15 Jun 2023 19:29
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.

Re: Easier access of scripting command syntaxes

Posted: 16 Jun 2023 07:40
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";

Re: Easier access of scripting command syntaxes

Posted: 16 Jun 2023 11:52
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...)

Re: Easier access of scripting command syntaxes

Posted: 16 Jun 2023 12:08
by admin
Cool, good luck! :tup: :beer:

Re: Easier access of scripting command syntaxes

Posted: 16 Jun 2023 20:58
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?

Re: Easier access of scripting command syntaxes

Posted: 17 Jun 2023 07:52
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.)

Re: Easier access of scripting command syntaxes

Posted: 17 Jun 2023 09:36
by Filehero
I would like to have a look at it. Could be a task for the upcoming winter.

Re: Easier access of scripting command syntaxes

Posted: 17 Jun 2023 09:39
by admin
it's so big, it will keep you warm if you burn it :)

Re: Easier access of scripting command syntaxes

Posted: 18 Jun 2023 00:11
by Filehero
:tup: