SciTE

SciTE Documentation

Frequently Asked Questions

Standard Editing

Text editing in SciTE works similarly to most Macintosh or Windows editors with the added feature of automatic syntax styling. SciTE can hold multiple files in memory at one time but only one file will be visible. SciTE's initial configuration only allows one file to be in memory at once but this can be modified by changing the value of the buffers property. Rectangular regions of text can be selected in SciTE by holding down the Alt key on Windows or the Ctrl key on GTK+ while dragging the mouse over the text.

There are two panes in SciTE, the editing pane and the output pane. The output pane is located either to the right of the editing pane or below it. Initially it is of zero size, but it can be made larger by dragging the divider between it and the editing pane. The Options | Vertical Split command can be used to move the output pane beneath the editing pane.

SciTE can perform commands to compile or run source files with the output from these commands directed into the output pane.

For example, if Python is installed on the machine, open a new document, type:

print "Hi"

as that document's text.

print "hi"

>python -u printhi.py
hi
>Exit code: 0

SciTE partially understands the error messages produced by Python, GCC, Visual C++, Borland C++, PHP and other tools which use the same format as one of these. To see this, add a mistake to the Python file by adding a second line to make the file:

print "hi"
mistake

Perform the Tools | Go command. The results should look like:

>python -u printhi.py

hi

Traceback (innermost last):

  File "printhi.py", line 2, in ?

    mistake

NameError: mistake

>Exit code: 1

While it is easy to see where the problem is in this simple case, when a file is larger the Tools | Next Message command can be used to view each of the reported errors. Upon performing Tools | Next Message, the first error message in the output pane is highlighted with a yellow background, and an error indicator is displayed for the appropriate line in the editing pane. The caret is moved to this line and the pane is scrolled if needed to show the line. SciTE now looks like this:

SciTE understands both the file name and line number parts of error messages in most cases so can open another file (such as a header file) if errors were caused by that file. This feature may not work where the file name is complicated by containing spaces or ".."

If command execution has failed and is taking too long to complete then the Tools | Stop Executing command can be used.

On Windows, SciTE defaults to executing tools as command line programs. Executing a GUI program in this mode results in that program being run without displaying a window. The command.subsystem option can be used to define tools that run in GUI mode. The default subsystem, 0, is for command line programs, 1 is for programs which create their own windows, and 2 is for using the ShellExecute call. ShellExecute is a good way to open HTML files and similar as it handles this similarly to a user opening the file from the shell. 3 is for calling an internal extension or director extension, 4 is for calling the Windows specific HtmlHelp program and 5 is for calling the Windows specific WinHelp function. On GTK+, the default subsystem 0 executes the tool and waits for it to finish, redirecting output to the output pane and subsystem 2 executes the tool in the background.

Command line arguments

Command line arguments to SciTE include file names, commands and properties. Commands and properties are preceded by "-" and are differentiated by the use in commands of ':' as the first character that is not '.' or alphabetic. Properties use the syntax used in property set files and override any properties set in property files. If there is no value given for a property, it is set to 1. Double quotes may be placed around arguments that contain spaces but they must be placed around the whole argument, not just around a file name, so "-open:x y.txt" works but -open:"x y.txt" doesn't. On Linux, the standard shell quoting is available. The "-p" argument causes SciTE to print the file and then exit.

For example,
SciTE "-font.base=font:MS Gothic,size:11" -save.recent ScintillaGTK.cxx
starts SciTE, opens ScintillaGTK.cxx, loads the recent file list, and uses 11 point MS Gothic as the base font.
A group of properties can be saved as a property set file (with the extension ".properties") and the import command used on the command line:
SciTE "-import c:\os\web_work" SciTEDoc.html

A few commands are currently available although this will expand in the future. These commands are available:

Command	Argument
close:
cwd:	change working directory
find:	search text
goto:	line number[,column number]
open:	file name
quit:
replaceall:	search text\000replacement text
saveas:	file name

Commands use C style escape sequences which include:

Escape Sequence	Meaning
\\	backslash
\a	bell
\b	backspace
\f	form feed
\n	new line
\r	carriage return
\t	tab
\v	vertical tab
\<ooo>	octal number specified by 1, 2, or 3 digits
\x<hh>	hexadecimal number specified by 2 digits

The following opens /big/icon.txt:
SciTE -open:/big/icon.txt
On Windows, the following opens C:\Program Files\SciTE\SciTEDoc.html and goes to the 123th line:
SciTE "-open:C:\\Program Files\\SciTE\\SciTEDoc.html" -goto:123

Command line arguments are evaluated left to right in two phases because opening files requires the user interface to be available and there is also a need to set some user interface properties before the user interface is displayed. The first phase process arguments until just before the first file name would be opened. The second phase processes the remaining arguments.

So, if you need to perform e.g. a find: or a goto: command on a file, you must put the command after the filename, to allow SciTE to open the file before performing the command.

Buffers

SciTE may be configured to use between 1 and 100 buffers each containing a file. The default is 1 and this effectively turns off buffers. With more than one buffer, the Buffers menu can be used to switch between buffers, either by selecting the file name or using the Previous (F6) and Next (Shift+F6) commands. Setting more than 10 buffers may cause problems as some menus are fixed in length and thus files beyond that length may not be accessible.

When all the buffers contain files, then opening a new file causes a buffer to be reused which may require a file to be saved. In this case an alert is displayed to ensure the user wants the file saved.

Sessions

A session is a list of file names. You can save a complete set of your currently opened buffers as a session for fast batch-loading in the future. Sessions are stored as plain text files with the extension ".ses".

Use File | Load Session and File | Save Session to load/save sessions. You can turn on/off "last session autoloading" using SciTE properties variable "save.session".

If "buffers" variable is set to "0" session management is turned off.

Loading previously saved session will close your currently opened buffers. However you will not loose your edits, because you will be asked to save unsaved buffers first.

Opening a specific file from command line overrides "save.session" variable state. When you start SciTE loading a specific file from command line last session will not restore even if "save.session" variable is set to "1". This makes "save.session" safe to use - you will never open a couple of files when you are trying to open just one, specific file.

Languages understood by SciTE

SciTE currently is able to syntax style these languages:

• Ada
• Avenue
• C/C++/C#
• Eiffel
• HTML
• HTML with embedded JavaScript, VBScript, PHP and ASP
• IDL - both MSIDL and XPIDL
• INI, properties and similar
• Java
• JavaScript
• Lisp
• Lua
• Make
• Pascal
• Perl, but not all of the language
• Python
• Ruby
• SQL and PLSQL
• VB and VBScript
• XML

Running and building commands for some of these languages have been set up but should be checked as they will have to be modified to work for many people.

Language settings are determined from the file extension but this can be changed by selecting anothr language from the Language menu. The language menu can be changed with the menu.language property.

Find and Replace

SciTE has options to allow searching for words, regular expressions, matching case, in the reverse direction, wrapping around the end of the document. C style backslash escapes which are listed in the command line arguments section, may be used to search and replace control characters. Replacements can be made individually, over the current selection or over the whole file. When regular expressions are used tagged subexpressions can be used in the replacement text.

SciTE supports basic regular expressions with tagging.

Keyboard commands

Keyboard commands in SciTE mostly follow common Windows and GTK+ conventions. Keyboard equivalents of menu commands are listed in the menus. Some less common commands with no menu equivalent are:

Abbreviations

To use an abbreviation, type it and use the Expand Abbreviation command or the Ctrl+B key. The abbreviation is replaced by an expansion defined in the Abbreviations file. You can open the Abbreviations file with a command in the Options menu and add abbreviations.

Each line in the files looks like "abbreviation=expansion". An expansion may contain new line characters indicated by '\n' and a caret position indicated by the '|' character. To include a literal '|' character, use '||'. Some simple examples are included in the distributed Abbreviations file.

Folding

SciTE supports folding for Python, HTML/XML, Pascal, and C++/C/Java/JavaScript. Fold points are based upon indentation for Python and on counting braces for the other languages. The fold point markers can be clicked to expand and contract folds. Ctrl+Shift+Click in the fold margin will expand or contract all the top level folds. Ctrl+Click on a fold point to toggle it and perform the same operation on all children. Shift+Click on a fold point to show all children.

Properties file

Much of SciTE's behaviour can be changed by editing the properties files.

There are three properties files used, a global properties file called "SciTEGlobal.properties", a per user file called "SciTEUser.properties" (with a dot for the GTK+ version: ".SciTEUser.properties") and a local one called "SciTE.properties" which may be present in the same directory as the file being edited. On Windows, both the global and user properties files are in the directory of the executable. For GTK+ the user properties file is found in the user's home directory and the global properties in a directory set at build time - normally /usr/share/scite. If the "SciTE_HOME" environment variable is set on either Windows or GTK+ then it is where both the global and user properties files are found. Settings in the local properties file override those in the user properties file which override those in the global properties files. Environment variables are also available as properties and these are overridden by an explicit setting in one of the properties files.

The user properties file is intended for customisation by the user, leaving the global properties file to contain the default options distributed with SciTE. The main use of the local properties files is to change the effects of the Compile, Build and Go commands for the files in a directory. For example, I use the javac compiler from the Java Development Kit for most work, so SciTEGlobal.properties sets the command for compiling .java files to "javac". If I want to use the jvc compiler for the files in one directory, then the SciTE.properties file in that directory contains an entry setting the command to "jvc".

There are commands in the Options menu for opening each of the properties files.

The files are in approximately the same format as Java properties files which have a simple text format. Lines that start with '#' or that are completely blank are comments. Other lines are of the form

variable=value

For long values, a '\' character at the end of the line continues that value on the next line. Values may include the values of other variables by using $(variablename). There are some variables set by the environment to access the name of the current file as well:

Some features use file name patterns to see which variable to use. For example, the lexer variable can be specialised for a particular file, or a group of files based upon wildcard matching so:
lexer.makefile=makefile indicates that the lexer called "makefile" should be used on files called "makefile".
lexer.*.cxx=cpp indicates that the lexer called "cpp" should be used on files with a "cxx" extension.
Variable substitution is available on the left hand side of file pattern assignments and look like this:
file.patterns.html=*.html;*.htm;*.asp;*.shtml
command.go.$(file.patterns.html)=file://$(FilePath)

Importing properties files and conditional logic

The 'import' statement includes a properties file as if the text were inline at that point. The imported properties file must be in the same directory as the current file and a .properties extension is assumed. Therefore a "import Lua" statement in c:\os\scite\bin\SciTEGlobal.properties will import c:\os\scite\bin\Lua.properties.

The 'if' statement takes one argument which is a symbol that may be defined earlier in this property set file or in a base property set. If the symbol evaluates to '0' then the test fails. An empty string or not present symbol evaluates to 0. Into the very top property set is inserted one of 'PLAT_GTK' with value '1' or 'PLAT_WIN' with value '1'. If the test succeeds then following indented statements are executed. When a non-indented statement is found the if clause is finished. Only simple set statements are allowed in if clauses. The evaluation of if statements occurs at read time, not at evaluation time.

Command parameters and prompting

SciTE has 4 properties $(1) .. $(4) which can be used to run commands with changeable parameters. To set the parameter values, use the View | Parameters command to view the modeless Parameters dialog which shows the current values of these parameters and allows setting new values. The accelerator keys for the main window remain active while this dialog is displayed, so it can be used to rapidly run a command several times with different parameters. Alternatively, a command can be made to display the modal Parameters dialog when executed by starting the command with a '*' which is otherwise ignored. If the modeless Parameters dialog is already visible, then the '*' is ignored.

Defined variables in properties files

Some properties are only available on Windows or GTK+.

  LF   for UNIX format

  CR   for Macintosh format

  CRLF for DOS/Windows format

caret.policy.{x|y}<param> interaction:

Supporting a new language

For languages very similar to existing supported languages, which may only differ in a minor feature such as the keywords used, the existing lexers can often be reused. The set of keywords can then be changed to suit the new language. Java and JavaScript could have reasonably reused the C++ lexer. The Java lexer was added only to support doc comments.

For languages that can not be lexed with the existing lexers, a new lexer can be coded in C++.

Installing a lexer into SciTE

The open.filter should be modified to include the file extensions used for the new language and entries added for command.compile, command.build, command.go and command.go.needs for the language.

Creating API files

The .api files can be generated by hand or by using a program.

For C/C++ headers, an API file can be generated using ctags and then the tags2api Python script (which assumes C/C++ source) on the tags file to grab complete multiple line function prototypes. Some common headers surround parameter lists with a __P macro and may have comments. The cleanapi utility may be used on these files.

To generate an API file for Python modules, there is a gen_python script.

To generate an API file for Java classes, there is a ApiBuilder.java program.

SciTE in other languages

SciTE can be and has been translated into other languages.

Building SciTE

The procedure for building and installing SciTE is described in the README file in the scite directory.

Extending SciTE

There are two formal extension interfaces for SciTE, the SciTE Extension Interface is for extending SciTE with code compiled into the SciTE executable and the SciTE Director Interface is for manipulating SciTE on Windows from another application.

How do I change SciTE to use black as the background colour?

You need to change the style settings. The main change is in the global options file to the global default style and caret colour but you may have to change other style settings to make this work well:
style.*.32=$(font.base),back:#000000,fore:#ffffff
caret.fore=#FFFFFF

How do I make the horizontal scroll bar adjust to the width of text?

To avoid slow performance the horizontal scroll bar does not automatically adjust. You can use the horizontal.scroll.width property to change the horizontal scroll range.

How do I enable tabbed window mode in SciTE?

Set tabbar.visible=1 in your SciTEGlobal.properties but beware that tabs are only avaliable on Windows. You can also set tabbar.hide.one=0 to always show tabs, or 1 to hide when only one file is open. tabbar.multiline=1 splits tabs across various lines if neccesary.

How do I enable autocomplete?

Goto Options | Open Global Options File and uncomment
autocompleteword.automatic=1

When I try to compile/build/run my [some language] source files, I get the following error: 'The system cannot find the file specified'.

Make sure that the path to your compiler is set correctly on your system. Try to execute from console the same command you get in SciTE and see if it works. You can also search in your [language].properties for the compile commands used. If you have a different compiler or use different arguments, edit the commands to suit your needs. The lines to look for:
command.compile.filepattern=
command.build.filepattern=
command.go.filepattern=

How can I add [some external application] to the tools menu on SciTE?

In your properties file, you'll need to add some lines:

command.name.number.filepattern
(e.g.: command.name.1.$(file.patterns.web)=HTML Tidy)
This defines the Text that will appear on the Tools Menu.

command.number.filepattern
(e.g.: command.1.$(file.patterns.web)=tidy -i -wrap 0 -m $(FilePath) )
This is the actual command that SciTE executes. You should provide the appropiate paths, options and parameters as you would from a command line. See SciTEDoc.html for more information on parameters and how to make SciTE prompt a Parameters Dialog.

command.is.filter.number.filepattern
(e.g.: command.is.filter.1.$(file.patterns.web)=1)
The external application may have modified your file, so setting this to true makes SciTE reload the file after execution of the command.

command.subsystem.number.filepattern
(e.g.: command.subsystem.1.$(file.patterns.web)=2)
This is for Windows and defines the subsystem through which the program is called. See SciTEDoc.html for more information on this.

You can set a command for all files using * as a file pattern. Up to 10 commands (0 - 9) can be defined in the Tools Menu at any time. Commands also get executed with Ctrl+number.