User interface

Minimized size

After starting Consteel, the Descript panel appears on the bottom left part of the window in its minimized state.

For any further action the Descript panel has to be opened up with this button:

Maximized size

After opening up the Descript panel to its maximized state, further functionalities become available. There are 2 parts of the Descript module. First, we are greeted by the MyDescript interface.

MyDescript

This interface is designed to manage your own scripts stored on your computer and to access online scripts provided by Consteel.

In the header to the left there are 3 buttons with the following functions:

Close the Descript panel to its minimized state

Open the code editor and start a new script

Add an existing script file from the computer to the script list below

In the header to the right, the user name and membership level are displayed. Also, there is the Licence button.

Open the licence settings window.

In the main body to the left, there is the Script list, where all the local and online scripts are listed. The different types are shown with different icons in the Type column. Here you can run, edit or remove scripts by clicking the respective buttons in the rows of the individual scripts.

Run the script

Edit the script

Remove the script from the list (this does not delete the script file from the computer)

Scripts can also be searched with the **search bar **above the script list.

In the main body to the right there is the Description area. Here a picture and a description is displayed for the selected script.

After either starting a new script or editing one from the list the Descript panel switches to the code editor view.

Quick launch toolbar

In Consteel 16, you can select your favorite Descript scripts and pin them to the bottom bar to make them instantly available and ready for your work.

Creating a quick launch option for scripts

Open the MyDescript screen and click on the Pin icon next to the chosen script and the script will be available to start instantly for the Descript bar at the left bottom. Click on the Pin icon again to unpin the script.

Click on the Pin icon to pin a script to the quick launch bar

Pinned scripts will have a two letter mosaic word from their names and a cloud or computer icon which indicates if they are cloud or local scripts. Hovering with the mouse cursor over the pinned scripts will show their full name. You can also unpin scripts while hovering as an “unpin” icon will appear next to the script’s name.

Hover with your mouse cursor over the pinned script to reveal it’s full name

Code editor

The code editor is designed to write, modify and debug Descript codes.

In the header on the left there are several buttons with the following functions:

Switch back to the MyDescript view

Close the Descript panel to its minimized state

Save

Undo/redo last edit

Run the script

Start debugging. More on that at the Debugging page

In the header on the right there is the button for the watch window. More on that at the Debugging page

Below the header there is the code input area. This is where variables, cycles, commands can be defined, and will be executed line-by-line after the Run button is clicked. On the left, code lines are numbered. To the right of the code input area, there is a miniaturized view of the code currently in the editor, which acts as a second scrollbar for easier navigation within the code.

The editor applies different colors for commands, variables etc.. The color coding scheme is the following:

Code editor features

Command info box

If the mouse pointer is placed over a command, a box will appear with basic information about the command. The info box contains the following data:

• Short description of the command
• Syntax of the command (optional parameters are not shown here)
• Link to the user manual page of the command

Auto search

The editor automatically searches within all the already used variable names and all commands for the text already typed. The search results appear in a box around the cursor. The list of results can be navigated with the arrow buttons and an item can be selected with an Enter.

Autocomplete + insert

After an item is selected from the search results, the selected item gets inserted into the editor. There are 3 different type of inserts:

• Variable name
  Completes the variable name
• Field insert (for, if)
  Inserts a multi-line code segment with the empty structure of the selected item
• Command
  Completes the command, and if there are required parameters for the command then inserts some text for the parameters and enters the parameter definition mode. In this mode parameters can be easily defined. Just type the desired parameter value then switch between parameters with Tab (forward) and Shift+Tab (backward). Exit parameter definition mode with Esc.

Additional code editing features

The code editor provides a lot of additional code editing features to make coding more efficient. To view the full list of code editing features, click with the right mouse button and select Command palette.

Here is a selection with the most useful ones of these features.

Additional code editing features highlight:

Feature	Keyboard shortcut	Description
Command palette	F1	Lists all code editing features
List inserts	Ctrl+Space	Lists all variable names in the code and commands
Find	Ctrl+F	Searches the code for a given text
Replace	Ctrl+H	Replaces given text strings with different text
Move line up	Alt+↑	Moves selected code line up
Move line down	Alt+↓	Moves selected code line down
Change all occurrences	Ctrl+F2	Changes all occurrences of selected text
Add line comment	-	Adds "//" in front of all selected lines to make them comments
Remove line comment	-	Removes "//" from the front of all selected lines