Wordfiles - Revision history

Idmadmin at 14:32, 4 May 2023

2023-05-04T14:32:12Z

Idmadmin: /* Special "_LANG" language flags */

2018-09-19T17:11:40Z

‎Special "_LANG" language flags

Idmadmin at 12:57, 16 August 2018

2018-08-16T12:57:23Z

Idmadmin: /* Line comments */

2018-07-23T18:15:53Z

‎Line comments

Idmadmin at 20:26, 7 June 2018

2018-06-07T20:26:34Z

Idmadmin at 20:22, 7 June 2018

2018-06-07T20:22:36Z

Idmadmin at 12:34, 25 May 2018

2018-05-25T12:34:33Z

Idmadmin at 19:56, 26 January 2018

2018-01-26T19:56:20Z

Idmadmin: /* Function list strings */

2018-01-08T14:46:38Z

‎Function list strings

Idmadmin: /* Keyword color groups */

2017-10-26T20:29:01Z

‎Keyword color groups

@@ Line 106: / Line 106: @@
 |<code>JAVA_LANG</code>
 |'''Java'''
 |-
 |<code>JSCRIPT_LANG</code>
@@ Line 207: / Line 212: @@
 <code>/Line Comment Preceding Chars = [a-z]</code> (if on its own line in wordfile)
-In the example above, UltraEdit would only identify line comments if the line comment character immediately follow any character a &ndash; z.
+In the example above, UltraEdit would only identify line comments if the line comment character immediately follows any character a &ndash; z.
-You can also use the tilde (~) to specify a negative matching set of characters  (i.e., comments are '''not''' valid if they are preceded by the following characters):
+You can also use <code>~</code> to specify a negative matching set of characters  (i.e., comments are '''not''' valid if they are preceded by the following characters):
 <code>Line Comment Preceding Chars = [~a-z]</code><br>
 <code>/Line Comment Preceding Chars = [~a-z]</code> (if on its own line in wordfile)
 In the example above, UltraEdit would only identify line comments if the line comment character '''does not''' immediately follow any character a &ndash; z.
 By default, UltraEdit will treat comment characters in any column as a valid comment, but some languages may require that line comments must start in a specific column(s). To facilitate this, the following wordfile definition is available:
@@ Line 395: / Line 404: @@
 By default, functions inside of comments (whether line or block comments) aren't shown in the function list.  If you want functions inside of commented text to be displayed in the function list, add the following setting to the wordfile on the top line:
-<code>Strip Comments = False</code>
+<code>Strip Comments = False</code> or <code>Strip Comments = No</code><br>
 == Delimiters ==
@@ Line 539: / Line 549: @@
 <code>/C4"Some / keywords"</code><br>
 <code>// /akeyword /mykeyword /zkeyword </code>
 <div class="idm-see-also">

@@ Line 119: / Line 119: @@
 |<code>MASM_LANG</code>
 |'''Microsoft Assembly'''
 |-
 |<code>MATLAB_LANG</code>

@@ Line 224: / Line 224: @@
 The above would cause all text between "/*" and "*/" to be highlighted as a block comment, even if it spans multiple lines.
-Note: If <code>Block Comment On</code> is defined in the wordfile, but the <code>Block Comment Off</code> is not, the blcok commenting will stop at the end of the line.  This effectively allows the block comments to be used as line comments also.
+Note: If <code>Block Comment On</code> is defined in the wordfile, but the <code>Block Comment Off</code> is not, the block commenting will stop at the end of the line.  This effectively allows the block comments to be used as line comments also.
 You can define a second set of alternative block comments as well. These can be defined with the following syntax, typically placed on line 1 of the wordfile:

@@ Line 209: / Line 209: @@
 By default, UltraEdit will treat comment characters in any column as a valid comment, but some languages may require that line comments must start in a specific column(s). To facilitate this, the following wordfile definition is available:
-<code>Line Comment Valid Columns = [1-7,10]</code>
+<code>Line Comment Valid Columns = [1-7,10]</code><br>
 <code>/Line Comment Valid Columns = [1-7,10]</code> (if on its own line in wordfile)

@@ Line 4: / Line 4: @@
 }}[[File:Ultraedit wordfile.png|right|thumb|alt=UltraEdit wordfile|Example of a wordfile used for syntax highlighting in UltraEdit]]
-As discussed in the [[Syntax highlighting]] topic, UltraEdit applies syntax highlighting from definitions and configurations in wordfiles. Wordfiles must be in plain text, ANSI format with DOS style line endings and a .uew file extension. Wordfiles must be no more than 372 KB in size.
+As discussed in the [[Syntax highlighting]] topic, UltraEdit applies syntax highlighting from definitions and configurations in wordfiles. In order to work properly, wordfiles:
-The wordfiles are loaded on startup, or when modified via the '''[[Add syntax highlighting languages|Add another language...]]''' dialog. Wordfiles are loaded from the folder shown in [[Settings:Editor display:Syntax highlighting|Settings &raquo; Editor Display &raquo; Syntax Highlighting]] (subfolders are ignored).
+* must be in plain text format with DOS style line endings
 The '''easiest''' way to create your own wordfile is to take one of the existing wordfiles and modify it as desired, saving it into the wordfiles directory with a unique name and .uew file extension. You will need to restart UltraEdit in order to initialize the new wordfile, but once initialized, any changes you make to it will be reflected in real-time when you switch to an open file being highlighted by the wordfile you're modifying.

← Older revision		Revision as of 20:22, 7 June 2018
Line 395:		Line 395:

	It is possible to assign the delimiter characters to the color sections. If you have a character that is a delimiter, such as a '+', and you wish this to be colored with one of the keyword color groups you may add this character to a line of its own under the color section, and this will retain its recognition as a delimiter ''and'' be highlighted with the appropriate color.		It is possible to assign the delimiter characters to the color sections. If you have a character that is a delimiter, such as a '+', and you wish this to be colored with one of the keyword color groups you may add this character to a line of its own under the color section, and this will retain its recognition as a delimiter ''and'' be highlighted with the appropriate color.
		+
		+	== Delimiter overrides ==
		+
		+	For some languages, it may be desirable to override delimiters (i.e., word boundaries) for selecting and Ctrl + Left / Right Arrow. For example, in PHP files you may want the leading "$" to be selected when double-clicking a variable name like <code>$my_var</code>, but you would ''not'' want this behavior in other plain text files. To facilitate this, add a new line similar to the following to the wordfile:
		+
		+	<code>/Word Select Include = $</code>
		+
		+	You can add as many non-word characters as you'd like for this setting. Any character specified here (including tab / space) will be included in a selection when double-clicking on a word, and will be skipped over when using Ctrl + Left / Right Arrow to reposition the caret in the file.

	== Indent / unindent strings ==		== Indent / unindent strings ==

@@ Line 334: / Line 334: @@
 In order to populate the [[Function list]], UltraEdit uses function strings defined in the wordfile. Function strings are regular expressions used to match and identify functions is source code. (They don't necessarily have to be used for functions; they can be used for whatever you wish to list in the function list.) Function listing is '''not''' case sensitive, regardless of whether the <code>Nocase</code> directive is in the wordfile.
-Historially UltraEdit has used its legacy [[Regular expressions|regular expressions]] syntax for function strings. However, you can specify that function strings will use [[Perl regular expressions]] syntax (recommended and used by most modern wordfiles) by adding the following to the top portion of the wordfile on its own line:
+Historically UltraEdit has used its legacy [[Regular expressions|regular expressions]] syntax for function strings. However, you can specify that function strings will use [[Perl regular expressions]] syntax (recommended and used by most modern wordfiles) by adding the following to the top portion of the wordfile on its own line:
 <code>/Regexp Type = Perl</code>

@@ Line 521: / Line 521: @@
 * [[Syntax highlighting]]
 * [[Add syntax highlighting languages]]
 </div>

← Older revision		Revision as of 14:46, 8 January 2018
Line 375:		Line 375:

	The regular expression you provide for the function string must be encapsulated in double quotes and should tag (via the regular expression's tagging syntax) the portion of the regular expression that will match the function name, as this is what will be returned in the function list. In the real example above using the regular expression '''<nowiki>[ \t]*function[ \t]([^\(])+[ \t]+</nowiki>''', any preceding whitespace, the word "function," any trailing whitespace after the word "function", and any number of characters that are not "(" would be matched, but only the last portion would be returned in the function list as it is the only portion that is tagged via parentheses.		The regular expression you provide for the function string must be encapsulated in double quotes and should tag (via the regular expression's tagging syntax) the portion of the regular expression that will match the function name, as this is what will be returned in the function list. In the real example above using the regular expression '''<nowiki>[ \t]*function[ \t]([^\(])+[ \t]+</nowiki>''', any preceding whitespace, the word "function," any trailing whitespace after the word "function", and any number of characters that are not "(" would be matched, but only the last portion would be returned in the function list as it is the only portion that is tagged via parentheses.
		+
		+	=== Showing commented functions ===
		+
		+	By default, functions inside of comments (whether line or block comments) aren't shown in the function list. If you want functions inside of commented text to be displayed in the function list, add the following setting to the wordfile on the top line:
		+
		+	<code>Strip Comments = False</code>

	== Delimiters ==		== Delimiters ==

@@ Line 470: / Line 470: @@
 <code>/C1"Basic keywords"</code><br>
 <code>auto</code><br>
-<code>bool break</code><br>
+<code>break</code><br>
-<code>case char const continue</code><br>
+<code>case const continue</code><br>
-<code>default defined do double</code><br>
+<code>default defined do</code><br>
-<code>else enum extern</code><br>
+<code>else extern</code><br>
-<code>float for</code><br>
+<code>for</code><br>
 <code>goto</code><br>
-<code>if int</code><br>
+<code>if </code><br>
 <code>register return</code><br>
-<code>short signed sizeof static struct switch</code><br>
+<code>signed sizeof static switch</code><br>
 <code>typedef</code><br>
 <code>union unsigned</code><br>