Modify templates - Revision history

Idmadmin: /* Inserting templates */

2018-03-28T16:32:40Z

‎Inserting templates

Idmadmin at 20:20, 10 January 2018

2018-01-10T20:20:32Z

Idmadmin at 19:17, 25 August 2017

2017-08-25T19:17:01Z

Idmadmin: Created page with "Category:Edit tab A template is predefined text that is stored and can be recalled later to insert into a file. The '''Modify templates''' dialog allows you to create, mo..."

2017-08-23T15:19:12Z

Created page with "Category:Edit tab A template is predefined text that is stored and can be recalled later to insert into a file. The '''Modify templates''' dialog allows you to create, mo..."

New page

[[Category:Edit tab]]
A template is predefined text that is stored and can be recalled later to insert into a file. The '''Modify templates''' dialog allows you to create, modify, delete, and organize templates.

[[File:Ultraedit modify templates.png|alt=screenshot of Modify templates dialog|"Modify templates" dialog]]

==Template groups==

The '''Template group''' drop down can be used to select the group for which templates are listed in the '''Templates''' pane. Templates are organized in four groups:
# '''Global'''
# '''Layouts'''
# '''Languages'''
# '''Projects'''

Templates are stored in a plain-text XML format, although it is generally recommended that templates are created and modified directly through the '''Modify templates''' dialog and not directly in the file itself.

===Global templates===
Global templates are always available no matter which layout, project, or coding language you're using. Global templates are stored in the '''UETMPLTE.TPL''' file in the default templates directory (which is typically '''%APPDATA%\IDMComp\UltraEdit\templates''' on Windows), or the directory manually set in the [[Directories]] section under Settings in the Advanced tab if using the default layout.

===Layout templates===
Layout templates are only available when the layout they're associated with is loaded. Layout templates are stored in layout-related files in the '''environments''' subfolder of the global templates directory.

===Language templates===
Language templates are associated with coding languages specified for [[Syntax highlighting]] and are only available when editing files with extensions that match that language as defined in the [[wordfiles|wordfile]]. Language templates are stored in the default wordfiles directory as shown in [[Editor display:Syntax highlighting|Editor Display » Syntax Highlighting]] in Settings.

===Project templates===
Project templates are only available when the project they're associated with is loaded. Project templates are stored in the directory/file specified in the [[Project settings]] dialog.

==Adding / modifying templates==

You can create an unlimited number of templates. Each template must be named, and the name is used in the ribbons, menus, and toolbars as well as in the [[Template list]]. The name is shown in the template list column in the left side of the "Modify templates" dialog.

The following options are available in the "Modify templates" dialog:

'''Add (+) / remove (x) buttons''' 
Use these buttons to add and delete templates from the selected group.

'''Up / down buttons''' 
Use these buttons to move the selected template up or down in the template list. The order of templates shown in the template list of the "Modify templates" dialog is also the order used to display templates in the [[Template list]].

'''Description''' 
You can provide an optional description for the template of up to 79 characters. The description is shown in the tooltip displayed when hovering over the template in the [[Template list]]. If a description is not provided, the tooltip will show an extract of the template itself.

'''Do not insert in Comments / Strings''' 
These options are only available for language templates. If checked, the template will not be automatically suggested when its name is typed in a comment or string of the associated syntax highlighting language.

'''? button''' 
This button opens a dialog with a list of available [[#Placeholder variables|template variables]] and formatting options.

'''Content field''' 
To create a template, simply type the text of the template into this field.

You can use the caret (^) in the template to represent where the caret should be positioned after the template is inserted. For example, if you have a template consisting of <code><myTag></myTag></code>, and you want the caret to be positioned between the 2 tags, you would create the template as <code><myTag>^</myTag></code>. To include a literal caret (^) as part of your template, escape it with itself; i.e., "^^" would insert a literal "^".

===Placeholder variables===

Using the syntax <code>[+VariableName+]</code> within a template, you can define "placeholder" variables in templates. When the template is inserted, you can type the value for the placeholder. All occurrences of the placeholder variable within the template are then updated. Pressing '''Tab''' will move focus to the next placeholder variable. For example if you insert the template:

<code>// function [+function+]</code> 
<code>[+scope+] function [+function+] () {</code> 
<code>  ^</code> 
<code>}</code>

...and type "myFunc" for the <code>[+function+]</code> variable and "private" for the <code>[+scope+]</code> variable, you would see this:

<code>// function myFunc</code> 
<code>private function myFunc () {</code> 
<code>  ^</code>''<-- caret blinking here ''
<code>}</code>

===Selectable value variables===

Selectable values allow you to insert a variable with several different pre-defined choices which can be selected during template insertion via the auto-complete drop down. To add selectable values to a template variable, use the following syntax:

<code>[+defaultVal|selectableVal1|selectableVal2|selectableVal3+]</code>

The pipe character (|) is used to delimit different selectable values. In the above example, when the template is inserted, the variable would have a default value of ''defaultVal'' and the auto-complete dialog would open immediately to allow you to choose one of the other 3 options. Once you select an item from the auto-complete drop down by pressing '''Enter''', UltraEdit will shift focus to the next variable (or if this is the only variable, insert the template).

In some cases, you may prefer to use a completely different value for a template variable instead of one of the pre-defined values. In this case, you can simply tab to the variable during template insertion and begin typing a new value. The auto-complete dialog will disappear after you begin typing new text. At any time, you can press '''Ctrl + Spacebar''' to make the auto-complete dialog with the selectable values visible again.

===Special template variables===

A template can contain special text strings that are translated at the time the template is recalled. These special strings are:

{|
|<code>[DATE_DMY]</code>
|Is translated into the current date with the format day/month/year.
|-
|<code>[DATE_MDY]</code>
|Is translated into the current date with the format month/day/year.
|-
|<code>[DATE_TEXT]</code>
|Is translated into the current date with the date displayed as text.
|-
|<code>[TIME]</code>
|Is translated into the current time in '''24 hour''' format.
|-
|<code>^</code>
|This indicates the position at which to place the cursor after the template has been inserted.
|-
|<code>[FULL_FILE_NAME]</code>
|Is translated into the full path and filename of the active document.
|-
|<code>[FILE_PATH]</code>
|Is translated into the drive and path of the active document.
|-
|<code>[FILE_NAME]</code>
|Is translated into the root filename of the active document.
|-
|<code>[FILE_EXTENSION]</code>
|Is translated into the file extension of the active document with the "point", i.e. ".txt".
|-
|<code>[FILE_EXTENSION_NP]</code>
|Is translated into the file extension of the active document without the "point", i.e. "txt".
|-
|<code>[$REPLACE$]</code>
|Is replaced with selected text in the active document. The selection will be converted to uppercase text when inserted with the template.
|-
|<code>[$replace$]</code>
|Is replaced with selected text in the active document. The selection's current case will be maintained when it is inserted with the template.
|}

Note - ^ refers to the character '^', not the Ctrl key.

===Customizing time / date format===

For extended date and time formatting, UltraEdit supports special template strings.

'''Time''' 
To specify and customize the format of the local time, use the following syntax in your template:

<code>[TIME_USER]...format customizations here...[TIME_USER_END]</code>

To specify and customize the format of the UTC (GMT, or Greenwich Mean Time) time, use the following syntax in your template:

<code>[TIME_USER_SYS]...format customizations here...[TIME_USER_SYS_END]</code>

The time format customizations are as follows:

{|
!String
!Meaning
|-
|h
|Hours with no leading zero for single-digit hours; 12-hour clock
|-
|hh
|Hours with leading zero for single-digit hours; 12-hour clock
|-
|H
|Hours with no leading zero for single-digit hours; 24-hour clock
|-
|HH
|Hours with leading zero for single-digit hours; 24-hour clock
|-
|m
|Minutes with no leading zero for single-digit minutes
|-
|mm
|Minutes with leading zero for single-digit minutes
|-
|s
|Seconds with no leading zero for single-digit seconds
|-
|ss
|Seconds with leading zero for single-digit seconds
|-
|t
|One character time marker string, such as A or P
|-
|tt
|Multicharacter time marker string, such as AM or PM
|}

If you use spaces to separate the elements in the format string, these spaces will appear in the same location in the template. The letters must be in uppercase or lowercase as shown (for example, "ss", not "SS"). Characters in the format string that are enclosed in single quotation marks will appear in the same location and unchanged in the template.

For example, to get the time string

'''11:29:40 PM'''

...use the following format string between the time markers:

<code>[TIME_USER]hh':'mm':'ss tt[TIME_USER_END]</code>

'''Date''' 
To specify and customize the format of the local date, use the following syntax in your template:

<code>[DATE_USER]...format customizations here...[DATE_USER_END]</code>

To specify and customize the format of the UTC date, use the following syntax in your template:

<code>[DATE_USER_SYS]...format customizations here...[DATE_USER_SYS_END]</code>

The date format customizations are as follows:

{|
!String
!Meaning
|-
|d
|Day of month as digits with no leading zero for single-digit days.
|-
|dd
|Day of month as digits with leading zero for single-digit days.
|-
|ddd
|Day of week as a three-letter abbreviation.
|-
|dddd
|Day of week as its full name.
|-
|M
|Month as digits with no leading zero for single-digit months.
|-
|MM
|Month as digits with leading zero for single-digit months.
|-
|MMM
|Month as a three-letter abbreviation.
|-
|MMMM
|Month as its full name.
|-
|y
|Year as last two digits, but with no leading zero for years less than 10.
|-
|yy
|Year as last two digits, but with leading zero for years less than 10.
|-
|yyyy
|Year represented by full four digits.
|}

If you use spaces to separate the elements in the format string, these spaces will appear in the same location in the template. The letters must be in uppercase or lowercase as shown in the table (for example, "MM" not "mm"). Characters in the format string that are enclosed in single quotation marks will appear in the same location and unchanged in the template.

For example, to get the date string

'''Wed, Aug 31 94'''

...use the following format string between the time markers:

<code>[DATE_USER]ddd',' MMM dd yy[DATE_USER_END]</code>

==Inserting templates==

Templates can be inserted into the active file through any of the following methods:

# The first 20 '''global''' templates can be inserted using hotkeys '''Alt+0''' through '''Alt+9''' (for templates 0 - 9), and '''Shift+Alt+0''' through '''Shift+Alt+9''' (for templates 10-19)
# The first 50 '''global''' templates can be inserted with custom keyboard shortcuts defined in [[Key mapping]] in Settings via the ''User Template #'' commands
# # Any '''global''' template can be inserted via the "Insert template" drop down in the Edit tab
# Any template can be inserted by double-clicking it in the [[Template list]]
# Any template can be inserted by typing part or all of its name and pressing '''Ctrl + Spacebar''' to select it in the auto-complete dialog
# Any template can be inserted by typing its name and waiting for it to be automatically suggested by the editor, as configured in the [[Templates]] section of settings

===Auto-suggested templates===
If '''Auto-suggest smart template when typing''' is enabled in the [[Templates]] section of settings (it is by default), then when you type the name of any template (global, layout, project, or language), the template will be automatically suggested and shown in a "suggestion" mode in the edit window.

To accept the suggested template and add it to the file, press '''Tab'''.

Alternatively, while editing, you can press '''Ctrl + Spacebar''' to invoke the auto-complete dialog, and any templates names matching the string next to the caret (either wholly or partially) will be listed in the auto-complete dialog as well. You can use the up / down arrow keys to select a template shown in the auto-complete dialog, then press '''Enter''' to insert it.

If the template contains placeholder variables, UltraEdit will enter a special template editing state where you can set / select variables before the template is permanently added to the file. You can jump between different template variables via the '''Tab''' key. After setting variables in this mode, press '''ESC''' or '''Enter''' to finalize the template and insert it into the file.

If templates exist with the same name under different groups, the precedence used in auto-suggesting is as follows:

# Language
# Layout
# Project
# Global

<div class="idm-see-also">
See also:
* [[Template list]]
* [[Templates]]
</div>

@@ Line 249: / Line 249: @@
 # # Any '''global''' template can be inserted via the "Insert template" drop down in the Edit tab
 # Any template can be inserted by double-clicking it in the [[Template list]]
-# Any template can be inserted by typing part or all of its name and pressing '''Ctrl + Spacebar''' to select it in the auto-complete dialog
+# Any template can be inserted by typing part or all of its name and pressing '''Ctrl + Spacebar''' to select it in the [[Auto completion|auto-complete dialog]]
 # Any template can be inserted by typing its name and waiting for it to be automatically suggested by the editor, as configured in [[Settings:Templates|Settings &raquo; Templates]]
@@ Line 257: / Line 257: @@
 To accept the suggested template and add it to the file, press '''Tab'''.
-Alternatively, while editing, you can press '''Ctrl + Spacebar''' to invoke the auto-complete dialog, and any templates names matching the string next to the caret (either wholly or partially) will be listed in the auto-complete dialog as well. You can use the up / down arrow keys to select a template shown in the auto-complete dialog, then press '''Enter''' to insert it.
+Alternatively, while editing, you can press '''Ctrl + Spacebar''' to invoke the [[Auto completion|auto-complete dialog]], and any templates names matching the string next to the caret (either wholly or partially) will be listed in the auto-complete dialog as well. You can use the up / down arrow keys to select a template shown in the auto-complete dialog, then press '''Enter''' to insert it.
 If the template contains placeholder variables, UltraEdit will enter a special template editing state where you can set / select variables before the template is permanently added to the file. You can jump between different template variables via the '''Tab''' key. After setting variables in this mode, press '''ESC''' or '''Enter''' to finalize the template and insert it into the file.

@@ Line 1: / Line 1: @@
 [[Category:Edit tab]]
-A template is predefined text that is stored and can be recalled later to insert into a file.  The '''Modify templates''' dialog allows you to create, modify, delete, and organize templates.
+A template is predefined text that is stored and can be recalled later to insert into a file.  The '''Modify templates''' dialog (accessible via the "Insert template" dropdown menu in the [[:Category:Edit tab|Edit tab]]) allows you to create, modify, delete, and organize templates.
 [[File:Ultraedit modify templates.png|alt=screenshot of Modify templates dialog|"Modify templates" dialog]]
@@ Line 271: / Line 271: @@
 See also:
 * [[Template list]]
-* [[Templates]]
+* [[Settings:Templates|Settings &raquo; Templates]]
 </div>

@@ Line 15: / Line 15: @@
 ===Global templates===
-Global templates are always available no matter which layout, project, or coding language you're using. Global templates are stored in the '''UETMPLTE.TPL''' file in the default templates directory (which is typically '''%APPDATA%\IDMComp\UltraEdit\templates''' on Windows), or the directory manually set in the [[Directories]] section under Settings in the Advanced tab if using the default layout.
+Global templates are always available no matter which layout, project, or coding language you're using. Global templates are stored in the '''UETMPLTE.TPL''' file in the default templates directory (which is typically '''%APPDATA%\IDMComp\UltraEdit\templates''' on Windows), or the directory manually set in [[Settings:Directories|Settings &raquo; Directories]].
 ===Layout templates===
@@ Line 21: / Line 21: @@
 ===Language templates===
-Language templates are associated with coding languages specified for [[Syntax highlighting]] and are only available when editing files with extensions that match that language as defined in the [[wordfiles|wordfile]]. Language templates are stored in the default wordfiles directory as shown in [[Editor display:Syntax highlighting|Editor Display &raquo; Syntax Highlighting]] in Settings.
+Language templates are associated with coding languages specified for [[Syntax highlighting]] and are only available when editing files with extensions that match that language as defined in the [[wordfiles|wordfile]]. Language templates are stored in the default wordfiles directory as shown in [[Settings:Editor display:Syntax highlighting|Settings &raquo; Editor Display &raquo; Syntax Highlighting]].
 ===Project templates===
@@ Line 246: / Line 246: @@
 # The first 20 '''global''' templates can be inserted using hotkeys '''Alt+0''' through '''Alt+9''' (for templates 0 - 9), and '''Shift+Alt+0''' through '''Shift+Alt+9''' (for templates 10-19)
-# The first 50 '''global''' templates can be inserted with custom keyboard shortcuts defined in [[Key mapping]] in Settings via the ''User Template #'' commands
+# The first 50 '''global''' templates can be inserted with custom keyboard shortcuts defined in [[Settings:Key mapping|Settings &raquo; Key mapping]] via the ''User Template #'' commands
 # # Any '''global''' template can be inserted via the "Insert template" drop down in the Edit tab
 # Any template can be inserted by double-clicking it in the [[Template list]]
 # Any template can be inserted by typing part or all of its name and pressing '''Ctrl + Spacebar''' to select it in the auto-complete dialog
-# Any template can be inserted by typing its name and waiting for it to be automatically suggested by the editor, as configured in the [[Templates]] section of settings
+# Any template can be inserted by typing its name and waiting for it to be automatically suggested by the editor, as configured in [[Settings:Templates|Settings &raquo; Templates]]
 ===Auto-suggested templates===
-If '''Auto-suggest smart template when typing''' is enabled in the [[Templates]] section of settings (it is by default), then when you type the name of any template (global, layout, project, or language), the template will be automatically suggested and shown in a "suggestion" mode in the edit window.
+If '''Auto-suggest smart template when typing''' is enabled in [[Settings:Templates|Settings &raquo; Templates]] (it is by default), then when you type the name of any template (global, layout, project, or language), the template will be automatically suggested and shown in a "suggestion" mode in the edit window.
 To accept the suggested template and add it to the file, press '''Tab'''.