Update Readme.md

This commit is contained in:
Pairi Daiza 2020-08-15 19:59:12 +02:00 committed by GitHub
parent 0dc0f7eaf6
commit cfd3462775
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

259
Readme.md
View File

@ -60,18 +60,18 @@ As an added service for Notepad3 users; Rizonesoft uses [Telegram](https://teleg
# **Notepad3 Settings (Notepad3.ini)**
## **[`Notepad3]`**
## **`[Notepad3]`**
This section can be used to redirect to a settings file which should be used by Notepad3.
If a non elevated user is not allowed to write to the program directory of Notepad3.exe,
the side-by-side Notepad3.ini can point to a place, where the user is allowed to write his settings,
for example :
Notepad3.ini=%APPDATA%\Rizonesoft\Notepad3\Notepad3.ini
`Notepad3.ini=%APPDATA%\Rizonesoft\Notepad3\Notepad3.ini`
or a to have user specific settings:
Notepad3.ini=%WINDIR%\Notepad3-%USERNAME%.ini
`Notepad3.ini=%WINDIR%\Notepad3-%USERNAME%.ini`
## **`[Settings]`**
@ -91,37 +91,37 @@ Press Ctrl+F7 to open the Notepad3 ini-file. Most changes only take effect upon
#### `PreferredLanguageLocaleName=en-US`
The default value for the already supported languages is defined by the: “OS language setting”.
The fallback is: “en-US”.
The default value for the already supported languages is defined by the: “OS language setting”.
The fallback is: “en-US”.
##### Available languages:
```
English/United States (en-US) (internal default)
Afrikaans/South Africa (af-ZA)
Belarusian/Belarus (be-BY)
German/Germany (de-DE)
English/United Kingdom (en-GB)
Spanish/Spain (es-ES)
Spanish/Mexico (es-MX)
French/France (fr-FR)
Hindi/India (hi-IN)
Hungarian/Hungary (hu-HU)
Indonesian/Indonesia (id-ID)
Italian/Italy (it-IT)
Japanese/Japan (ja-JP)
Korean/Korea (ko-KR)
Dutch/Netherlands (nl-NL)
Polish/Poland (pl-PL)
Portuguese/Brazil (pt-BR)
Portuguese/Portugal (pt-PT)
Russian/Russia (ru/RU)
Slovak/Slovakia (sk-SK)
Swedish/Sweden (sv-SE)
Turkish/Turkey (tr-TR)
Vietnamese/Vietnam (vi-VN)
Chinese Simplified/China (zh-CN)
Chinese Traditional/Taiwan (zh-TW)
English/United States (en-US) (internal default)
Afrikaans/South Africa (af-ZA)
Belarusian/Belarus (be-BY)
German/Germany (de-DE)
English/United Kingdom (en-GB)
Spanish/Spain (es-ES)
Spanish/Mexico (es-MX)
French/France (fr-FR)
Hindi/India (hi-IN)
Hungarian/Hungary (hu-HU)
Indonesian/Indonesia (id-ID)
Italian/Italy (it-IT)
Japanese/Japan (ja-JP)
Korean/Korea (ko-KR)
Dutch/Netherlands (nl-NL)
Polish/Poland (pl-PL)
Portuguese/Brazil (pt-BR)
Portuguese/Portugal (pt-PT)
Russian/Russia (ru/RU)
Slovak/Slovakia (sk-SK)
Swedish/Sweden (sv-SE)
Turkish/Turkey (tr-TR)
Vietnamese/Vietnam (vi-VN)
Chinese Simplified/China (zh-CN)
Chinese Traditional/Taiwan (zh-TW)
```
#### `IMEInteraction=0`
@ -133,11 +133,11 @@ The default value of 2000 ms usually prevents read/write conflicts.
#### `DateTimeFormat=`
(-> <Locale dependent short format>)
(-> (Locale dependent short format)
#### `DateTimeLongFormat=`
(-> <Locale dependent long format>)
(-> (Locale dependent long format)
Specify the short/long date and time formats. This is the format parameter passed to
the `strftime()` function.
@ -146,13 +146,13 @@ Library used by Notepad3).
#### `TimeStampRegEx=`
(-> \$Date:[^\$]+\$ ) (Find-Pattern to Update Stamps)
(-> \$Date:[^\$]+\$) (Find-Pattern to Update Stamps)
#### `TimeStampFormat=`
\\$Date:[^\\$]+\\$ | $Date: %Y/%m/%d %H:%M:%S $
(-> \\$Date:[^\\$]+\\$ | $Date: %Y/%m/%d %H:%M:%S $
(-> $Date: %s $) {Print format should fit to TimeStampRegEx}
(-> $Date: %s $) (Print format should fit to TimeStampRegEx)
This parameter is used as a regex pattern to match time-stamps which will be updated to
current date-time by `Shift+F5`, e.g. `$Date: 2018/04/26 00:52:39 $`
@ -178,7 +178,9 @@ Specify the default extension for saved files (omit the leading dot, just like t
#### `DefaultWindowPosition=`
This items are managed by Notepad3.
This items are managed by Notepad3. (`Menu->View->Position->Save as Default Position`)
(Will set current window position as "Default Position" - can be recalled by `Ctrl+Shift+P` Hotkey)
#### `DenyVirtualSpaceAccess=0`
@ -194,9 +196,11 @@ need to be quadruple-quoted (""path to/file.exe""), but only double-quoted if th
additional command line arguments ("path to/file.exe" /arg).
On the other hand, our preferred file browser is MiniPath.exe (Menu->File->Browse... Ctrl+M) + Toolbar-Button.
If you don't like it, you can configure e.g. [Settings2] filebrowser.exe=Explorer++.exe (https://explorerplusplus.com/)
or [Settings2] filebrowser.exe=Q-Dir_x64+.exe (https://www.softwareok.de/?seite=Freeware/Q-Dir/).
(side-by-side Notepad3).
If you don't like it, you can configure e.g.
- [Settings2] filebrowser.exe=explorer.exe (system's file explorer), or
- [Settings2] filebrowser.exe=Explorer++.exe (https://explorerplusplus.com/) (side-by-side Notepad3), or
- [Settings2] filebrowser.exe=Q-Dir_x64+.exe (https://www.softwareok.de/?seite=Freeware/Q-Dir/) (side-by-side Notepad3)
#### `grepWin.exe=grepWinNP3.exe`
@ -242,11 +246,11 @@ Set to 1 to disable simple language detection for cgi and fcgi files.
#### `NoCopyLineOnEmptySelection=0`
NoCopyLineOnEmptySelection=1 to avoid the copy on empty selection.
NoCopyLineOnEmptySelection=1 to avoid the copy line (`Ctrl+C`) on empty selection.
#### `NoCutLineOnEmptySelection=0`
NoCutLineOnEmptySelection=1 to avoid the cut on empty selection.
NoCutLineOnEmptySelection=1 to avoid the cut line (`Ctrl+X`) on empty selection.
#### `NoFadeHidden=0`
@ -254,38 +258,38 @@ Set to 1 to disable fading of hidden objects in file lists (such as Favorites, e
#### `NoFileVariables=0`
Set to 1 to disable file variable parsing.
Set to 1 to disable file variable parsing.
Encoding tag parsing can be disabled in the Menu ? File ? Encoding ? Default dialog box.
Notepad3 can parse a few of the Emacs variables that can be used in source code files.
The first 512 bytes of a file (and, if nothing is found, also the last 512 bytes) are
checked for the following constructs (can be manually disabled in the ini-file, or
the File, Encoding, Default dialog box, respectively):
coding: utf-8;
mode: python;
tab-width: 8;
c-basic-indent: 2;
indent-tabs-mode: nil;
c-tab-always-indent: true;
fill-column: 64;
truncate-lines: false;
enable-local-variables: true;
coding: Serves as a file encoding tag. Details about using encoding tags are outlined in the
```
coding: utf-8;
mode: python;
tab-width: 8;
c-basic-indent: 2;
indent-tabs-mode: nil;
c-tab-always-indent: true;
fill-column: 64;
truncate-lines: false;
enable-local-variables: true;
```
`coding`: Serves as a file encoding tag. Details about using encoding tags are outlined in the
Notepad2 Encoding Tutorial.
mode: Indicates the syntax scheme to be used, and is either the name of a scheme, or a
`mode`: Indicates the syntax scheme to be used, and is either the name of a scheme, or a
file name extension.
tab-width:
c-basic-indent: Denote tab and indentation settings.
indent-tabs-mode: Determines whether to insert tabs as spaces (nil, false or 0)
`tab-width`:
`c-basic-indent`: Denote tab and indentation settings.
`indent-tabs-mode`: Determines whether to insert tabs as spaces (nil, false or 0)
or not (true or 1).
c-tab-always-indent: Configures whether the tab key re-formats indenting white-space
`c-tab-always-indent`: Configures whether the tab key re-formats indenting white-space
(true or 1) or not (nil, false or 0).
fill-column: Sets the desired limit for long lines (but does not automatically display
`fill-column`: Sets the desired limit for long lines (but does not automatically display
the visual marker).
truncate-lines: Controls word wrap (enable: nil, false or 0; disable: true or 1).
enable-local-variables: Disables file variable parsing (nil, false or 0), but keeps
`truncate-lines`: Controls word wrap (enable: nil, false or 0; disable: true or 1).
`enable-local-variables`: Disables file variable parsing (nil, false or 0), but keeps
evaluating encoding tags.
To bypass both file variable and encoding tag parsing, reload the file with Alt+F8.
@ -319,7 +323,8 @@ saved with relative path-names. The default is 1 (enabled).
#### `ReuseWindow=0`
This items are managed by Notepad3.
This items are managed by Notepad3. (`Menu->Settings->Window->Reuse Window Ctrl+Shift+L`)
If set, another started Notepad3 instance will try to give control to the currently opened Window and quit.
#### `SciFontQuality=3`
@ -350,7 +355,8 @@ See Replacing Windows Notepad for detailed explanations.
#### `StickyWindowPosition=0`
This items are managed by Notepad3.
This items are managed by Notepad3. (`Menu->View->Position->Sticky Window Position`)
(Will remember current window position on restart, instead of last closed position (save on exit))
#### `UseOldStyleBraceMatching=0`
@ -362,7 +368,7 @@ UseOldStyleBraceMatching=1 to switch back to (not recommended) old style behavio
#### `ExtendedWhiteSpaceChars=:`
Put in here all ASCII chars which should be word delimiter in case of "Accelerated Word Navigation".
Put in here all ASCII chars which should be word delimiter in case of "Accelerated Word Navigation".
#### `AutoCompleteWordCharSet=`
@ -405,7 +411,8 @@ Confidence/Reliability level for reliability switch in encoding dialog.
#### `LocaleAnsiCodePageAnalysisBonus=33`
Confidence/Reliability for the ANSI Code-Page Bonus
Bias/Bonus on top of Confidence/Reliability if current system's ANSI Code-Page is file encoding analysis result.
(This will push detection algorithm to like system's ANSI Code-Page more than other detection result)
#### `LexerSQLNumberSignAsComment=1`
@ -419,17 +426,17 @@ Ed.: The default is "OFF", it is set to "ON" explicitly in Notepad3 (hard coded)
The leveling of ESC behavior (msg-boxes -> selection -> exit) leads to following implementation:
New parameter "[Settings2] ExitOnESCSkipLevel = 2"
Level 2 : ESC cancels every single state separately (the default)
Level 1 : ESC cancels message-box and ignores Selection (what you want?)
Level 0 : ESC cancels all states and proceeds to Exit (if configured)
Level 2 : ESC cancels every single state separately (the default).
Level 1 : ESC cancels message-box and ignores Selection.
Level 0 : ESC cancels all states and proceeds to Exit (if configured).
#### `ZoomTooltipTimeout=3200`
A value of zero (0) (or less than 100 ms) will disable the Tooltip display.
A value of zero (0) (or less than 100 ms) will disable the Tooltip display.
#### `LargeIconScalePrecent=150`
Percent threshold to switch to bigger file types icons (lexer style selections)
`Screen/Display Scale Percent` threshold to switch to bigger file types icons (lexer style selections)
## **`[Statusbar Settings]`**
@ -442,43 +449,43 @@ and the prefix text of the status bar fields.
This parameter is used to define, which fields of the Status Bar should be visible.
If used, this setting also defines the field ordering.
- Section 0 = Ln : Line number of Caret position / Number total of lines in the file
- Section 1 = Col : Column number of Caret position / Limit for Long Line settings
- Section 2 = Sel : Number of characters selected
- Section 3 = Sb : Number of bytes (Bytes in [UTF-8]) selected
- Section 4 = SLn : Number of selected lines
- Section 5 = Occ : Number of Marked Occurrences
(to display more than 2000 occurrences changes this parameter in the ini file
`[Setting2]MarkOccurrencesMaxCount=2000`)
- Section 6 = Size of file in [UTF-8] Mode
- Section 7 = Encoding Mode (double click to open `Encoding F9` )
- Section 8 = EOL Mode (Toggle CR+LF, LF, CR)
- Section 9 = Toggle INS/OVR Mode
- Section 10 = Toggle STD/2ND Text Mode (Default Text or 2nd Default Text)
- Section 11 = Current Scheme (double click to open `Select Scheme` )
- Section 12 = Character Count (per line)
- Section 13 = Replaced Occurrences
- Section 14 = TinyExpr Evaluation
- Section 0 = Ln : Line number of Caret position / Number total of lines in the file
- Section 1 = Col : Column number of Caret position / Limit for Long Line settings
- Section 2 = Sel : Number of characters selected
- Section 3 = Sb : Number of bytes (Bytes in [UTF-8]) selected
- Section 4 = SLn : Number of selected lines
- Section 5 = Occ : Number of Marked Occurrences
(to display more than 2000 occurrences changes this parameter in the ini file
`[Setting2]MarkOccurrencesMaxCount=2000`)
- Section 6 = Size of file in [UTF-8] Mode
- Section 7 = Encoding Mode (double click to open `Encoding F9` )
- Section 8 = EOL Mode (Toggle CR+LF, LF, CR)
- Section 9 = Toggle INS/OVR Mode
- Section 10 = Toggle STD/2ND Text Mode (Default Text or 2nd Default Text)
- Section 11 = Current Scheme (double click to open `Select Scheme` )
- Section 12 = Character Count (per line)
- Section 13 = Replaced Occurrences
- Section 14 = TinyExpr Evaluation
#### `SectionPrefixes=Ln ,Col ,Sel ,Sb ,SLn ,Occ ,,,,,,,Ch ,Repl ,Eval ,` (internal default)
This parameter is used to redefines the displayed Prefixes in the sections of the Status Bar
A “,” (comma) is used as separator. Spaces are NOT ignored.
This parameter is used to redefines the displayed Prefixes in the sections of the Status Bar
A “,” (comma) is used as separator. Spaces are NOT ignored.
#### `SectionPostfixes=,,,,,,,,,,,,,,,` (internal default)
This parameter is used to redefines the displayed Postfixes in the sections of the Status Bar
A “,” (comma) is used as separator. Spaces are **NOT** ignored.
A “,” (comma) is used as separator. Spaces are **NOT** ignored.
#### `SectionWidthSpecs=30 20 20 20 20 20 0 0 0 0 0 0 20 20 20` (internal default)
This parameter is used to define the relative width of each field of the Status Bar
0 = space optimized fit to text (dynamically adapted to width changes)
-n (neg. val) = fixed width of section [pix] , longer text is truncated
0 = space optimized fit to text (dynamically adapted to width changes)
-n (neg. val) = fixed width of section [pix] , longer text is truncated
Fine tuning: increase, decrease or modify the value of numbers, e.g.:
`;;;;;;;;;;;;;;;;; 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14`
`SectionWidthSpecs=50 40 42 40 36 40 0 0 0 0 0 -10 40 40 -40`
`;;;;;;;;;;;;;;;;; 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14`
`SectionWidthSpecs=50 40 42 40 36 40 0 0 0 0 0 -10 40 40 -40`
#### `ZeroBasedColumnIndex=0`
@ -493,35 +500,37 @@ This parameter is used to define start counting of characters (of current line)
This section offers the possibility to display the name of the function to the right of its corresponding icon.
01=New
02=Open
03=Browse
04=Save
05=Undo
06=Redo
07=Cut
08=Copy
09=Paste
10=Find
11=Replace
12=Word Wrap
13=Zoom In
14=Zoom Out
15=Scheme
16=Customize Schemes
17=Exit
18=Save As
19=Save Copy
20=Delete
21=Print
22=Favorites
23=Add to Favorites
24=Toggle Folds
25=Execute Document
26=Focused View
27=Monitoring Log
28=History
29=Always On Top
30=Search in Files
```
01=New
02=Open
03=Browse
04=Save
05=Undo
06=Redo
07=Cut
08=Copy
09=Paste
10=Find
11=Replace
12=Word Wrap
13=Zoom In
14=Zoom Out
15=Scheme
16=Customize Schemes
17=Exit
18=Save As
19=Save Copy
20=Delete
21=Print
22=Favorites
23=Add to Favorites
24=Toggle Folds
25=Execute Document
26=Focused View
27=Monitoring Log
28=History
29=Always On Top
30=Search in Files
```
<hr/>