blob: 364fca98f5111e0c331c8cf3dbd623b39702a9d9 [file] [log] [blame]
syeshin17ed4a62005-07-25 17:10:24 +00001<?xml version="1.0" encoding="UTF-8"?>
2<?NLS type="org.eclipse.help.contexts"?>
3<!-- /*******************************************************************************
4 * Copyright (c) 2000, 2005 IBM Corporation and others.
5 * All rights reserved. This program and the accompanying materials
6 * are made available under the terms of the Eclipse Public License v1.0
7 * which accompanies this distribution, and is available at
8 * http://www.eclipse.org/legal/epl-v10.html
9 *
10 * Contributors:
11 * IBM Corporation - initial API and implementation
12 *******************************************************************************/ -->
13<contexts>
lmandelb5e1ef52006-01-23 08:17:13 +000014<context id="csh_outer_container">
15<description/>
16</context>
17<context id="webx0060">
18<description>This page lets you specify the line delimiter and the text encoding that will be used when you create or save an XML related file.
syeshin17ed4a62005-07-25 17:10:24 +000019
lmandelb5e1ef52006-01-23 08:17:13 +000020Various development platforms use different line delimiters to indicate the start of a new line. Select the operating system that corresponds to your development or deployment platform.
syeshin17ed4a62005-07-25 17:10:24 +000021
lmandelb5e1ef52006-01-23 08:17:13 +000022<b>Note:</b> This delimiter will not automatically be added to any documents that currently exist. It will be added only to documents that you create after you select the line delimiter type and click <b>Apply</b>, or to existing files that you open and then resave after you select the line delimiter type and click <b>Apply</b>.
syeshin17ed4a62005-07-25 17:10:24 +000023
lmandelb5e1ef52006-01-23 08:17:13 +000024The encoding attribute is used to specify the default character encoding set that is used when creating XML related files (DTDs, XML files, XML schemas). Changing the encoding causes any new, XML related files that are created from scratch to use the selected encoding.</description>
25<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/tedtenc.html" label="Specifying XML default encoding and line delimiters"/>
26</context>
27<context id="webx0061">
28<description>This page lets you specify the formatting and content assist preferences that will be used when editing an XML file.
syeshin17ed4a62005-07-25 17:10:24 +000029
lmandelb5e1ef52006-01-23 08:17:13 +000030Enter a maximum width in the <b>Line width</b> field to specify when a line should be broken to fit onto more than one line. This will be applied when the document is formatted.
syeshin17ed4a62005-07-25 17:10:24 +000031
lmandelb5e1ef52006-01-23 08:17:13 +000032Select <b>Split multiple attributes each on a new line</b> to start every attribute on a new line when the document is formatted.
syeshin17ed4a62005-07-25 17:10:24 +000033
lmandelb5e1ef52006-01-23 08:17:13 +000034Select <b>Clear all blank lines</b> to remove blank lines when the document is formatted.
syeshin17ed4a62005-07-25 17:10:24 +000035
lmandelb5e1ef52006-01-23 08:17:13 +000036Select <b>Indent using tabs</b> if you want to use tab characters (\t) as the standard formatting indentation.
syeshin17ed4a62005-07-25 17:10:24 +000037
lmandelb5e1ef52006-01-23 08:17:13 +000038If you prefer to use spaces, select <b>Indent using spaces</b>.
syeshin17ed4a62005-07-25 17:10:24 +000039
lmandelb5e1ef52006-01-23 08:17:13 +000040You can also specify the <b>Indentation size</b> which is the number of tabs or space characters used for formatting indentation.
syeshin17ed4a62005-07-25 17:10:24 +000041
lmandelb5e1ef52006-01-23 08:17:13 +000042To apply these formatting styles, right-click in your XML document, and click <b>Format &gt; Document</b>.
syeshin17ed4a62005-07-25 17:10:24 +000043
lmandelb5e1ef52006-01-23 08:17:13 +000044If the <b>Automatically make suggestions</b> check box is selected, you can specify that certain characters will cause the content assist list to pop up automatically. Specify these characters in the <b>Prompt when these characters are inserted</b> field.
syeshin17ed4a62005-07-25 17:10:24 +000045
lmandelb5e1ef52006-01-23 08:17:13 +000046If you select <b>Strict</b> from the <b>Suggestion strategy</b> list, suggestions that are grammatically valid will be shown first (with bold icons) in the content assist list. Other suggestions that are applicable to the element scope, but not grammatically valid, will be shown below them with a de-emphasized icon. The default value for this field is <b>Lax</b>.
syeshin17ed4a62005-07-25 17:10:24 +000047
lmandelb5e1ef52006-01-23 08:17:13 +000048If a DTD or schema (or other model) is not specified for an XML file, selecting <b>Use inferred grammar in absence of DTD/Schema</b> allows the editor to "guess" what elements or attributes are available based on existing content.</description>
49<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txprefs.html" label="Defining XML editor preferences"/>
50</context>
51<context id="webx0062">
52<description>This page lets you customize the syntax highlighting that the XML editor does when you are editing a file.
syeshin17ed4a62005-07-25 17:10:24 +000053
lmandelb5e1ef52006-01-23 08:17:13 +000054The <b>Content type</b> field contains a list of all the source types that you can select a highlighting style for. You can either select the content type that you want to work with from the drop-down list, or click text in the text sample window that corresponds to the content type for which you want to change the text highlighting.
syeshin17ed4a62005-07-25 17:10:24 +000055
lmandelb5e1ef52006-01-23 08:17:13 +000056The <b>Foreground</b> and <b>Background</b> buttons open <b>Color</b> dialog boxes that allow you to specify text foreground and background colors, respectively. Select the <b>Bold</b> check box to make the specified content type appear in bold.
syeshin17ed4a62005-07-25 17:10:24 +000057
lmandelb5e1ef52006-01-23 08:17:13 +000058Click the <b>Restore Defaults</b> button to set the highlighting styles back to their default values. If you only want to reset the value for a particular content type, select it in the <b>Content type</b> field, the click the <b>Restore Default</b> button next to it.</description>
59<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/ttaghilt.html" label="Setting source highlighting styles"/>
60</context>
61<context id="webx0063">
62<description>This page lets you create new templates and edit existing ones that can be used when editing an XML file. A template is a chunk of predefined code that you can insert into a file.
syeshin17ed4a62005-07-25 17:10:24 +000063
lmandelb5e1ef52006-01-23 08:17:13 +000064Click <b>New</b> if you want to create a completely new template.
syeshin17ed4a62005-07-25 17:10:24 +000065
lmandelb5e1ef52006-01-23 08:17:13 +000066Supply a new template <b>Name</b> and <b>Description</b>. The <b>Context</b> for the template is the context in which the template is available in the proposal list when content assist is requested. Specify the <b>Pattern</b> for your template using the appropriate tags, attributes, or attribute values to be inserted by content assist.
syeshin17ed4a62005-07-25 17:10:24 +000067
lmandelb5e1ef52006-01-23 08:17:13 +000068If you want to insert a variable, click the <b>Insert Variable</b> button and select the variable to be inserted. For example, the <b>date</b> variable indicates the current date will be inserted.
syeshin17ed4a62005-07-25 17:10:24 +000069
lmandelb5e1ef52006-01-23 08:17:13 +000070You 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.
syeshin17ed4a62005-07-25 17:10:24 +000071
lmandelb5e1ef52006-01-23 08:17:13 +000072If you have a template that you do not want to remove but you no longer want it to appear in the content assist list, clear its check box in the <b>Templates</b> preferences page.</description>
73<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/twmacro.html" label="Working with XML templates"/>
74</context>
75<context id="xmlm1200">
76<description>Cleanup options enable you to update a document so that it is well-formed and consistently formatted.
syeshin17ed4a62005-07-25 17:10:24 +000077
lmandelb5e1ef52006-01-23 08:17:13 +000078The following cleanup options can be set to on or off, so that you can limit the type of cleanup performed:
syeshin17ed4a62005-07-25 17:10:24 +000079
lmandelb5e1ef52006-01-23 08:17:13 +000080- <b>Compress empty element tags</b>: Compress element tags with no content to one tag with an end tag delimiter (ie: change &lt;tag&gt;&lt;/tag&gt; to &lt;tag/&gt;).
syeshin17ed4a62005-07-25 17:10:24 +000081
lmandelb5e1ef52006-01-23 08:17:13 +000082- <b>Insert required attributes</b>: Inserts any missing attributes that are required by the tag to make the element or document well-formed.
syeshin17ed4a62005-07-25 17:10:24 +000083
lmandelb5e1ef52006-01-23 08:17:13 +000084- <b>Insert missing tags</b>: Completes any missing tags (such as adding an end tag) necessary to make the element or document well-formed.
syeshin17ed4a62005-07-25 17:10:24 +000085
lmandelb5e1ef52006-01-23 08:17:13 +000086- <b>Quote attribute values</b>: Appropriately adds double- or single-quotes before and after attribute values if they are missing.
syeshin17ed4a62005-07-25 17:10:24 +000087
lmandelb5e1ef52006-01-23 08:17:13 +000088- <b>Format source</b>: Formats the document just as the <b>Format Document</b> context menu option does, immediately after performing any other specified <b>Cleanup</b> options.
syeshin17ed4a62005-07-25 17:10:24 +000089
lmandelb5e1ef52006-01-23 08:17:13 +000090- <b>Convert line delimiters to</b>: Converts all line delimiters in the file to the selected operating system's type.</description>
91<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtsrc.html" label="Editing in the Source view"/>
92</context>
93<context id="xcui0500">
94<description>Enter the name of the attribute in the <b>Name</b> field, then enter the value of the attribute in the <b>Value</b> field. Click <b>OK</b>. The attribute will be added to the file.</description>
95<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
96</context>
97<context id="xcui0010">
98<description>The DOCTYPE declaration in an XML file is used at the beginning of it to associate it with a DTD file. You can use the <b>Public ID</b> field to create an association using an XML Catalog entry or the <b>System ID</b> field to create an association using a file in the workbench.</description>
99<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
100<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/tedtdoc.html" label="Editing DOCTYPE declarations"/>
101</context>
102<context id="xcui0020">
103<description>This should match the name of your XML file's root element.</description>
104<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
105<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/tedtdoc.html" label="Editing DOCTYPE declarations"/>
106</context>
107<context id="xcui0030">
108<description>The value in this field is the Public Identifier. It is used to associate the XML file (using an XML catalog entry) with a DTD file by providing a hint to the XML processor.</description>
109<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
110<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/tedtdoc.html" label="Editing DOCTYPE declarations"/>
111</context>
112<context id="xcui0050">
113<description>The value in this field is the DTD the XML file is associated with. You can change the DTD the file is associated with by editing this field. The XML processor will try to use the Public ID to locate the DTD, and if this fails, it will use the System ID to find it.</description>
114<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
115<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/tedtdoc.html" label="Editing DOCTYPE declarations"/>
116</context>
117<context id="xcui0600">
118<description>Enter the name of the element in the <b>Element name</b> field, then click <b>OK</b>. The element will be added to the file.</description>
119<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
120</context>
121<context id="xcui0300">
122<description>A processing instruction is a syntax in XML for passing instructions along to the application using an XML document. The <b>Target</b> field is used to identify the application the instructions belongs to. The <b>Data</b> field contains the instructions.</description>
123<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
124<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/tedtproc.html" label="Editing XML processing instructions"/>
125</context>
126<context id="xcui0100">
127<description>This is a read-only dialog. Select the entry you want to edit and click <b>Edit</b>.</description>
128<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
129<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing your namespace information"/>
130</context>
131<context id="xcui0200">
132<description>The value in the <b>Namespace Name</b> field is the namespace the XML file belongs to.
lmandel528034a2005-12-07 07:43:11 +0000133
lmandelb5e1ef52006-01-23 08:17:13 +0000134All qualified elements and attributes in the XML file associated with the namespace will be prefixed with the <b>Prefix</b> value.
lmandel528034a2005-12-07 07:43:11 +0000135
lmandelb5e1ef52006-01-23 08:17:13 +0000136The <b>Location Hint</b> field contains the location of the XML schema the XML file is associated with. An XML Catalog ID or a URI can be specified in this field. You can search for the schema you want to use by clicking <b>Browse</b>. Once you select a file, the <b>Namespace Name</b> and <b>Prefix</b> fields will automatically be filled with the appropriate values from the schema (you must leave the fields blank for this to occur). <b>Note</b>: If you are creating an XML file from an XML schema, you cannot change the <b>Namespace Name</b> or <b>Location Hint</b> values.</description>
137<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing in the Design view"/>
138<topic href="../org.eclipse.wst.xmleditor.doc.user/topics/txedtdes.html" label="Editing your namespace information"/>
139</context>
140<context id="xcui0400">
141<description>An XML Catalog entry contains two parts - a Key (which represents a DTD or XML schema) and a URI (which contains information about a DTD or XML schema's location). Select the catalog entry you want to associate your XML file with.</description>
142</context>
syeshin17ed4a62005-07-25 17:10:24 +0000143</contexts>