Skip to content

Commit b2b594e

Browse files
committed
Add reasonable instructions for uprgrading a Portable edition
1 parent 62cb12e commit b2b594e

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

content/docs/upgrading.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ Using the **? > Update Notepad++** menu command. This will check whether there i
1515
## Upgrade Manually
1616
Going to the main website and downloading the latest installer and running it yourself. You can watch the [Announcements](https://community.notepad-plus-plus.org/category/1/announcements) category in the [Notepad++ Community Forum](https://community.notepad-plus-plus.org/) to see when new release-candidates or final versions are released.
1717

18-
## Download Zip Package
19-
Going to the main website and downloading the latest zipped archive. You can then use it as a separate portable version, or compare its files to another installed or portable version, so you can decide how and when to upgrade.
20-
2118
## No New Version Found: Safety Delay
2219
There are two reasons that would cause there to be no new version found during an auto-triggered upgrade check or an on-demand upgrade check:
2320

@@ -29,3 +26,41 @@ The safety delay will never prevent you from downloading the installer or portab
2926

3027
## WinGUp Project
3128
The [WinGUp](http://wingup.org/) project was started for the need of Notepad++ for upgrading Notepad++ automatically. It has since become a more generic solution for updating purposes. [This project has been forked](https://github.com/notepad-plus-plus/wingup) for more Notepad++ specific need so Plugin Admin can share its basic functionalities.
29+
30+
## Download Zip Package
31+
Going to the main website and downloading the latest zipped archive. You can then use it as a separate portable version (which isn't technically upgrading, but will allow to try out a new version before upgrading), or compare its files to another installed or portable version, so you can decide how and when to upgrade.
32+
33+
### Upgrading a Portable Edition
34+
35+
If you have a portable edition of Notepad++, unzipping the contents from the new zipfile into your old directory will overwrite some of your configuration files, including `config.xml`, which will mean you will lose your customized settings. A recommended workflow for upgrading a portable edition (with dummy directories; you can choose whatever directories are convenient):
36+
37+
1. Starting condition:
38+
- Your original installation is in `c:\PortableNpp\`
39+
- You have the ComparePlus plugin, or otherwise understand how to compare contents of similar files
40+
- You have read and understood the [Online UserManual section on Editing Configuration Files](https://npp-user-manual.org/docs/config-files/#editing-configuration-files)
41+
- Make sure you have recently exited Notepad++ and restarted it, without having made any configuration changes in the GUI since restarting it, as per "Editing Configuration Files".
42+
2. Unzip the new portable zipfile into `c:\PortableNpp.new\`
43+
3. Compare each of the following configuration files. Look for any settings that are in the New but not in the Old, and copy them over.
44+
- **Optional**: For some, the updates in the configuration files usually just give access to new features which you might not care about (like a new right-click menu action); in that case, it is up to you to decide whether you want to bring over the new features or not.
45+
- **Overwrite**: For these configuration files, users rarely customize them. Unless you know that you have, it's generally safe to just overwrite it with the new copy.
46+
- **Model**: For these configuration files, you will be comparing your raw file with the new `.model.` version. These are files that are often customized, so when you are comparing, you will want to be careful to bring over the new features (things that are in the new `.model.`) without getting rid of your customizations.
47+
48+
| Old (`c:\PortableNpp\...`) | New (`c:\PortableNpp.new\...`) | Notes |
49+
|-----|-----|-------|
50+
| `...\config.xml` | `...\config.xml` | |
51+
| `...\contextMenu.xml` | `...\contextMenu.xml` | Optional |
52+
| `...\shortcuts.xml` | `...\shortcuts.xml` | Optional |
53+
| `...\toolbarIcons.xml` | `...\toolbarIcons.xml` | Optional |
54+
| `...\langs.xml` | `...\langs.model.xml` | Model |
55+
| `...\stylers.xml` | `...\stylers.model.xml` | Model |
56+
| `...\themes\___.xml` | `...\themes\____.xml` | Overwrite ¹ |
57+
| `...\autoCompletion\___.xml` | `...\autoCompletion\____.xml` | Overwrite |
58+
| `...\localization\___.xml` | `...\localization\____.xml` | Overwrite |
59+
| `...\functionList\___.xml` | `...\functionList\____.xml` | Overwrite |
60+
| `...\userDefineLangs\___.xml` | `...\userDefineLangs\____.xml` | Overwrite |
61+
62+
- ¹: If you are using a specific theme, it's more likely that you will have customized that theme's file. Please do a full comparison on that theme file, but you can probably get away with just overwriting the old theme files.
63+
64+
4. After updating the config files, then you can exit Notepad++, copy the `notepad++.exe` and `plugins\config\nppPluginList.dll` from the old to the new, and restart Notepad++ to start using your upgraded portable edition.
65+
66+
_Note: a similar procedure can be used when you think your installed copy of Notepad++ has themes or syntax highlighting configuration that is missing compared to a fresh install or portable, except you would use `%AppData%\Notepad++\____.xml` and/or `C:\Program Files\Notepad++\____.xml` as the **Old** location, instead of a portable location._

0 commit comments

Comments
 (0)