Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.text/src/org/eclipse/jface/text/templates/package.html')
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/templates/package.html38
1 files changed, 19 insertions, 19 deletions
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html b/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html
index 00fe64dc3..324452717 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html
+++ b/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html
@@ -32,7 +32,7 @@ which are only resolved at the time when the template is inserted
within a context. Together with linked mode, inserting a template can
create a on-the-fly edit mask within a text viewer.<br>
<br>
-Templates are specified as text, variables are defined using the <tt>${variable}</tt>
+Templates are specified as text, variables are defined using the <code>${variable}</code>
notation known from
Ant, for example. The following snippet shows an example template for
an instance check in Java:<br>
@@ -41,40 +41,40 @@ an instance check in Java:<br>
&nbsp;&nbsp;&nbsp; ${cursor}
}
</pre>
-In this template, the variables (<tt>name,type, ...</tt>) are resolved
+In this template, the variables (<code>name,type, ...</code>) are resolved
when inserted into java source and changing one variable instance will
also change the other. When leaving linked mode, the caret is placed at
-the <tt>cursor</tt> variable.<br>
+the <code>cursor</code> variable.<br>
<br>
Template functionality can be added to a custom text editor by offering
-<tt>TemplateProposal</tt>s as content assist choices, which is
-simplified by using a subclass of <tt>TemplateCompletionProcessor</tt>. User template management can be
-offered by including a <tt>TemplatePreferencePage</tt> which uses a <tt>TemplateStore</tt> and <tt>ContextTypeRegistry</tt> as the
-underlying model to store templates. The <tt>org.eclipse.ui.editors.templates</tt>
+<code>TemplateProposal</code>s as content assist choices, which is
+simplified by using a subclass of <code>TemplateCompletionProcessor</code>. User template management can be
+offered by including a <code>TemplatePreferencePage</code> which uses a <code>TemplateStore</code> and <code>ContextTypeRegistry</code> as the
+underlying model to store templates. The <code>org.eclipse.ui.editors.templates</code>
extension point can be used to allow other plug-ins to contribute
-templates to an editor. This is accomplished by using the <tt>ContributionTemplateStore</tt> and <tt>ContributionContextTypeRegistry</tt>
+templates to an editor. This is accomplished by using the <code>ContributionTemplateStore</code> and <code>ContributionContextTypeRegistry</code>
subclasses of the above types.<br>
<br>
-Template variables are resolved by a <tt>TemplateVariableResolver.</tt> <tt>GlobalTemplateVariables</tt> offers
+Template variables are resolved by a <code>TemplateVariableResolver.</code> <code>GlobalTemplateVariables</code> offers
some default variables such as date, user, and selection, but advanced
features such as resolving to language constructs can be performed in
subclasses.<br>
<h4>Classes</h4>
<ul>
- <li><tt>Template</tt> a template consists of name, context
+ <li><code>Template</code> a template consists of name, context
type identifier, and a pattern.</li>
- <li><tt>TemplateTranslator</tt> and <tt>TemplateBuffer</tt> are used to
+ <li><code>TemplateTranslator</code> and <code>TemplateBuffer</code> are used to
parse the template grammar and don't need to be used usually.</li>
- <li>A <tt>TemplateProposal </tt>can be
-offered in content assist, possibly created by a subclass of <tt>TemplateCompletionProcessor.</tt></li>
- <li><tt>TemplateStore</tt> and <tt>ContextTypeRegistry</tt> manage a
+ <li>A <code>TemplateProposal </code>can be
+offered in content assist, possibly created by a subclass of <code>TemplateCompletionProcessor.</code></li>
+ <li><code>TemplateStore</code> and <code>ContextTypeRegistry</code> manage a
set of templates within a plug-in and offer ways to store them in the
-preferences or externally in XML streams via a <tt>TemplateReaderWriter</tt>.<br></li>
- <li><tt>ContributionTemplateStore</tt> and <tt>ContributionContextTypeRegistry</tt>
-add awareness for the <tt>org.eclipse.ui.editors.templates</tt>
+preferences or externally in XML streams via a <code>TemplateReaderWriter</code>.<br></li>
+ <li><code>ContributionTemplateStore</code> and <code>ContributionContextTypeRegistry</code>
+add awareness for the <code>org.eclipse.ui.editors.templates</code>
extension point.</li>
- <li><tt>TemplatePreferencePage</tt> allows
-the user to access the templates within a <tt>TemplateStore.</tt></li>
+ <li><code>TemplatePreferencePage</code> allows
+the user to access the templates within a <code>TemplateStore.</code></li>
</ul>
<h4>Example</h4>
See the Template Editor Example in the <strong>org.eclipse.ui.examples.javaeditor</strong> project.<br>

Back to the top