Before you start, install and enable the PHP and Command Line Tool Support repository plugins on the Plugins page of the Settings / Preferences Dialog.
On this page:
- Editing command definitions
- Reloading command definitions
- Validating the tool descriptor for structure consistence
Editing command definitions
- Open the Command Line Tool Support page ( for Windows and Linux or for macOS) .
-
Select the desired tool in the list and click
on the toolbar.
The .xmltool descriptor opens in the editor. -
Update the definitions of the commands as necessary.
As you type,
.xmltool descriptor is checked for well-formedness on the fly.
Reloading command definitions
You can add new commands to the .xml tool descriptor and use them without removing the tool from the list and configuring it anew.
To reload command definitions:
- Open the Command Line Tool Support page ( for Windows and Linux or for macOS) .
- Select the desired tool in the list and click
on the toolbar.
Validating the tool descriptor for structure consistence
When you edit command definition in an .xml tool descriptor, the file is checked for well-formedness on the fly.
Full validation is performed every time you invoke a command.
If any inconsistencies are detected, the tool is marked with the Invalid description icon
in the Command Line Tool Support page.
To validate a tool descriptor for structure consistence:
- On the main menu, choose . Depending on the Show console in setting in the Command Line Tool Support page, the Input pane opens either as a pop-up window or as a text box at the bottom of the Command Line Tools Console tool window.
- In the Input tab of the Command Line Tools Console tool window that opens, type the call of a command.
-
In the Tool definition file errors tab, analyze the notifications on detected
structure inconsistencies. Each notification shows a brief description of the problem, the file and
the line number where the problem is detected.
By default, the tab is hidden and opens when you click More in the Command Line Tool pop-up window with a notification on validation failure. To close the tab, click the cross on its header. To re-open it, click More once again.
The Command Line Tool pop-up window remains on the screen until you close it manually.