xml.schema/javahelp/org/netbeans/modules/xml/schema/tasks/usingcodecompletion-oneschema.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5 Copyright 2009-2017 Oracle and/or its affiliates. All rights reserved.
7 Oracle and Java are registered trademarks of Oracle and/or its affiliates.
8 Other names may be trademarks of their respective owners.
10 The contents of this file are subject to the terms of either the GNU
11 General Public License Version 2 only ("GPL") or the Common
12 Development and Distribution License("CDDL") (collectively, the
13 "License"). You may not use this file except in compliance with the
14 License. You can obtain a copy of the License at
15 http://www.netbeans.org/cddl-gplv2.html
16 or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
17 specific language governing permissions and limitations under the
18 License. When distributing the software, include this License Header
19 Notice in each file and include the License file at
20 nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
21 particular file as subject to the "Classpath" exception as provided
22 by Oracle in the GPL Version 2 section of the License file that
23 accompanied this code. If applicable, add the following below the
24 License Header, with the fields enclosed by brackets [] replaced by
25 your own identifying information:
26 "Portions Copyrighted [year] [name of copyright owner]"
30 The Original Software is NetBeans. The Initial Developer of the Original
31 Software is Sun Microsystems, Inc. Portions Copyright 2009-2010 Sun
32 Microsystems, Inc. All Rights Reserved.
34 If you wish your version of this file to be governed by only the CDDL
35 or only the GPL Version 2, indicate your decision by adding
36 "[Contributor] elects to include this software in this distribution
37 under the [CDDL or GPL Version 2] license." If you do not indicate a
38 single choice of license, a recipient has the option to distribute
39 your version of this file under either the CDDL, the GPL Version 2 or
40 to extend the choice of license to its licensees as provided above.
41 However, if you add GPL Version 2 code and therefore, elected the GPL
42 Version 2 license, then the option applies only if the new code is
43 made subject to such option by the copyright holder.
47 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
48 <link rel="stylesheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
49 <title>Using Code Completion in XML Documents Constrained by a Single XML Schema</title>
52 <h2>Using Code Completion in XML Documents Constrained by a Single XML Schema</h2>
53 <p><small><a href="#seealso">See Also</a></small></p>
54 <p>You can use code completion in XML files if the XML document is constrained by an XML schema. In the XML instance document, 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>
56 <p><b>To create an XML document constrained by an XML schema and invoke code completion:</b></p>
58 <li>From the main menu, choose File > New File.<br>
59 The New File wizard opens.</li>
60 <li>Under Categories, select the <tt>XML</tt> node and under File Types, select the <tt>XML Document</tt> node, then click Next.</li>
61 <li>Specify a name and location for the document and click Next.</li>
62 <li>Select the XML Schema-Constrained Document radio button and click Next.</li>
63 <li>Click the Browse button next to the Schema URI field to navigate to and select the schema file that will constrain the XML instance document.<br>
64 When you have selected the schema file, the IDE fills in the Document Namespace and Root Element fields. If the schema has no target namespace, the Document Namespace field is blank.</li>
65 <li>If the schema has more than one root element, select the element you want to use for the constraint from the Root Element drop-down list.</li>
67 The IDE adds a node for the new <tt>.xml</tt> file in the Projects window, and the new file is open in the Source Editor.</li>
68 <li>In the Source Editor tab of the XML document, position the cursor where you want to start adding content and type an opening left angle bracket (<tt><</tt>).<br>
69 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>
72 <p><b>To constrain an existing XML document by an XML schema and invoke code completion:</b></p>
74 <li>Make a note of the following information from the schema file:<br>
76 <li>The <tt>targetNamespace</tt> value (<tt><i>schema-targetNamespace</i></tt>)</li>
77 <li>The root or top-level element that you want to use for the constraint (<tt><i>schema-root-element</i></tt>)</li>
79 <li>Open the XML document in the Source Editor.</li>
80 <li>In the XML document, replace the <tt><root></tt> tag with the following tag:<br>
82 <<i>schema-root-element</i>
83 xmlns='<i>schema-targetNamespace</i>'
84 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
85 xsi:schemaLocation='<i>schema-targetNamespace</i> <i>path-to-schema</i>/<i>schema</i>.xsd'>
87 If the schema has no <tt>targetNamespace</tt>, use the following tag:
89 <<i>schema-root-element</i>
90 xmlns:<i>prefix</i>='<i>schema-targetNamespace</i>'
91 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
92 xsi:noNamespaceSchemaLocation='<i>path-to-schema</i>/<i>schema</i>.xsd'>
94 <li>Replace the <tt></root></tt> tag with the following:<br>
96 </<i>schema-root-element</i>>
98 <li>Save your changes.</li>
99 <li>In the Source Editor tab of the XML document, position the cursor where you want to start adding content and type an opening left angle bracket (<tt><</tt>).<br>
100 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>
104 <dt><a name="seealso">See Also</a></dt>
105 <dd><a href="usingcodecompletion.html" title="About Using Code Completion in XML Instance Documents Constrained by XML Schema">About Using Code Completion in XML Instance Documents Constrained by XML Schema</a></dd>
106 <dd><a href="../about.html" title="About XML Schema Tools">About XML Schema Tools</a></dd>
109 <small><a href="../credits.html">Legal Notices</a></small>
110 <table cellpadding="150" border="0">
111 <tr><td> </td></tr>
112 <tr><td> </td></tr>
113 <tr><td> </td></tr>