Script: Call specific help topics - scripting only

[highend]

This is the "little" brother of: viewtopic.php?t=9248

It's only there to get fast access to commands / functions of the XYplorer scripting language (and NOT to all other topics of the help file)

With the default configuration it'll show all entries as a html page for easier finding a command...

Initial setup
Place the Show help topics [scripting].xys in your XYplorer script folder.
To get there you can e.g. use: Menu | Scripting | Go to Scripts Folder

The external "ShowHelpFile" tool exists to navigate to scripting commands by reusing only one chm window instance
instead of opening multiple windows each time you use the script to show another help entry.
To use it download the ShowHelpFile.zip attachment, extract it and place
ShowHelpFile.exe & ShowHelpFile.ini (together) wherever you like (but NOT in a UAC protected folder)
ShowHelpFile.exe is detected as a trojan by some anti-virus engines. Ofc this is a false-positive
If you still don't trust it, don't download or use it!

Open the ShowHelpFile.ini with a text editor and adapt the path to your XYplorer.chm file
If you want to let the chm window appear somewhere else, edit the other values in that file as well.

Now execute Show help topics [scripting].xys once.
It will write an .ini file into its directory: Show help topics [scripting].ini
Edit that file and adapt the ExtViewer= entry if necessary
ExtViewer=D:\Tools\XYplorer\@Tools\ShowHelpFile\ShowHelpFile.exe

Running it
Now run the script again and everything should work as expected...
If not, post in this thread and show where you've copied all the files and what you've changed in the two .ini files^^

To gather all available script commands the XY .chm file is extracted.
This happens only when a new XY version is detected or the LastVersion=
entry in the Show help topics [scripting].ini file is empty.
If you want to forcefully initiate the redetection of all script commands:
- Clear the LastVersion= value
or
Run the script like this once (assuming that it is in your standard XY scripts path):

Code: Select all

perm $P_SHOW_HELP_TOPICS_SCRIPTING_UPDATE = true;
    load "Show help topics [scripting].xys";

Current version:

Show help topics [scripting]_v0.7.3.xys

Previous version(s):

Show help topics [scripting]_v0.7.2.xys

Show help topics [scripting]_v0.7.1.xys

Show help topics [scripting]_v0.4.xys

Show help topics [scripting]_v0.3.xys

ShowHelpFile:

ShowHelpFile.zip

This is how the html selection output looks like:

html.png

This is how the inputselect output looks like:

inputselect.png

Scanning results for ShowHelpFile.exe:

Virustotal result.png

[klownboy]

Looks good highend. It's nice that you included links for undocumented scripting commands.

[highend]

v0.2 added (you need to download the inital version too if you want to use the external viewer tool!)
Added the option to define the height of the inputselect dialog window via the .ini

[highend]

v0.3 added (and v0.2 removed)

The HTML now has a link at the bottom #Show inputselect...
It lets you switch to the inputselect dialog

The dialog itself has an entry at the top #Show HTML...
...
You can switch as often between both views until you select an entry or close any of them...

[highend]

I've attached a new ShowHelpFile.exe .zip (it includes the .ini file).

The .exe is signed and Microsoft doesnt't think it's malware anymore...

[Daniel0312]

hi highend
I love this script and use it all the time ! So user friendly. Thank you.
Just noticed there's at least one command missing » getpathcomponent(), gpc()
and one too much » preview64 (one is from the change log, the other from the help file)

[highend]

All fixed

Code: Select all

Changes for v0.4:
getpathcomponent / gpc & interfacecolors / ifc aliases are added
getinfo aliases points to the correct new get section (for XY >= 24.00.0104)
preview64 removed from the "Undocumented" .ini section

Before you run v0.4, delete its belonging .ini file (normally: Show help topics [scripting].ini)!

[Daniel0312]

great ! thank you

[klownboy]

Thanks for another update highend. I made a personal preference type change for the non-HTML listing such that the option to switch to the HTML version is at the bottom of the list. Which is similar to the way it is on the HTML version. I really don't need to see that option on the top of the list, and it's really not something a user is going to change that often to warrant a top of list position. I also got rid of the line numbers "4096" since I really don't need to see them.
$cfgContent = $cfgContent . <crlf 2> . $entry;

Thanks again.

[highend]

v0.5 released

Code: Select all

Added:
- LinkPosHTML & LinkPosInput keys (in the [General] section) added
   Both use "bottom" as their default value.
   If you want any of them to show at the top, use "top" instead
- LineNumbersInput key (in the [General] section) added
   The default is true / 1
   If you don't want to see line numbers in the non-HTML dialog window, set it to false or 0
- Missing .ini values (because of new released script versions) are now added to the .ini file through the script
   No more doing this by hand
- Various small tweaks and corrections

[eil]

0.5 attachment "doesn't exist anymore".
Is there a change for "dark" version?(maybe optional through INI)

It it possible to add/make same alphabet-column for get()?

[highend]

0.5 attachment "doesn't exist anymore".

Gone because of forum provider change

Is there a change for "dark" version?(maybe optional through INI)

v0.7.1 in the first post provides basic support for it...

You have to manually add (to an existing .ini file) these two entries

Code: Select all

DarkModeHTML=true
DarkModeColor=#262626

in the [General] section...

It it possible to add/make same alphabet-column for get()?

Why should this be done? The different info arguments (Alias, Bitness, ...) don't have a jump marker in the help file so you would only ever jump to the main entry anyway...

[eil]

Thanks for fast update!

You have to manually add (to an existing .ini file) these two entries

Code: Select all

DarkModeHTML=true
DarkModeColor=#262626

May there be same setting for changing links color? (blue on dark is so-so, yellow would be better)

It it possible to add/make same alphabet-column for get()?

Why should this be done? The different info arguments (Alias, Bitness, ...) don't have a jump marker in the help file so you would only ever jump to the main entry anyway...

Well yeah, since i'd wish it had those jump markers, i "lost myself for a moment" and hoped scripting could help with that.
It's only left to hope Don adds those markers one day.(or i'll learn how to edit the Help file )

[highend]

Code: Select all

v0.7.2
  Added: "DarkModeLink" in .ini to define the dark mode link color
         "DarkModeLetter" in .ini to define the dark mode letter color

  Changed: "DarkModeColor" in .ini replaced by "DarkModeBG" key name

After updating, run the script once.
After that, remove the "DarkModeColor=..." entry from the .ini file

[klownboy]

Hi highend, for info only, when I repeatedly tried to run Show help topics [scripting]_v0.7.2, I would get this error message below. I had changed the ini info as you had mentioned.

ShowHelpTopics.jpg

A little strange, but it wasn't until I ran the other script, D:\Tools\XYplorer\Scripts\ShowHelpTopic.xys (the full script, not the slimmed down scripting commands version) that the new script, Show help topics [scripting]_v0.7.2.xys ran without the error. Note: I had no similar issues with the previous versions. Thanks for the update.