FAQ: Themes in v8.8.9

PeterJones

With the release of v8.8.9, there is a new feature which automatically updates the active Theme if it is missing Style Configurator settings for any GUI elements, or missing any Languages or any Style entries in existing Languages. This is a long-needed feature, so that as Notepad++ adds new styles for the Style Configurator, you’ll be able to set them, even if your theme hasn’t been updated since before those styles were added. (Before now, if you switched to a theme years ago and set any custom color or user keyword or custom file extensions for a built-in language, it would never update the theme, no matter how many times you update Notepad++ in the meanwhile. This v8.8.9 feature is able to correct that issue, and you will be able to use the Style Configurator to set the colors of any new styles going forward, as soon as you upgrade to a Notepad++ executable that supports the new style.)

Unfortunately, the v8.8.9 implementation included some annoying growing pains: the procedure always uses the same colors that those styles have in the stylers.model.xml file (ie, the default “light mode” colors), even if you are using a dark theme, which can make for glaring color issues: on Languages that get new styles added, the text that should be that new style can end up as black-on-white text, even if the rest of the text has a dark background; and if the theme was old enough, some GUI elements (like the Bookmark margin and Change History margin, between the line numbers and the text being edited) may clash with the surrounding GUI elements.

In the future v8.9 this issue will be fixed, so people who had an older theme and use v8.9 will see new styles show up using the default foreground and background colors of that theme, so they won’t clash: it might not highlight the new keywords, for example, but at least it won’t look worse than it used to.

But unfortunately, once you run it in v8.8.9, your theme will no longer have those entries “missing”, and the glaring white background will be saved. The instructions below will help you with that:

Download Source

For now, I have supplied updated copies of all the v8.8.9 themes in my copy of the Notepad++ codebase: https://github.com/pryrt/notepad-plus-plus/tree/themesPost889/PowerEditor/installer/themes. (Eventually, this FAQ will be updated to point to the main application repository instead, but it is important enough to get this FAQ published that I am not waiting until the updated Themes are merged into the main codebase.) At that page, you can click on any of the themes you want, and then hit the ⤓ “Download raw file” button to download it. Then follow the appropriate instructions above, to put it in the right place.

Update Themes in Installation Directory

Assuming you have a normal installation of Notepad++ (using the c:\program files\Notepad++ directory), and you haven’t made any customizations to your Theme(s), you can just manually replace the Theme(s) in the Installation directory

Exit Notepad++
Go to the URL mentioned in the Download Source section (above), and download the raw version of your Theme file(s)
Use Explorer to go to c:\program files\Notepad++\themes\ directory
Copy the downloaded Theme(s) into that directory, overwriting what’s there
When you run Notepad++ next time, it will use the updated theme, and the glaring color issues should be gone.

If you have customized your theme with user-keywords or user-extensions, then this won’t be sufficient, because Notepad++

Update Themes in AppData or Cloud Directory

If you have customized your Theme – changed the font, or changed a color, or added User-defined keywords to a Language’s style, or added User extensions to the Language in the Style Configurator – then just replacing the theme in the installation directory won’t be sufficient.

Exit Notepad++
If you haven’t already, go to the URL mentioned in the Download Source section (above), and download the raw version of your Theme file(s)
Use Explorer to go to %AppData%\Notepad++\ (🛈) or to wherever your Cloud Directory or -settingsDir option point to
There should be a themes subdiretory in that directory, if you have customized your Theme.
Rename your old custom theme to <themeName>_OLD.xml (like khaki.xml becomes khaki_OLD.xml)
Copy the downloaded version of the Theme into that directory (for example, khaki.xml)
Start Notepad++. It will use the updated version of the theme, but your customizations will be temporarily missing.
Open %AppData%\Notepad++\themes\<themeName>.xml and %AppData%\Notepad++\themes\<themeName>_OLD.xml
In the _OLD copy, search for ext="(?!") in Regular Expression mode. The value between the quotes will be the user-extensions for that language. Copy any that you find in the OLD file to the language’s equivalent entry in <themeName>.xml
In the _OLD copy, search for (?<!>)</WordsStyle> in Regular Expression mode. Any values between the > and the </WordsStyle> should be copied to the equivalent location in the <themeName>.xml file. If <themeName>.xml just has <WordsStyle name="..." ... /> without having a </WordsStyle> closer, you can replace the /> with a > and the list of keywords, then the closing </WordsStyle>
Save <themeName>.xml
Exit Notepad++
When you run Notepad++ again, it should now include your customizations again.

Native Feature compared to ConfigUpdater plugin

The ConfigUpdater plugin was introduced as a testbed for some of the ideas that made it into the v8.8.9 native implementation. As such, if you are in v8.8.9 or newer, you no longer need the ConfigUpdater plugin. But if you are before v8.8.9, and waiting for the v8.9 fix to the Notepad++ feature before upgrading, then using ConfigUpdater while in v8.8.8-or-older will help you get to a point where if you did upgrade to v8.8.9, it wouldn’t make the glaring UI clash and black-on-white text in dark themes.