blob: 5cfc5198e775736e4913b6e36ec27987f512a2e4 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta name="copyright" content="Copyright (c) 2000, 2006 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: IBM Corporation - initial API and implementation" />
<meta name="DC.rights.owner" content="(C) Copyright 2000, 2006" />
<meta content="public" name="security" />
<meta content="index,follow" name="Robots" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta content="task" name="DC.Type" />
<meta name="DC.Title" content="Working with XML templates" />
<meta name="abstract" content="XML content assist provides a comment template, a chunk of predefined code that you can insert into a file. You may find a template useful when you have a certain piece of code you want to reuse several times, and you do not want to write it out every time." />
<meta name="description" content="XML content assist provides a comment template, a chunk of predefined code that you can insert into a file. You may find a template useful when you have a certain piece of code you want to reuse several times, and you do not want to write it out every time." />
<meta content="XML templates, creating, editing, XML templates, removing, importing, exporting" name="DC.subject" />
<meta content="XML templates, creating, editing, XML templates, removing, importing, exporting" name="keywords" />
<meta scheme="URI" name="DC.Relation" content="../topics/txedtsrc.html" />
<meta scheme="URI" name="DC.Relation" content="../topics/twcdast.html" />
<meta content="XHTML" name="DC.Format" />
<meta content="twmacro" name="DC.Identifier" />
<meta content="en-us" name="DC.Language" />
<link href="../../org.eclipse.wst.doc.user/common.css" type="text/css" rel="stylesheet" />
<title>Working with XML templates</title>
</head>
<body id="twmacro"><a name="twmacro"><!-- --></a>
<h1 class="topictitle1">Working with XML templates</h1>
<div><p>XML content assist provides a comment template, a chunk of predefined
code that you can insert into a file. You may find a template useful when
you have a certain piece of code you want to reuse several times, and you
do not want to write it out every time.</p>
<div class="section"><p>You can use a default template as provided, customize that template,
or create your own templates.</p>
For example, you can work on a group of XML
pages that should all contain a table with a specific appearance. Create a
template that contains the tags for that table, including the appropriate
attributes and attribute values for each tag. (You can copy and paste the
tags from a structured text editor into the template's <span class="uicontrol">Pattern</span> field.)
Then select the name of the template from a content assist proposal list whenever
you want to insert your custom table into an XML file.<p>To create a new XML
template follow these steps:</p>
</div>
<ol>
<li class="stepexpand"><span>Click <span class="menucascade"><span class="uicontrol">Window</span> &gt; <span class="uicontrol">Preferences</span>
&gt; <span class="uicontrol">Web and XML</span> &gt; <span class="uicontrol">XML Files</span> &gt; <span class="uicontrol">XML
Templates</span></span>.</span></li>
<li class="stepexpand"><span>Click <span class="uicontrol">New</span> if you want to create a completely
new template.</span></li>
<li class="stepexpand"><span>Supply a new template <span class="uicontrol">Name</span> and <span class="uicontrol">Description</span>.</span>
</li>
<li class="stepexpand"><span>Specify the <span class="uicontrol">Context</span> for the template.</span>
This is the context in which the template is available in the proposal
list when content assist is requested. </li>
<li class="stepexpand"><span>Specify the <span class="uicontrol">Pattern</span> for your template using
the appropriate tags, attributes, or attribute values to be inserted by content
assist.</span></li>
<li class="stepexpand"><span>If you want to insert a variable, click the <span class="uicontrol">Insert Variable</span> button
and select the variable to be inserted. </span> For example, the <strong>date</strong> variable
indicates the current date will be inserted. </li>
<li class="stepexpand"><span>Click <span class="uicontrol">Apply</span> and then <span class="uicontrol">OK</span> to
save your changes.</span></li>
</ol>
<div class="section">You can edit, remove, import, or export a template by using the same
preferences page. If you have modified a default template, you can restore
it to its default value. You can also restore a removed template if you have
not exited from the workbench since it was removed. <p>If you have a template
that you do not want to remove but you no longer want it to appear in the
content assist list, go to the <strong>XML Templates</strong> preferences page and clear
its check box.</p>
</div>
</div>
<div><div class="reltasks"><strong>Related tasks</strong><br />
<div><a href="../topics/txedtsrc.html" title="You can use the Source view to view and work with a file's source code directly.">Editing in the Source view</a></div>
<div><a href="../topics/twcdast.html" title="You can use content assist to help you finish a tag or line of code in the Source view of the XML editor. You can also use content assist to insert templates into your XML code.">Using XML content assist</a></div>
</div>
</div>
</body>
</html>