You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,15 @@ To be accepted, your submission _must_ meet the following **requirement**s and _
20
20
* A possible exception might be if you are bundling multiple UDL for related languages all using the same theme. Example: `3dModeling_bundle_forChocoTheme_includes_STL_OBJ_3DS.udl.xml` would implement highlighting rules for the three 3D modeling formats of STL, OBJ, and 3DS, all for the same Choco theme.
21
21
4.**requirement**: each `display-name` attribute in the JSON file (described below) must be unique.
22
22
5.**recommendation**: if your UDL file only contains one language, the `display-name` attribute in the JSON file (described below) should have the same value as the `<UserLang name="...">` inside your definition file. This will keep the name in the **Language** menu the same as the name that was shown in the download tool (once it is developed and released).
23
-
6.**recommendation**: in your Pull Request, please provide a link to a public description of the language your UDL is based on (which will help to establish the general-interest nature of the UDL), as well as a link to an example file in that language (so that the UDL can be verified as functional).
23
+
***recommendation**: if your UDL file containts multiple languages, consider splitting them into separate files, so that the `display-name` attribute can match the UDL's `<UserLang name="...">`
24
+
*
25
+
7.**recommendation**: in your Pull Request, please provide a link to a public description of the language your UDL is based on (which will help to establish the general-interest nature of the UDL), as well as a link to an example file in that language (so that the UDL can be verified as functional).
24
26
* If you have an example file, you can upload it to the `UDL-samples` folder of the repository. Please have this file use the same name as your UDL definition file, but with the appropriate file extension, rather than `.xml`. Example: `UDLs\STL_udl.byPryrt.xml` would have a corresponding example file `UDL-samples\STL_udl.byPryrt.stl`.
25
27
***requirement**: if you have included a functionList definition, it must also include a sample file.
26
-
7.**recommendation**: if you have also created an [autoCompletion file](https://npp-user-manual.org/docs/auto-completion/) for your UDL, you may add it in the `autoCompletion` folder before you submit your PR.
27
-
-**requirement**: if you have a autoCompletion definition, the name of the definition file must match the name of the UDL (per [User Manual > Auto-completion File Format](https://npp-user-manual.org/docs/auto-completion/#auto-completion-file-format)).
28
-
8.**recommendation**: if you have also created a [functionList definition](https://npp-user-manual.org/docs/function-list/) for your UDL, you may add it in the `functionList` folder before you submit your PR.
28
+
8.**recommendation**: if you have also created an [autoCompletion file](https://npp-user-manual.org/docs/auto-completion/) for your UDL, you may add it in the `autoCompletion` folder before you submit your PR.
29
+
-**requirement**: if you have an autoCompletion definition, the name of the definition file must match the name of the UDL (`<UserLang name="...">`), per [User Manual > Auto-completion File Format](https://npp-user-manual.org/docs/auto-completion/#auto-completion-file-format)).
30
+
9.**recommendation**: if you have also created a [functionList definition](https://npp-user-manual.org/docs/function-list/) for your UDL, you may add it in the `functionList` folder before you submit your PR.
31
+
-**requirement**: if you have a functionList definition, the `display-name`**must** match the name of the UDL (from `<UserLang name="...">`).
0 commit comments