Skip to content

Commit 1f6e220

Browse files
committed
- describe nppLogNetworkDriveIssue.xml from v8.1.9.3 (closes #539)
- describe `v852NoNeedShortcutsBackup.xml` and `shortcuts.xml.v8.5.2.backup` from v8.5.3
1 parent d1bdebf commit 1f6e220

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

content/docs/config-files.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,20 @@ NPP_FULL_FILE_PATH | the full path to the `notepad++.exe` | `c:\Program Files\n
216216

217217
If you want access to a Windows environment variable (like `TMP`), use the standard `%`-notation for windows variables (like `%TMP%`).
218218

219+
### v8.5.3 `shortcuts.xml` updates
220+
221+
In Notepad++ v8.5.2 and earlier, if you had a "special character" in your macro or run-menu command -- whether it was in the name of the macro/command or in text that it uses -- then inside the XML, it would be stored as an XML entity. For example, `` would be stored as `☺` or `π` as `π` .
222+
223+
In Notepad++ v8.5.3, it changed to storing those characters as actual UTF-8 encoded characters, and it treats nearly all entities as raw text. Thus, `π` is interpreted by v8.5.3 (and newer) as 8 characters, not an entity-representation of the underlying character.
224+
225+
There are still a small number of entities that _will_ be recognized inside macros, even in v8.5.3 and newer:
226+
227+
* The 5 predefined XML named-entities: `& < > ' "`
228+
229+
* Any of the hexadecimal entities that only include two hex digits, like `
` and `
` for `CR` and `LF`, and `"` for double-quotes. This notation works for all ASCII codepoints from 1 (`` for the `SOH` character) through 127 (`` for the `DEL` character)
230+
231+
This change in interpretation may make it so your old macros or run-menu commands don't work as expected. You can follow the instructions in the [Notepad++ Community Forum FAQ entry](https://community.notepad-plus-plus.org/topic/24464/faq-desk-v8-5-3-and-newer-macros-and-run-menu-commands) to see how to update your `shortcuts.xml` to be compatible with Notepad++ v8.5.3 and newer.
232+
219233
## User Interface settings: `config.xml`
220234

221235
The following sections are defined:
@@ -438,10 +452,24 @@ You can have multiple icon set directories; to switch between icon sets, you jus
438452

439453
- `nppLogNulContentCorruptionIssue.xml`: This is a zero-byte file that allows Notepad++ to write a logfile to `%AppData%\Notepad++\nppLogNulContentCorruptionIssue.log` in the case of certain crashes, which can help the developers debug issues resulting from the crash. If you want to prohibit that logfile from being created, delete this config file; but that will mean that you will not be able to provide the useful information to the developers if a crash causes issues for you; delete at your own risk. This config file _must_ go in the Notepad++ installation folder; it will not be recognized in the `%AppData%\Notepad++` hierarchy or in the cloud settings folder. (New to v8.1.9.3.)
440454

455+
- `nppLogNetworkDriveIssue.xml`: This is a zero-byte file that allows Notepad++ to write a logfile to `c:\temp\nppLogNetworkDriveIssue.log` in the case of certain network drive issues. (New to v8.1.9.3.)
456+
- This should be used if you are getting "This file has been modified by another program" when dealing with network drives (like a Samba server, or other filesystems access by `\\machinename\path\`).
457+
- Create this zero-byte file either next to `notepad++.exe` or in the `%AppData%\Notepad++` directory.
458+
- Create directory `c:\temp\` if it doesn't exist.
459+
- Start `notepad++.exe`, and wait until you get the file status (timestamp) detection error from the network drive.
460+
- If the errors occur, there should be some trace in "C:\temp\nppLogNetworkDriveIssue.log".
461+
- This log can be shared with the developers to help them improve Notepad++'s network handling (create an issue [here](https://github.com/notepad-plus-plus/notepad-plus-plus/issues) and attach the logfile along with your other details).
462+
441463
- `session.xml`: Stores the current [session](../session/) information. Overwritten on every exit of Notepad++ if [**Settings > Preferences > Backup > Remember current session for next launch**](../preferences/#backup) is enabled. If you want sessions that you control, use **File > Save Session...** to save it; the file is safe to edit; and you can reload that session at any time using **File > Load Session...**. This config file _must_ go in the Notepad++ installation folder; it will not be recognized in the `%AppData%\Notepad++` hierarchy or in the cloud settings folder.
442464

443465
- `userDefineLang.xml` and `userDefineLangs\*.xml`: Configuration location for the [**User Defined Languages**](../user-defined-language-system/) feature.
444466

467+
- `v852NoNeedShortcutsBackup.xml`: Tracks whether your macros definitions in `shortcuts.xml` have been updated per the v8.5.3 rules
468+
- This file is created the first time you save a recorded macro after upgrading from Notepad++ v8.5.2 (or older) to Notepad++ v8.5.3 (or newer)
469+
- When this file is created, it will also create `shortcuts.xml.v8.5.2.backup`
470+
- After this file is created, Notepad++ won't check any more whether `shortcuts.xml` has been updated
471+
- See [v8.5.3 `shortcuts.xml` updates](#v8-5-3-shortcuts-xml-updates) (above) and this Notepad++ Community [FAQ entry](https://community.notepad-plus-plus.org/topic/24464/faq-desk-v8-5-3-and-newer-macros-and-run-menu-commands) for more details
472+
445473
## Validating Config-File XML
446474

447475
If you are developing a config file by editing the raw XML file and would like to be able to validate that you have correct XML syntax while you are doing so, you can see the instructions in the [Notepad++ Community "Validating Config-File XML" FAQ](https://community.notepad-plus-plus.org/topic/24136/faq-desk-validating-config-file-xml "Community Forum FAQ Desk: Validating Config-File XML).

0 commit comments

Comments
 (0)