kprice | 159fa58 | 2006-05-08 21:30:45 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="utf-8"?>
|
| 2 | <!--Arbortext, Inc., 1988-2005, v.4002-->
|
kprice | 647b735 | 2006-05-17 21:27:16 +0000 | [diff] [blame] | 3 | <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
|
| 4 | "task.dtd">
|
kprice | 159fa58 | 2006-05-08 21:30:45 +0000 | [diff] [blame] | 5 | <task id="refactoring" xml:lang="en-us">
|
| 6 | <title>Refactoring in XML Schema Files</title>
|
| 7 | <titlealts>
|
| 8 | <searchtitle>Refactoring in XML Schema Files</searchtitle>
|
| 9 | </titlealts>
|
| 10 | <shortdesc>Within an XML Schema file, refactoring allows authors to make a
|
| 11 | single artifact change, and have that change implemented throughout all other
|
| 12 | dependant artifacts.</shortdesc>
|
| 13 | <prolog><metadata>
|
kprice | 9623e9d | 2007-05-03 03:43:05 +0000 | [diff] [blame] | 14 | <keywords><indexterm>dependent artifacts<indexterm>refactorting XML schema files</indexterm></indexterm>
|
| 15 | <indexterm>refactoring<indexterm>XML schema files</indexterm></indexterm>
|
| 16 | <indexterm>renaming<indexterm>XML schema files</indexterm></indexterm>
|
| 17 | <indexterm>XML schemas<indexterm>editing</indexterm></indexterm>
|
| 18 | </keywords>
|
kprice | 159fa58 | 2006-05-08 21:30:45 +0000 | [diff] [blame] | 19 | </metadata></prolog>
|
| 20 | <taskbody>
|
| 21 | <prereq></prereq>
|
| 22 | <context>Refactoring eliminates the need for the tedious editing necessary
|
| 23 | to recover broken dependencies caused by artifact changes which cause ripple
|
| 24 | effects on other dependant artifacts (such as renaming an XML Schema element).</context>
|
| 25 | <steps>
|
| 26 | <step><cmd>Create a new XML schema or double-click an existing schema in the
|
| 27 | Navigator view.</cmd><info> It will automatically open in the XML schema editor.</info>
|
| 28 | </step>
|
| 29 | <step><cmd>To refactor an artifact, position cursor within the artifact, right-click
|
| 30 | the artifact, click <menucascade><uicontrol>Refactor</uicontrol><uicontrol>Rename</uicontrol>
|
| 31 | </menucascade></cmd><info>A popup dialog will request the entry of a new name
|
| 32 | for that artifact</info>
|
| 33 | <substeps>
|
| 34 | <substep><cmd>Type in the new name of the artifact.</cmd></substep>
|
kprice | 9623e9d | 2007-05-03 03:43:05 +0000 | [diff] [blame] | 35 | <substep><cmd>(Optional) Click <b>Preview</b>.</cmd><info>A window
|
kprice | 647b735 | 2006-05-17 21:27:16 +0000 | [diff] [blame] | 36 | will open indicating all of the changes which will take place due to the refactoring.</info>
|
kprice | 159fa58 | 2006-05-08 21:30:45 +0000 | [diff] [blame] | 37 | </substep>
|
| 38 | <substep><cmd>Click <uicontrol>OK.</uicontrol></cmd></substep>
|
| 39 | </substeps>
|
| 40 | </step>
|
| 41 | </steps>
|
| 42 | <result>The new name will be entered in the opened XSD source, as well as
|
| 43 | in all dependant artifacts</result>
|
| 44 | <example><b><u>Component References in XML Schema</u></b><simpletable>
|
| 45 | <sthead>
|
| 46 | <stentry>Global named components</stentry>
|
| 47 | <stentry>Reference</stentry>
|
| 48 | </sthead>
|
| 49 | <strow>
|
| 50 | <stentry><ul>
|
| 51 | <li><element name="foo"></li>
|
| 52 | </ul></stentry>
|
| 53 | <stentry><ul>
|
| 54 | <li><element ref="foo"></li>
|
| 55 | <li><element substitutionGroup="foo"</li>
|
| 56 | </ul></stentry>
|
| 57 | </strow>
|
| 58 | <strow>
|
| 59 | <stentry><ul>
|
| 60 | <li><simple/complexType name="foo"></li>
|
| 61 | </ul></stentry>
|
| 62 | <stentry><ul>
|
| 63 | <li><element type="foo"></li>
|
| 64 | <li><attribute type="foo"></li>
|
| 65 | <li><restriction base="foo"></li>
|
| 66 | <li><substitution base="foo"></li>
|
| 67 | </ul></stentry>
|
| 68 | </strow>
|
| 69 | <strow>
|
| 70 | <stentry><ul>
|
| 71 | <li><attribute name="foo"></li>
|
| 72 | </ul></stentry>
|
| 73 | <stentry><ul>
|
| 74 | <li><attribute ref="foo"></li>
|
| 75 | </ul></stentry>
|
| 76 | </strow>
|
| 77 | <strow>
|
| 78 | <stentry><ul>
|
| 79 | <li><attributeGroup name="foo"></li>
|
| 80 | </ul></stentry>
|
| 81 | <stentry><ul>
|
| 82 | <li><attributeGroup ref="foo"></li>
|
| 83 | </ul></stentry>
|
| 84 | </strow>
|
| 85 | <strow>
|
| 86 | <stentry><ul>
|
| 87 | <li><group name="foo"></li>
|
| 88 | </ul></stentry>
|
| 89 | <stentry><ul>
|
| 90 | <li><group ref="foo"></li>
|
| 91 | </ul></stentry>
|
| 92 | </strow>
|
| 93 | </simpletable></example>
|
| 94 | <postreq></postreq>
|
| 95 | </taskbody>
|
| 96 | </task>
|
kprice | 647b735 | 2006-05-17 21:27:16 +0000 | [diff] [blame] | 97 | <?Pub *0000003131?>
|