Script: Call specific help topics - scripting only
Posted: 22 Jan 2024 11:07
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
To get there you can e.g. use:
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
If you still don't trust it, don't download or use it!
Open the
If you want to let the chm window appear somewhere else, edit the other values in that file as well.
Now execute
It will write an .ini file into its directory:
Edit that file and adapt the
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
entry in the
If you want to forcefully initiate the redetection of all script commands:
- Clear the
or
Run the script like this once (assuming that it is in your standard XY scripts path):
Current version:
Previous version(s):
ShowHelpFile:
This is how the html selection output looks like:
This is how the inputselect output looks like:
Scanning results for ShowHelpFile.exe:
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 FolderThe 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 placeShowHelpFile.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-positiveIf 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 fileIf 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].iniEdit that file and adapt the
ExtViewer= entry if necessaryExtViewer=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= valueor
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";