xml.schema/javahelp/org/netbeans/modules/xml/schema/tasks/addingdocumentation.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>Adding a documentation Component to an XML Schema File</title>
52 <h2>Adding a <tt>documentation</tt> Component to an XML Schema File</h2>
53 <p><small><a href="#seealso">See Also</a></small></p>
54 <p>XML schema tools lets you work with <tt>annotation</tt> components and <tt>documentation</tt> sub components. <tt>documentation</tt> schema components must reside inside an <tt>annotation</tt> component.</p>
56 <p><b>To add a <tt>documentation</tt> component:</b></p>
58 <li>In the IDE, open the schema file where you want to add the <tt>documentation</tt> component.</li>
59 <li>If the parent <tt>annotation</tt> component does not exist, create it now.</li>
60 <li>In the Schema view, right-click the <tt>annotation</tt> node where you want to add the <tt>documentation</tt> component and choose Add Documentation.<br>
61 The IDE adds a <tt>documentation</tt> node.</li>
62 <li>In the Schema view, right-click the <tt>documentation</tt> node choose Customize.<br>
63 The Documentation Customizer dialog box opens.</li>
64 <li>In the text field, enter the schema comments and click OK.</li>
68 <li>You can change the language identifier of the <tt>documentation</tt> schema component using the Properties window.</li>
72 <dt><a name="seealso">See Also</a></dt>
73 <dd><a href="addingannotation.html" title="Adding an annotation Component to an XML Schema File">Adding an <tt>annotation</tt> Component to an XML Schema File</a></dd>
74 <dd><a href="../customizers/documentation.html" title="Documentation Customizer Dialog Box">Documentation Customizer Dialog Box</a></dd>
75 <dd><a href="../about.html" title="About XML Schema Tools">About XML Schema Tools</a></dd>
78 <small><a href="../credits.html">Legal Notices</a></small>
79 <table cellpadding="150" border="0">
80 <tr><td> </td></tr>
81 <tr><td> </td></tr>
82 <tr><td> </td></tr>