| <?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> |
| <head> |
| <!-- /******************************************************************************* |
| * Copyright (c) 2000, 2005 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 |
| *******************************************************************************/ --> |
| <link rel="stylesheet" type="text/css" href="../../org.eclipse.wst.doc.user/common.css" /> |
| <title>Adding an include element</title> |
| </head> |
| <body id="taddincl"><a name="taddincl"><!-- --></a> |
| |
| <h1 class="topictitle1">Adding an include element</h1> |
| <div><p>As schemas become larger, it is often desirable to divide their |
| content among several schema documents for purposes such as ease of maintenance, |
| reuse, and readability. XML schema defines two constructs to support this: <i>include</i> and |
| <i>import</i>. The include element brings in definitions and declarations |
| from the included schema into the current schema. It requires the included |
| schema to be in the same target namespace as the including schema. The import |
| element behaves in a similar way, with the exception that the imported schema |
| can come from a different namespace.</p><div class="skipspace"><p>In the XML schema editor, you can add an include element to an |
| XML schema. Before you can do this, you must create an XML schema and open |
| it in the XML schema editor (you can open an XML schema in the XML schema |
| editor by double-clicking it).</p> |
| <p>The following instructions were written |
| for the XML perspective, but they will also work in many other perspectives. </p> |
| <p>To |
| add an include element , follow these steps:</p> |
| </div> |
| <ol><li class="skipspace"><span>Open your XML schema in the XML schema editor.</span></li> |
| <li class="skipspace"><span>In the Outline view, select your schema.</span> The entire |
| schema and its contents should be displayed in the Graph view.</li> |
| <li class="skipspace"><span>In the Graph view, right click in the <b>Directives</b> section |
| and click <span class="uicontrol">Add Include</span>.</span></li> |
| <li class="skipspace"><span>In the Properties view, click the <b>General</b> tab and click |
| the <span class="uicontrol">More</span> button to the right of the <span class="uicontrol">Schema |
| location</span> field.</span> The XML schema file you select must |
| have the same namespace as the current schema.</li> |
| <li class="skipspace"><span>If you want to select an XML schema located in the |
| workbench, select the <span class="uicontrol">Workbench projects</span> radio button |
| and click <span class="uicontrol">Next</span>. </span><ol type="a"><li><span>Select the schema you want to include and click <span class="uicontrol">Finish</span>.</span></li> |
| </ol> |
| </li> |
| <li class="skipspace"><span>If you want to select an XML schema located on the Web, select |
| the <span class="uicontrol">HTTP</span> radio button and click <span class="uicontrol">Next</span>.</span><ol type="a"><li><span>Type the URL of the XML schema and click <span class="uicontrol">Finish</span>. </span></li> |
| </ol> |
| <div class="note"><span class="notetitle">Note: </span> A local copy of the schema will not be stored in the workbench. |
| Every time you validate your schema, the schema's contents will be checked |
| from the URL you specify.</div> |
| </li> |
| <li class="skipspace"><span>The XML schema editor will retrieve the location of the included |
| XML schema file and display it as read-only in the <span class="uicontrol">Schema location</span> field.</span></li> |
| <li class="skipspace"><span>Click the <span class="uicontrol">Documentation</span> tab if you want |
| to provide any information about this include element.</span> The <span class="uicontrol">Documentation</span> page |
| is used for human readable material, such as a description, and the <span class="uicontrol">App |
| Info</span> page can be used to provide information for applications. </li> |
| </ol> |
| <div class="skipspace"><p>Once you have added the include element to your XML schema, when |
| you define new elements, attributes, complex types, or simple types where |
| you can specify type information, any declarations from the included schema |
| will be available in the <span class="uicontrol">Type</span> list for the element, |
| attribute, complex or simple type.</p> |
| <p>For example, if Address.xsd has the |
| following content:</p> |
| <pre><complexType name="Address"> |
| <sequence> |
| <element name="name" type="string"> |
| <element name="street" type="string"> |
| </sequence> |
| </complexType></pre> |
| and you have an XML schema called PurchaseOrder.xsd that has added |
| an include for Address.xsd, then when defining a new element in PurchaseOrder, |
| you can select Address as its type. <p>(c) Copyright 2001, World Wide Web |
| Consortium (Massachusetts Institute of Technology, Institut National de Recherche |
| en Informatique et en Automatique, Keio University).</p> |
| </div> |
| </div> |
| |
| <div><p><b class="reltaskshd">Related tasks</b><br /> |
| <a href="../topics/taddimpt.html" title="As schemas become larger, it is often desirable to divide their content among several schema documents for purposes such as ease of maintenance, reuse, and readability. XML schema defines two constructs to support this: include and import. The include element brings in definitions and declarations from the included schema into the current schema. It requires the included schema to be in the same target namespace as the including schema. The import element behaves in a similar way, with the exception that the imported schema can come from a different namespace.">Adding an import element</a><br /> |
| <a href="../topics/taddrdfn.html" title="You can use the redefine mechanism to redefine simple and complex types, groups, and attribute groups obtained from external schema files. Like the include mechanism, redefine requires the external components to be in the same target namespace as the redefining schema, although external components from schemas that have no namespace can also be redefined.">Adding a redefine element</a><br /> |
| </p> |
| <p><b class="relrefhd">Related reference</b><br /> |
| <a href="../topics/rnmspc.html" title="">XML namespaces</a><br /> |
| </p> |
| </div> |
| </body> |
| </html> |
