Skip to content

Commit 4ee0262

Browse files
committed
Clarify "optional" overrideMap and a few other functionList-section wordings
1 parent 96da5fb commit 4ee0262

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

content/docs/config-files.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -306,16 +306,16 @@ Defines what counts as a "function" for **View > Function List**. There are some
306306
The `functionList` folder contains a separate XML file (function list parse rule) for each language's function list capability.
307307
Each function list parse rule links to a language with the language default name. For example the file name of php language parse rule is `php.xml`, the file name of Java language parse rule is `java.xml`, Check [overrideMap.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/functionList/overrideMap.xml) for the naming list of all supported programming languages.
308308

309-
[overrideMap.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/functionList/overrideMap.xml) is optional. When you need to override a default parser rule or to define a function list parser for your User Defined Language (UDL), you modify this file.
309+
For built-in languages that already have Function List behavior, editing [overrideMap.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/functionList/overrideMap.xml) is optional: if you edit the existing `functionList\XYZ.xml` for that language, you don't need to edit `overrideMap.xml`; however, if you create a new `functionList\my_XYZ.xml` that you want to use instead of the default function list definition for XYZ, then you need to copy the an `<association id="{filename.xml}"... />` for language XYZ from inside the `<!-- ... -->` comment block, paste it outside that block, and point the to the new file using `id="my_XYZ.xml`. If you need to link to a function list parser name "udl_ABC.xml" for your User Defined Language (UDL) named "ABC", you need to modify this file to add an `<association id="udl_ABC.xml" userDefinedLangName="ABC">` : the `id` must match the filename exactly, and the `userDefinedLangName` must match the name of your UDL, as seen in the **Language** menu and UDL dialog.
310310

311-
- Override a default parser rule examples
311+
- Example: Override default parser rules for two languages:
312312
```
313313
<association id= "anotherPhpParser.xml" langID= "1" />
314314
<association id= "myPerlRule.xml" langID= "21"/>
315315
```
316-
If 2 above lines are in *overrideMap.xml*, function list will load your parsers `anotherPhpParser.xml` and `myPerlRule.xml` instead of loaoding `php.xml` and `perl.xml` while showing PHP and Perl function list respectively.
316+
If 2 above lines are in `overrideMap.xml`, function list will load your parsers `anotherPhpParser.xml` and `myPerlRule.xml` instead of loaoding `php.xml` and `perl.xml` while showing PHP and Perl function list respectively.
317317

318-
- Define your UDL example
318+
- Example: Set the parser rule for your UDL called "KRL":
319319
```
320320
<association id= "krl.xml" userDefinedLangName="KRL"/>
321321
```

content/docs/function-list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ A mixed parser contains a Class parser (`classRange` node) and a Function parser
7878
Once you finish defining your parser, save and name the file as the language name with `xml` as file extension to the `functionList` folder in order to make it work with the language you want. (Check [overrideMap.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/functionList/overrideMap.xml) for the naming list of all supported programming languages.) Then load a file that uses that parser, and make sure it finds all the functions that you expect, in the appropriate classes.
7979

8080
## Use your own personal function list definition for a built-in language
81-
If you do not like the results of the default Function List parser that ships with Notepad++ for a particular language, feel free to write your parser rule then save with a unique filename (like `my_languagename.xml`). (_Note_: if you edit the existing `languagename.xml`, the next update may erase your changes.) Use your [overrideMap.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/functionList/overrideMap.xml) in the functionList directory to override the default mapping of functionList parser rule files, or to add a mapping to new UDL parser rule files, as described in the [function list config files](../config-files/#function-list) section of the manual.
81+
If you do not like the results of the default Function List parser that ships with Notepad++ for a particular language, feel free to write your parser rule then save with a unique filename (like `my_languagename.xml`). (_Note_: if you edit the existing `languagename.xml`, the next update may erase your changes.) Use your [overrideMap.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/functionList/overrideMap.xml) in the functionList directory to override the default mapping of functionList parser rule files and point to your new definition file, or to add a mapping to new UDL parser rule files, as described in the [function list config files](../config-files/#function-list) section of the manual.
8282

8383
## Validating Function List definition files
8484

0 commit comments

Comments
 (0)