Annotations

You use an annotation element to provide information about the XML Schema. You can annotate any node in your XML Schema. The annotation element always contains at least one appInfo or documentation node. Any text you want to enter must be entered in one of these nodes.

Diagram View

When you create an annotation in the Diagram tab, you create the element and specify its subelement ( appInfo or documentation) in the Diagram tab. You enter the text that describes it in either the text pane in the Diagram tab or in the Text tab.

To add an annotation:

1. Right-click the node you want to annotate.

2. Select Add > Annotation from the shortcut menu.

The annotation icon appears in the Diagram tab .

3. Right-click the annotation icon and select the type of annotation you want to define - appInfo (

)or documentation (

4. In the text pane (or the Text tab if you prefer), type the text for the appInfo or documentation node.


Tip		Stylus Studio's backmapper identifies the line representing the element you created in step 3 in both the text pane on the Diagram tab and the Text tab.

Tree View

To add an annotation:

1. Click the node you want to annotate.

2. In the left tool bar, click New Annotation

. Stylus Studio creates and selects an Annotation node.

3. In the left tool bar, click New Documentation

or New Application Info

4. If you added documentation, in the Properties window, double-click the Source field and type the URL or file path for the documentation you want to include in the schema, and press Enter.

Double-click the Language field and enter the language of the contents of the source file.

5. In the left tool bar, click New Text

. In the Tree view, Stylus Studio displays a field for the new text.

Moving a Comment or Annotation

If the parent of the new comment or annotation node has more than one child, you can move the comment or annotation with the up or down arrow. However, you cannot move the comment or annotation out of the scope of its parent.

< Previous | Next >