|
samaresh@338
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
samaresh@338
|
2 |
<!--
|
|
mkristofic@1584
|
3 |
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
|
mkristofic@1584
|
4 |
|
|
mkristofic@1584
|
5 |
Copyright 2009-2017 Oracle and/or its affiliates. All rights reserved.
|
|
mkristofic@1584
|
6 |
|
|
mkristofic@1584
|
7 |
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
|
|
mkristofic@1584
|
8 |
Other names may be trademarks of their respective owners.
|
|
mkristofic@1584
|
9 |
|
|
mkristofic@1584
|
10 |
The contents of this file are subject to the terms of either the GNU
|
|
mkristofic@1584
|
11 |
General Public License Version 2 only ("GPL") or the Common
|
|
mkristofic@1584
|
12 |
Development and Distribution License("CDDL") (collectively, the
|
|
mkristofic@1584
|
13 |
"License"). You may not use this file except in compliance with the
|
|
mkristofic@1584
|
14 |
License. You can obtain a copy of the License at
|
|
mkristofic@1584
|
15 |
http://www.netbeans.org/cddl-gplv2.html
|
|
mkristofic@1584
|
16 |
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
|
|
mkristofic@1584
|
17 |
specific language governing permissions and limitations under the
|
|
mkristofic@1584
|
18 |
License. When distributing the software, include this License Header
|
|
mkristofic@1584
|
19 |
Notice in each file and include the License file at
|
|
mkristofic@1584
|
20 |
nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
|
|
mkristofic@1584
|
21 |
particular file as subject to the "Classpath" exception as provided
|
|
mkristofic@1584
|
22 |
by Oracle in the GPL Version 2 section of the License file that
|
|
mkristofic@1584
|
23 |
accompanied this code. If applicable, add the following below the
|
|
mkristofic@1584
|
24 |
License Header, with the fields enclosed by brackets [] replaced by
|
|
mkristofic@1584
|
25 |
your own identifying information:
|
|
mkristofic@1584
|
26 |
"Portions Copyrighted [year] [name of copyright owner]"
|
|
mkristofic@1584
|
27 |
|
|
mkristofic@1584
|
28 |
Contributor(s):
|
|
mkristofic@1584
|
29 |
|
|
mkristofic@1584
|
30 |
The Original Software is NetBeans. The Initial Developer of the Original
|
|
mkristofic@1584
|
31 |
Software is Sun Microsystems, Inc. Portions Copyright 2009-2010 Sun
|
|
mkristofic@1584
|
32 |
Microsystems, Inc. All Rights Reserved.
|
|
mkristofic@1584
|
33 |
|
|
mkristofic@1584
|
34 |
If you wish your version of this file to be governed by only the CDDL
|
|
mkristofic@1584
|
35 |
or only the GPL Version 2, indicate your decision by adding
|
|
mkristofic@1584
|
36 |
"[Contributor] elects to include this software in this distribution
|
|
mkristofic@1584
|
37 |
under the [CDDL or GPL Version 2] license." If you do not indicate a
|
|
mkristofic@1584
|
38 |
single choice of license, a recipient has the option to distribute
|
|
mkristofic@1584
|
39 |
your version of this file under either the CDDL, the GPL Version 2 or
|
|
mkristofic@1584
|
40 |
to extend the choice of license to its licensees as provided above.
|
|
mkristofic@1584
|
41 |
However, if you add GPL Version 2 code and therefore, elected the GPL
|
|
mkristofic@1584
|
42 |
Version 2 license, then the option applies only if the new code is
|
|
mkristofic@1584
|
43 |
made subject to such option by the copyright holder.
|
|
samaresh@338
|
44 |
-->
|
|
samaresh@338
|
45 |
<html>
|
|
samaresh@338
|
46 |
<head>
|
|
psmejkal@1107
|
47 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
samaresh@338
|
48 |
<link rel="stylesheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
|
|
jeff_rubinoff@806
|
49 |
<title>Overview of Code Completion in Schema-Constrained XML Documents</title>
|
|
samaresh@338
|
50 |
</head>
|
|
samaresh@338
|
51 |
<body>
|
|
jeff_rubinoff@806
|
52 |
<h2>Overview of Code Completion in Schema-Constrained XML Documents</h2>
|
|
samaresh@338
|
53 |
<p><small><a href="#seealso">See Also</a></small></p>
|
|
samaresh@338
|
54 |
<p>You can use code completion in XML files if the XML document is constrained by an XML schema. In the schema source file, this constraint is represented by a <tt>xsi:schemaLocation</tt> or a <tt>xsi:noNamespaceSchemaLocation</tt> attribute in the root element of the schema. Typically, <tt>xsi:schemaLocation</tt> is used for schemas with a target namespace and <tt>xsi:noNamespaceSchemaLocation</tt> is used for schemas with no target namespace.</p>
|
|
samaresh@338
|
55 |
<p>As a general rule, if the root elements provide the necessary information to locate the schemas, the IDE will be able to offer code completion based on those schemas. The IDE will attempt to locate the schemas in the following order:</p>
|
|
samaresh@338
|
56 |
<ol>
|
|
samaresh@338
|
57 |
<li>Check the local file system to find the schema.</li>
|
|
samaresh@338
|
58 |
<li>If not found in the local file system, perform a lookup in the runtime catalog.</li>
|
|
jeff_rubinoff@806
|
59 |
<li>If not found, try to fetch them from the internet, cache them locally and use them to provide CC</li>
|
|
samaresh@338
|
60 |
</ol>
|
|
samaresh@338
|
61 |
<p>The code completion functionality provides two types of code completion:</p>
|
|
samaresh@338
|
62 |
<ul>
|
|
samaresh@338
|
63 |
<li><b>Element code completion.</b> When you type a starting tag (<) inside an existing parent element, you will see a list of child elements for that parent element. For example, assume that your schema has parent element called <tt>purchaseOrder</tt>. When you type the starting tag (<), you will see all the child elements of <tt>purchaseOrder</tt> in the code completion box.</li>
|
|
samaresh@338
|
64 |
<li><b>Attribute code completion.</b> When you press Spacebar inside an element tag, the code completion box will open with a list of attributes for that element.</li>
|
|
samaresh@338
|
65 |
</ul>
|
|
samaresh@338
|
66 |
|
|
samaresh@338
|
67 |
<p>You can use code completion in XML instance documents in several ways:</p>
|
|
samaresh@338
|
68 |
<ul>
|
|
jeff_rubinoff@806
|
69 |
<li><a href="usingcodecompletion-oneschema.html" title="Using Code Completion in XML Instance Documents Constrained by an XML Schema">Using Code Completion in XML Documents Constrained by a Single XML Schema</a></li>
|
|
jeff_rubinoff@806
|
70 |
<li><a href="usingcodecompletion-multi-schemas.html" title="Using Code Completion in XML Documents Constrained by Multiple XML Schemas">Using Code Completion in XML Documents Constrained by Multiple XML Schemas</a></li>
|
|
samaresh@338
|
71 |
<li><a href="usingcodecompletion-xml-catalog.html" title="Using Code Completion in XML Files Constrained by an XML Catalog">Using Code Completion in XML Files Constrained by an XML Catalog</a></li>
|
|
samaresh@338
|
72 |
</ul>
|
|
samaresh@338
|
73 |
<p><b>To complete an XML tag in an XML document:</b></p>
|
|
samaresh@338
|
74 |
<ol>
|
|
samaresh@338
|
75 |
<li>Open the XML document in the Source Editor and position the cursor where you want to start adding content and type an opening left angle bracket (<tt><</tt>).<br>
|
|
samaresh@338
|
76 |
If you want to use code completion in an existing element, simply position your cursor within the element and press Spacebar or type any character to invoke code completion.</li>
|
|
samaresh@338
|
77 |
<li>Pause after step 1, or press Ctrl-Spacebar.<br>
|
|
samaresh@338
|
78 |
The code completion box opens. This box provides a scrolling list of schema elements. The list of elements is based on the XML schema file that constrains the current XML file.</li>
|
|
samaresh@338
|
79 |
<li>Select a value using the information in <a href="#selectvalues">Selecting Values in the Code Completion Box</a>.<br>
|
|
samaresh@338
|
80 |
If you select a component with attributes, the next Spacebar keystroke will invoke the code completion box with the attributes.</li>
|
|
samaresh@338
|
81 |
</ol>
|
|
samaresh@338
|
82 |
|
|
samaresh@338
|
83 |
<h3><a name="selectvalues">Selecting Values in the Code Completion Box</a></h3>
|
|
samaresh@338
|
84 |
<p>You can use the most convenient combination of the following options to select values in the code completion box:</p>
|
|
samaresh@338
|
85 |
<ul>
|
|
samaresh@338
|
86 |
<li>Continue typing to fine tune the selection of items in the list.</li>
|
|
samaresh@338
|
87 |
<li>Use the mouse or navigation keys (up and down arrows, Page Up, Page Down, Home, and End) to scroll through the list and select an entry.</li>
|
|
samaresh@338
|
88 |
<li>Press Enter to enter the selection in the completion box into your file and close the completion box. Alternatively, you can double-click an entry in the code completion box.</li>
|
|
samaresh@338
|
89 |
</ul>
|
|
samaresh@338
|
90 |
|
|
samaresh@338
|
91 |
<dl>
|
|
samaresh@338
|
92 |
<dt><a name="seealso">See Also</a></dt>
|
|
samaresh@338
|
93 |
<dd><a href="../about.html" title="About XML Schema Tools">About XML Schema Tools</a></dd>
|
|
samaresh@338
|
94 |
<dd><a href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/editing/codecompletion/intro.html" title="Using Code Completion">Using Code Completion</a></dd>
|
|
samaresh@338
|
95 |
<dd><a href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/xml/catalog/xmlcatalog_mount.html" title="Registering a Local DTD or XML Schema Resource">Registering a Local DTD or XML Schema Resource</a></dd>
|
|
samaresh@338
|
96 |
</dl>
|
|
samaresh@338
|
97 |
<hr>
|
|
samaresh@338
|
98 |
<small><a href="../credits.html">Legal Notices</a></small>
|
|
samaresh@338
|
99 |
<table cellpadding="150" border="0">
|
|
samaresh@338
|
100 |
<tr><td> </td></tr>
|
|
samaresh@338
|
101 |
<tr><td> </td></tr>
|
|
samaresh@338
|
102 |
<tr><td> </td></tr>
|
|
samaresh@338
|
103 |
</table>
|
|
samaresh@338
|
104 |
</body>
|
|
samaresh@338
|
105 |
</html>
|
|
samaresh@338
|
106 |
|