Configuration Files

From notepad-plus

(Difference between revisions)

Current revision as of 15:56, 29 January 2012

Notepad++'s configuration files

shortcuts.xml: this file contains all the recorded macro, user defined commands and remapped shortcuts information.
userDefineLang.xml: this file contains all the definitions for user defined languages to be highlighted (see User Defined Languages).
doLocalConf.xml: a zero length file which is use to determinate where Notepad++ loads the xml files.

When it looks like a setting is lost, a common cause is that there are two sets
of files, one in the %APPDATA%\Notepad++ folder and one alongside Notepad++.exe. Then
either N++ doesn't read the right file, or the setting was saved into the wrong file.

allowAppDataPlugins.xml: a zero length file which, if present, will allow plugins installed in %APPDATA\Notepad++\plugins to be loaded as well as "local" plugins. This behaviour is configurable from the last install wizard page. And it is as easy to change as deleting/creating a file.
asNotepad.xml: a zero length file which is use to make Notepad++ behaviour similar to MS Notepad (ie. always open a file in a new instance with single document interface).
toolbarIcons.xml: this file will enable you to customise the icons on your toolbar - but not the set of buttons. See Toolbar Customisation for more on this topic.
nativeLang.xml: When using a localization from Settings -> Preferences -> Global, the corresponding file from the Localizations subfolder is copied to nativeLang.xml and elements of the user interface are being translated. The localization files are described in Localisation.

Those xml files (except doLocalConf.xml and asNotepad.xml which should be always in Notepad++ Install Folder, and langs.xml, which must be in %APPDATA%\Notepad++\ under Windows Vista or 7) are loaded from %AppData%\Notepad++ or Notepad++.exe's own folder, it depends respectively on the absence or presence of doLocalConf.xml in Notepad++.exe's folder.

Factory defaults

In case any of the 3 mandatory files is missing, Notepad++ will try to replace it with its *.model.xml equivalent if available. These files should reside in the same directory as their counterparts, and are only used as backup and on the first run after a clean installation (an upgrade will preserve the original files)

Syntax highlighting themes

From version 5.3, Notepad++ provides theme files, which are selectable from the Styler Configurator dialog and are alternates for stylers.xml. You can freely add new or remove existing highlight theme files from the Themes\ subfolder. While the list of available theme files is loaded at startup, you can add to it using the Settings -> Import -> Import theme feature, in version 5.5 and higher.

Other configuration files

For various languages, the autocompletion facility requires xml files. You can find many of them in <Notepad++ folder>\Plugins\APIs. You can always tailor them to your liking, or add some for user defined languages - but only one for each language, and bearing the same name.

Modifying configuration files

Generally speaking, the configuration files of an application are managed by this application, and are not supposed to be manually edited in general. Bu sometimes it is useful or needed.

Because Notepad++ updates some of its configuration files on normal program termination, manual editing of a Notepad++ configuration file requires both specific procedures and good knowledge of the files' layout. It is strongly advised to read about how to edit configuration files and the knowledge base for file layouts.