Using Notepad++

Navigation: User Guide ➔ Editors and Utilities ➔ Notepad++

Related Links: PGMs, PGM Introduction

---

NOTE: While Notepad++ is still fully supported, from Build 139.32530 we recommend the use of VS Code as a more modern and fully-featured code editor.

Introduction

Notepad++ is an alternative to the standard Windows Notepad for writing control files (PGM and MP) and Archive Reporter configuration files (SAC), as it makes viewing and editing code much easier. It is free to download and install under the GPL (GNU General Public License).

The Notepad++ installer and the SysCAD Language XML files are distributed with SysCAD (\SysCADxxx\Setup\Notepad++\) or may be downloaded from the SysCAD download site.

Notepad++ Features

Notable features for use with SysCAD are listed and illustrated below. A complete list of features can be found on the Notepad++ Online Help: https://notepad-plus-plus.org/online-help

1. Line numbers
2. Colour-coding of keywords, functions, comments, etc.
3. Colour themes, light and dark modes
4. Auto-complete for SysCAD keywords and functions
5. Drag-and-drop editing for copying and moving between documents
6. Block selection mode (hold Alt), and optional display of tabs and spaces
7. Automatic aligning and indenting (relative to previous line) to aid block indentation
8. Highlight all occurrences of the current selection to assist with visual search and debugging of code logic
9. Search and Replace in Files (for multi-file editing)

Installing Notepad++

Step 1: Locate Notepad++ Install File

Notepad++ and the relevant User Defined Language Files for SysCAD can be found in the following locations:

1. Included with the SysCAD Install:
   • After SysCAD is installed, the Notepad++ install package can be found in folder: \SysCADxxx\Setup\Notepad++\npp.xxxx.Installer
2. Downloaded from SysCAD Downloads page:
   • Downloads page > SysCAD 9.3 (requires Username and Password) > Notepad++ (Install File) and SysCAD Notepad++ Files (User Defined Language Files).

The latest version of Notepad++ may also be downloaded directly from http://notepad-plus-plus.org

Step 2: Run the Install File

Once you have located the Notepad++ install file:

1. Run the Install program
   • Depending on your operating system, select either the 32-bit or 64-bit version. Do not install both versions.
   • The default location for Notepad++ 32-bit version is C:\Program Files (x86)\Notepad++\
   • The default location for Notepad++ 64-bit version is C:\Program Files\Notepad++\
2. You can change this location if required. If you do specify a different location, you will need to browse for the installed location in Step 5: Configuring SysCAD to use Notepad++

Step 3: Setting up Keyword highlighting

Once the install is complete, start Notepad++ and follow the steps below to enable keyword highlighting:

1. Select Language > User Defined Language > Define your language...
2. Click Import
3. Import the SysCADLanguage.xml file located in SysCADxxx\Setup\Notepad++
4. Close and restart Notepad++ for the changes to take effect.
5. If colours are not visible when Notepad++ restarts, go to menu option "Language" and select "SysCAD PGM (Light Mode)" from the List of User Defined Languages.
   • SysCAD PGM (Light Mode) and (Dark Mode) are both available from Build 139.32925.
   • SysCAD PGM (Light Mode) works well with the default white background.
   • When using a dark background, select SysCAD PGM (Dark Mode). To enable dark mode, go to Settings > Preferences > Dark Mode, then select a preferred dark theme from Settings > Style Configurator....

NOTE: If you already have Notepad++ with an older version of SysCAD languages installed, please refer to Repairing or updating User Defined Language instead.

Step 4: Setting Up Auto-complete Functions and Keywords

Once the install is complete follow the steps below to enable auto-complete functionality:

1. Copy files containing SysCAD PGM ***.xml from the SysCADxxx\Setup\Notepad++ folder to ..\Notepad++\plugins\APIs or ..\Notepad++\autoCompletion folder depending on Notepad++ version
   • For example, if the user defined language "SysCAD PGM (Dark mode)" is in use, ensure the matching "SysCAD PGM (Dark Mode).xml" file is copied.
2. Start Notepad++
3. Select Settings > Preferences > Auto-Completion
4. Set up the preferences as shown in the image below:

   

5. Click on 'Close' and this functionality will be available for PGM and MP files.

Step 5: Configuring SysCAD to use Notepad++

1. In SysCAD, from menu Tools > General Options on the General Tab
2. If Notepad++ was correctly installed, simply press the Select ... button (for PGM and/or Text/CSV) and choose Notepad++ from the dropdown list.

   

3. Once this is done, the next time you press the Edit_PGM or Edit Archive button in SysCAD, Notepad++ will launch automatically.

Troubleshooting

Syntax Colours not Visible

• If using Notepad++ v6.2 or earlier, it is recommended to uninstall and install the latest version.

If SysCAD files do not display colours for the keywords, it is likely that the User Defined Language has not been added or configured correctly. Please restart Notepad++ and refer to Step 3: Setting up Keyword highlighting.

If colours are still not visible, go to Language menu and select SysCAD PGM (Light Mode) from the list of User Defined Languages.

Repairing or updating User Defined Language

To update or repair the files required for colour syntax of SysCAD files:

1. Open Notepad++
2. Select Language > User Defined Language > Define your language...
3. From the User Language dropdown menu select SysCAD PGM and then click Remove (repeat for SysCAD Reaction, SysCAD Archive, as required).
4. Close and restart Notepad++ for the changes to take effect.
5. Re-import the correct or updated language file, referring to Step 3: Setting up Keyword highlighting.