Skip to content

Commit b648695

Browse files
KrazalKrazal
committed
Update ReadMe for WebEdit v2.8 with new features
The ReadMe.txt file has been updated to document the new features and enhancements introduced in WebEdit v2.8, including: - Support for 64-bit Notepad++ and compatibility updates. - New tag escape sequences: `\u` (Windows user name) and `\d:"format"` (local date/time with optional format). - Examples for using new tags in `WebEdit.ini`. - Usability improvements (Unicode handling, caret placement, etc.). - Backward compatibility with existing `WebEdit.ini` files. A "CREDITS" section has been added, detailing the plugin's history, contributors, and current maintenance. Legacy documentation for WebEdit v2.1 (32-bit) has been preserved verbatim, with minor formatting adjustments for clarity.
1 parent 303e515 commit b648695

2 files changed

Lines changed: 44 additions & 44 deletions

File tree

‎ReadMe.txt‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,44 @@
1+
WebEdit v2.8 - current (64-bit compatible) — New features overview
2+
3+
Note: This file contains two sections. The first section documents the current WebEdit v2.8 enhancements (added to the modern, 64-bit-capable plugin). The second section contains the original, unchanged legacy documentation for WebEdit v2.1 (32‑bit). The legacy section is preserved verbatim for historical/reference purposes.
4+
5+
v2.8 — New features (examples)
6+
- 64-bit Notepad++ support and compatibility updates for modern Notepad++ builds.
7+
- New tag escape sequences for dynamic insertion:
8+
- \u
9+
- Replaced with the current Windows user name (the user account running Notepad++).
10+
- Example tag line in `WebEdit.ini`:
11+
user=Author: \u|
12+
- \d:"format"
13+
- Replaced with the local date/time. An optional .NET-style date/time format string may be supplied in quotes.
14+
- Examples:
15+
- `datetime=Created: \d:"yyyy-MM-dd HH:mm:ss"` → inserts date/time in 24h ISO-like format.
16+
- Small usability improvements:
17+
- Better handling of Unicode and long replacements.
18+
- Improved behavior for caret placement after tag replacement e.g. when multiple pipe characters are present.
19+
- Backwards-compatible with existing `WebEdit.ini` files.
20+
21+
Notes on using the new tags
22+
- Place the tag definitions in the `[Tags]` section of your `WebEdit.ini` file the same way as before. The new escape sequences behave the same as existing escapes (they are expanded inside Replacement text).
23+
- Examples to add to `WebEdit.ini`:
24+
- `user=Author: \u|`
25+
- `now=Date/Time: \d:"yyyy-MM-dd HH:mm:ss"`
26+
- `árv=Árvíztűrő tükörfúrógép` (Hungarian pangram with accented characters)
27+
- If you rely on the legacy 32-bit plugin, see the legacy documentation below. The legacy plugin (v2.1) may be unchanged and is documented verbatim in the section that follows.
28+
29+
CREDITS
30+
-------
31+
This small freeware plugin allows you to wrap the selected text in tag pairs and expand abbreviations using a hotkey.
32+
For more information visit https://github.com/Krazal/WebEdit
33+
34+
Created by Alexander Iljin (Amadeus IT Solutions) using XDS Oberon, March 2008 - March 2010.
35+
Ported to C# by Miguel Febres, April 2021.
36+
Ported to .NET 8 by Robert Di Pardo, February 2025.
37+
Currently maintained by Richard Stockinger, September 2025.
38+
39+
----------------------------------------------------------------------
40+
Legacy documentation (unchanged) — WebEdit v2.1 - freeware open-source plugin for 32-bit Notepad++ ANSI/Unicode.
41+
142
WebEdit v2.1 - freeware open-source plugin for 32-bit Notepad++ ANSI/Unicode.
243

344
INTRODUCTION
@@ -106,7 +147,7 @@ Slot numbers are 1..30. The bitmap file should be placed in the plugins/Config
106147
folder and should contain a bitmap image suitable for the toolbar.
107148

108149
To display custom toolbar buttons Notepad++ should be configured to use "Small
109-
standard icons" (it is by default). To find this option go to the "Settings -
150+
standard icons" (it is by default). To find this option go to the "Settings -
110151
Preferences..." menu, and in the "Global" tab look for the "Tool bar" group.
111152

112153
The "[Tags]" section format:

‎WebEdit/ReadMe.txt‎

Lines changed: 2 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,4 @@
1-
WebEdit v2.8 - current (64-bit compatible) — New features overview
2-
3-
Note: This file contains two sections. The first section documents the current WebEdit v2.8 enhancements (added to the modern, 64-bit-capable plugin). The second section contains the original, unchanged legacy documentation for WebEdit v2.1 (32‑bit). The legacy section is preserved verbatim for historical/reference purposes.
4-
5-
v2.8 — New features (examples)
6-
- 64-bit Notepad++ support and compatibility updates for modern Notepad++ builds.
7-
- New tag escape sequences for dynamic insertion:
8-
- \u
9-
- Replaced with the current Windows user name (the user account running Notepad++).
10-
- Example tag line in `WebEdit.ini`:
11-
user=Author: \u|
12-
- \d:"format"
13-
- Replaced with the local date/time. An optional .NET-style date/time format string may be supplied in quotes.
14-
- Examples:
15-
- `datetime=Created: \d:"yyyy-MM-dd HH:mm:ss"` → inserts date/time in 24h ISO-like format.
16-
- Small usability improvements:
17-
- Better handling of Unicode and long replacements.
18-
- Improved behavior for caret placement after tag replacement e.g. when multiple pipe characters are present.
19-
- Backwards-compatible with existing `WebEdit.ini` files.
20-
21-
Notes on using the new tags
22-
- Place the tag definitions in the `[Tags]` section of your `WebEdit.ini` file the same way as before. The new escape sequences behave the same as existing escapes (they are expanded inside Replacement text).
23-
- Examples to add to `WebEdit.ini`:
24-
- `user=Author: \u|`
25-
- `now=Date/Time: \d:"yyyy-MM-dd HH:mm:ss"`
26-
- `árv=Árvíztűrő tükörfúrógép` (Hungarian pangram with accented characters)
27-
- If you rely on the legacy 32-bit plugin, see the legacy documentation below. The legacy plugin (v2.1) may be unchanged and is documented verbatim in the section that follows.
28-
29-
CREDITS
30-
-------
31-
This small freeware plugin allows you to wrap the selected text in tag pairs and expand abbreviations using a hotkey.
32-
For more information visit https://github.com/Krazal/WebEdit
33-
34-
Created by Alexander Iljin (Amadeus IT Solutions) using XDS Oberon, March 2008 - March 2010.
35-
Ported to C# by Miguel Febres, April 2021.
36-
Ported to .NET 8 by Robert Di Pardo, February 2025.
37-
Currently maintained by Richard Stockinger, September 2025.
38-
39-
----------------------------------------------------------------------
40-
Legacy documentation (unchanged) — WebEdit v2.1 - freeware open-source plugin for 32-bit Notepad++ ANSI/Unicode.
41-
42-
WebEdit v2.1 - freeware open-source plugin for 32-bit Notepad++ ANSI/Unicode.
1+
WebEdit v2.1 - freeware open-source plugin for 32-bit Notepad++ ANSI/Unicode.
432

443
INTRODUCTION
454

@@ -147,7 +106,7 @@ Slot numbers are 1..30. The bitmap file should be placed in the plugins/Config
147106
folder and should contain a bitmap image suitable for the toolbar.
148107

149108
To display custom toolbar buttons Notepad++ should be configured to use "Small
150-
standard icons" (it is by default). To find this option go to the "Settings -
109+
standard icons" (it is by default). To find this option go to the "Settings -
151110
Preferences..." menu, and in the "Global" tab look for the "Tool bar" group.
152111

153112
The "[Tags]" section format:

0 commit comments

Comments
 (0)