Text editors
From BISim Wiki - Mirror I
While it is possible to create scripts and config files with Windows' regular Notepad, dedicated editors have features like auto-completion, syntax highlighting and bracket matching that makes scripting and troubleshooting a lot easier.
The latest wordfiles, and instructions on how to set up syntax highlighting for the most popular editors at BIA are listed below:
Contents |
Wordfiles
The required syntax definitions for Notepad++, TextPad & UltraEdit can be found in this file: WordFiles.zip
Notepad++
- Download the latest version of the wordfile, and extract it.
- Get userDefineLang.xml from this SVN repo: p:\doc\Text Editors\Notepad++.
- Open Windows Explorer, and enter %appdata%\Notepad++ in the address bar.

- The entered address (%appdata%\Notepad++) will be converted into something similar to C:\Users\username\AppData\Roaming\Notepad++.
Copy the file userDefineLang.xml into this folder
(If you already have a userDefineLang.xml file, then merge the "VBS2" section into the existing file.)
- If you now open a file with an extension of SQS or SQF, Notepad++ will automatically highlight the defined keywords.

- To edit the associated extensions, display attributes (e.g. the highlight colors), or the command list, select "View | User-Defined Dialogue...", select "VBS2" from the "User Language" drop-down list, and adjust the settings to your liking.
UltraEdit
V15 and later
- Download the latest version of the wordfile, and extract the "Version 15 and higher part".
- Make sure UltraEdit is closed.
- Open Windows Explorer, and enter %appdata%\IDMComp\UltraEdit\wordfiles in the address bar.

- The entered address (%appdata%\IDMComp\UltraEdit\wordfiles) will be converted into something similar to C:\Users\ltd\AppData\Roaming\IDMComp\UltraEdit\wordfiles.
Copy the file VBS2_Script.uew into this folder.
- To edit the display attributes, open "Advanced | Configuration", and select "Syntax Highlighting" from the Navigation group "Editor Display".
Select "ArmA/OFP/VBS2 Scripts" from the "Language Selection" drop-down list on the right, choose the desired "Color Group", and then adjust the foreground and background colors to your liking.
- More instructions are available here: http://www.ultraedit.com/support/tutorials_power_tips/ultraedit/add_a_wordfile.html
V14 and earlier
- Download the latest version of the wordfile, and extract the "Version 14 and lower part".
- Open your existing wordfile in UltraEdit, by going to "Advanced | Configuration", and selecting "Syntax Highlighting" from the Navigation group "Editor Display".
Click on the "Open" button next to the path to the current wordlist file.
- Append VBS_Scripts.txt to the end of the current wordfile.
The first line of the language definition section starts with /L20 (this indicates the index of the language, with a maximum of 20).
Make sure there is no other section that has the same index. If there is one already, find a free index, and use that one instead for the VBS2 section. - More instructions are available here: http://www.ultraedit.com/support/tutorials_power_tips/ultraedit/add_a_wordfile_pre_v15.html
Auto-complete
To enable auto-completion, go to "Advanced|Configuration" - "Editor|Auto-complete", and check the "Show auto-complete dialog automatically" option.

Be aware though, that auto-completion will always use lowercase for all commands.
Textpad
Version 5 and higher
- Download the latest version of the wordfile, and extract it.
- Get the syntax definition files from this repo:
p:\doc/\Text Editors\TextPad
- Make sure Textpad is closed.
- Copy the two *.syn files into the "Samples" subfolder of your TextPad installation folder (e.g. Program Files\TextPad 5\Samples).
- Open Textpad, and select "Configure | New Document Class...".
- As "Document class name", enter "SQF", click "Next".

- As "Class members", enter "*.sqf", click "Next".

- Check "Enable syntax highlighting", and select "sqf.syn" from the "Syntax definition file" drop-down lists.

Click "Next" and "Finish".
- To edit the associated extensions and the display properties, select "Configure | Preferences...", and open the "SQF" branch in the "Document Classes" tree.

- More instructions are available here: http://www.textpad.com/add-ons/syna2g.html