Skip to content

Commit 9015329

Browse files
committed
Improve internal consistency
- use checked/unchecked/disabled as the state of checkmarks - use "color" except when directly quoting Notepad++ UI (Notepad++ itself is inconsistent with its usage: Style Configurator has examples of both spellings. So this seemed the a reasonable compromise.) close #402
1 parent 1a960cb commit 9015329

File tree

9 files changed

+294
-294
lines changed

9 files changed

+294
-294
lines changed

content/docs/auto-completion.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ Different from function and word completion which can be triggered automatically
3737

3838
### Automatic completion
3939

40-
The completion list can be triggered automatically as you type, via settings in [**Settings > Preferences > Auto-Completion**](../preferences/#auto-completion): Auto-Completion is enabled by a checkbox. Additionally there is a setting **From X th character**, accepting a the minimum length of a prefix needed before the completion list is shown (some people like 2, some 3, some 4...); and, there is a setting to specify which candidates should be used: words, functions, or both.
40+
The completion list can be triggered automatically as you type, via settings in [**Settings > Preferences > Auto-Completion**](../preferences/#auto-completion): Auto-Completion is controlled by a checkbox. Additionally there is a setting **From X th character**, accepting a the minimum length of a prefix needed before the completion list is shown (some people like 2, some 3, some 4...); and, there is a setting to specify which candidates should be used: words, functions, or both.
4141

42-
With auto-completion enabled, after typing a prefix of at least the minimum length, a list is presented with all the available words from the selected list(s) that match what's been typed. (If none match, no list is shown.) The list may be a single entry long, or it may contain multiple items which require navigation, but either way you can select the match and, it is hoped, save yourself some typing. You can use arrow keys (or the mouse) to navigate through the entries in the popup; hitting the completion key or double-clicking on the choice will select that choice and enter it as if you had just typed the whole word; hitting the `Esc` key will exit the auto-completion popup _without_ choosing one of the suggestions.
42+
With auto-completion active, after typing a prefix of at least the minimum length, a list is presented with all the available words from the selected list(s) that match what's been typed. (If none match, no list is shown.) The list may be a single entry long, or it may contain multiple items which require navigation, but either way you can select the match and, it is hoped, save yourself some typing. You can use arrow keys (or the mouse) to navigate through the entries in the popup; hitting the completion key or double-clicking on the choice will select that choice and enter it as if you had just typed the whole word; hitting the `Esc` key will exit the auto-completion popup _without_ choosing one of the suggestions.
4343

4444
If instead of selecting, you keep typing, items that no longer match will be removed from the list, and it will disappear entirely once you've typed a string that matches none of the selections. (Note that if you dismiss the list with Esc, and then keep typing, and what you type continues to match wordlist entries, then the list will reappear.)
4545

@@ -61,7 +61,7 @@ Through [**Settings > Preferences > Auto-Completion**](../preferences/#auto-comp
6161

6262
In each case, when the opening character is typed, the closing character will automatically be inserted, with the caret placed between the two.
6363

64-
Additionally, Auto-Insert supports automatic HTML & XML tag closure. With this enabled, when editing HTML or XML files, after you type an opening tag, such as `<div>`, the program will automatically match it with the closing `</div>`, with the caret placed between the two tags so that content can be added. Matching will work even if attributes are entered while typing the opening tag. And if the opening tag is terminated with a slash (`/`) —such as `<hr/>` —then no matching tag is inserted. (In the case of `<hr>` entered without a slash, a matching close tag will still be inserted, even if unnecessary, for both HTML and XML editing. Consider this a push towards XML correctness in your HTML code.)
64+
Additionally, Auto-Insert supports automatic HTML & XML tag closure. With this feature active, when editing HTML or XML files, after you type an opening tag, such as `<div>`, the program will automatically match it with the closing `</div>`, with the caret placed between the two tags so that content can be added. Matching will work even if attributes are entered while typing the opening tag. And if the opening tag is terminated with a slash (`/`) —such as `<hr/>` —then no matching tag is inserted. (In the case of `<hr>` entered without a slash, a matching close tag will still be inserted, even if unnecessary, for both HTML and XML editing. Consider this a push towards XML correctness in your HTML code.)
6565

6666
### Displayed Completion List
6767

@@ -77,7 +77,7 @@ The keyboard shortcuts for manual completion can be adjusted in [**Settings > Sh
7777

7878
Notepad++ uses XML configuration files to define the per-language function and parameter auto-completion. Those AutoComplete files are located in the `autoCompletion` subdirectory of the Notepad++ install folder. (In older versions, Notepad++ v7.6.1 and earlier, they were found in the `plugins\APIs` subdirectory of the intstall folder.)
7979

80-
The syntax of AutoComplete files is simple, but does have a few rules, most importantly correct syntax and proper sorting. If the syntax is incorrect, the XML file will fail to load and AutoComplete will be disabled.
80+
The syntax of AutoComplete files is simple, but does have a few rules, most importantly correct syntax and proper sorting. If the syntax is incorrect, the XML file will fail to load and AutoComplete will be not be available for that file type.
8181

8282
Improper sorting (see below) can cause the AutoComplete function to behave erratic, causing it to fail on certain words.
8383

content/docs/config-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ You can have multiple icon set directories; to switch between icon sets, you jus
383383

384384
- `doLocalConf.xml`: This is a zero-byte file that is used as an indicator to `notepad++.exe` to not go looking for `%AppData%`. This will only exist on local installations of Notepad++ (when you tell the installer to not use `%AppData%`, or when you install from the zipfile, or when you manually create the zero-byte file). 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.
385385

386-
- `enableSelectFgColor.xml`: This is a zero-byte file that is just used as an indicator to the [**Settings > Style Configurator > Global Styles > Selected text colour**](../preferences/#global-styles) to honor the foreground color, not just the background color. 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. (Available on v8.0.0 and newer.)
386+
- `enableSelectFgColor.xml`: This is a zero-byte file that is just used as an indicator to the [**Settings > Style Configurator > Global Styles > Selected text color**](../preferences/#global-styles) to honor the foreground color, not just the background color. 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. (Available on v8.0.0 and newer.)
387387

388388
- `nativeLang.xml`: If you make a selection in the [**Settings > Preferences > General > Localization**](../preferences/#general), Notepad++ will copy the appropriate `localization\*.xml` to `nativeLang.xml`.
389389

content/docs/editing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Aside from the normal undo/redo/copy/paste entries, there are a number of sub-me
100100
* NOTE: Sorting is performed with the assumption that all line-endings in the file are uniform and match the current selection for the file being edited -- the quickest way to check that selection is to glance at the status bar, where the current line-ending type is shown either as `Windows (CR LF)`, `Unix (LF)` or `Macintosh (CR)`. It might be desirable to check the line-ending types in your file before executing a sorting operation, and use the `Edit > EOL Conversion >` choices or right-click on the Status Bar's EOL indicator to fix the line endings if necessary.
101101
* NOTE: If a [Column Mode](./#column-mode-column-editor) selection is active, the sort will re-order all the lines included in the selection, but the sort key (the text that decides the sort order) will be limited to what is inside the column selection. If the keys are identical on two lines, then the order of those two lines will not change (even if text outside of the selected key columns is different).
102102
* `Comment/Uncomment >` ⇒ submenu with actions that add or remove comment syntax, based on the file's **Language** selection. This makes use of the `commentLine`, `commentStart`, and `commentEnd` attributes of the active Language as defined in [langs.xml](../config-files/#keyword-lists-langsxml) to define the characters to use for making or clearing line comments (`commentLine`) and block comments (`commentStart` and `commentEnd`).
103-
* `Auto-Completion >` ⇒ submenu with actions that manually trigger [auto-completion](../auto-completion/) of function name, word, function parameter, and pathname. While the automatic completion is affected by [**Preferences > Auto-Completion** settings](../preferences/#auto-completion) for setting minimum number of characters, and enabling which of the completions happen automatically, when you manually trigger one of the auto-completion actions through this menu or keyboard shortcut equivalents, completion will happen regardless of those settings (so you can manually trigger when there's fewer characters than the auto-trigger threshold, or you can manually trigger function completion when only word completion is enabled).
103+
* `Auto-Completion >` ⇒ submenu with actions that manually trigger [auto-completion](../auto-completion/) of function name, word, function parameter, and pathname. While the automatic completion is affected by [**Preferences > Auto-Completion** settings](../preferences/#auto-completion) for setting minimum number of characters, and enabling which of the completions happen automatically, when you manually trigger one of the auto-completion actions through this menu or keyboard shortcut equivalents, completion will happen regardless of those settings (so you can manually trigger when there's fewer characters than the auto-trigger threshold, or you can manually trigger function completion when only word completion is active).
104104
* `EOL Conversion >` ⇒ submenu with actions that convert line endings between Windows (`CRLF`), Unix (`LF`), and old Macintosh (`CR`) values; these operations affect all of the lines of the current file
105105
* If your file has mixed line endings (some `CRLF` and some `LF`, for example), you can use this menu to fix it: if the desired line-ending is not greyed out, you can just select it, and any mixed line-endings will be converted to the chosen line ending; if the desired line-ending is greyed out, select one of the other line-endings, then switch back to the desired line-ending selection, and any mixed line-endings will be converted to the final line-ending choice.
106106
* `Blank Operations >` ⇒ submenu with actions that trim or convert spaces and tab characters on ALL lines of the current file
@@ -121,14 +121,14 @@ Aside from the normal undo/redo/copy/paste entries, there are a number of sub-me
121121
* `Character Panel` ⇒ toggles the [Character Panel](#character-panel), described above
122122
* `Clipboard History` ⇒ allows you to re-access recent copy/paste values (double-click a row to paste that value)
123123
* `Set Read-Only` ⇒ toggles Notepad++'s read-only flag on the active file buffer.
124-
* If you click this menu entry once, it will add a checkmark `` to the menu entry, to show that it's currently read-only for Notepad++. If you click this menu entry when there is already a checkmark ``, the checkmark will be cleared and Notepad++ will no longer consider this file read-only.
124+
* If you click this menu entry once, it will add a checkmark `` to the menu entry, to show that it's currently read-only for Notepad++. If you click this menu entry when there is already a checkmark ``, the checkmark will be removed and Notepad++ will no longer consider this file read-only.
125125
* The state of this Notepad++ read-only flag is saved in the [session](../session/) file, so it will be remembered the next time the session is used.
126126
* *Note*: this toggle does _not_ affect the Windows Operating System's read-only attribute on the file; if Windows has marked this file as read-only, this menu entry will be greyed out and you cannot toggle it by clicking on it. See the `Clear Read-only Flag` (below) for more on the OS flag.
127127
* `Clear Read-Only Flag` ⇒ clears the Windows Operating System (OS) read-only attribute on a file.
128128
* Once the OS read-only flag has been cleared, this menu option will be greyed out and clicking on it will do nothing.
129129
* You cannot set the OS read-only flag using this menu in Notepad++; it has to be done through the OS (though Notepad++ scripting plugins are able to ask the OS to set the OS read-only flag on the file, like in [this example in the Community Forum](https://community.notepad-plus-plus.org/post/67312)).
130-
* If you use the OS to set the flag on a file that is open in Notepad++, and [**Settings > Preferences > MISC > File Status Auto-Detection**](../preferences/#misc) has been enabled, then Notepad++ will notice that it is now a read-only file, and not allow you to edit the file.
131-
* If you use the OS to set the flag on a file that is open in Notepad++, but [**Settings > Preferences > MISC > File Status Auto-Detection**](../preferences/#misc) has been disabled, then Notepad++ will _not_ notice that it was changed to read-only by the OS, and will blindly allow you to continue making changes; however, when you try to save and it sees that the file is read-only according to the OS, Notepad++ will notify you that you cannot save, and ask if you'd like to launch Notepad++ in Administrator mode to try to make the changes (if you do, the changes you made may be lost).
130+
* If you use the OS to set the flag on a file that is open in Notepad++, and [**Settings > Preferences > MISC > File Status Auto-Detection**](../preferences/#misc) has been checked, then Notepad++ will notice that it is now a read-only file, and not allow you to edit the file.
131+
* If you use the OS to set the flag on a file that is open in Notepad++, but [**Settings > Preferences > MISC > File Status Auto-Detection**](../preferences/#misc) has been unchecked, then Notepad++ will _not_ notice that it was changed to read-only by the OS, and will blindly allow you to continue making changes; however, when you try to save and it sees that the file is read-only according to the OS, Notepad++ will notify you that you cannot save, and ask if you'd like to launch Notepad++ in Administrator mode to try to make the changes (if you do, the changes you made may be lost).
132132
* The current file's tab will have the "locked" icon (either the greyed-out disk icon by default, or the padlock icon if [**Settings > Preferences > General > ☑ Alternate icons**](../preferences/#general) has been checked on) whether the Windows OS read-only attribute is set, or the Notepad++ read-only flag has been set, or both. The "locked" icon will change to a normal icon once neither the Windows OS read-only attribute nor the Notepad++ read-only flag are set (or equivalently, once both flags are cleared).
133133

134134
## Other Editing Commands and Shortcuts
@@ -145,4 +145,4 @@ But with so many commands, and the fact that no documentation set is likely to e
145145

146146
The **File > Print** action will pull up a Windows-standard print dialog, from which you can choose your printer and send your text to the selected printer. Normally, it will print the whole document, but you can use the print dialog to choose only certain pages; if you have an active selection in the editor, only the selected text will be printed.
147147

148-
The printing of the text is affected by the [**Settings > Preferences > Print**](../preferences/#print) settings, where you can decide things like whether or not to include line numbers in the printout, margin widths, extra text to print in the header and/or footer of every page, and the Colour Options will determine how your [Style Configurator theme's colors](../preferences/#style-configurator) will be propagated to the printed output. It is up to you as the user to decide which printing settings are best to meet your needs, and will look best on your printed medium of choice. Please note that with any themes with colored backgrounds, some of those colors will be printed to the background of your printed page unless you choose one of the Colour Options that does not print the background colour; but with darker themes, which use light text on dark backgrounds, if you _don't_ have it print the background colour, then it will be very light text on your white paper. If you have a printer which allows you to print to PDF, that is a good way to see what the printout will really look like without using the paper and ink (and if you don't have a PDF printer available, your favorite search engine will show you plenty of commerical and freeware PDF printers by searching for something like "windows pdf printer" or "print to pdf").
148+
The printing of the text is affected by the [**Settings > Preferences > Print**](../preferences/#print) settings, where you can decide things like whether or not to include line numbers in the printout, margin widths, extra text to print in the header and/or footer of every page, and the **Colour Options** will determine how your [Style Configurator theme's colors](../preferences/#style-configurator) will be propagated to the printed output. It is up to you as the user to decide which printing settings are best to meet your needs, and will look best on your printed medium of choice. Please note that with any themes with colored backgrounds, some of those colors will be printed to the background of your printed page unless you choose one of the **Colour Options** that does not print the background color; but with darker themes, which use light text on dark backgrounds, if you _don't_ have it print the background color, then it will be very light text on your white paper. If you have a printer which allows you to print to PDF, that is a good way to see what the printout will really look like without using the paper and ink (and if you don't have a PDF printer available, your favorite search engine will show you plenty of commerical and freeware PDF printers by searching for something like "windows pdf printer" or "print to pdf").

0 commit comments

Comments
 (0)