blob: 75078b0b7fe9a82b21e22f38ffc58db1031fe549 [file] [log] [blame]
syeshinf3d0d4b2005-07-27 18:33:03 +00001<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "">
syeshinaaa21932005-09-22 17:13:22 +00006<!-- /*******************************************************************************
7 * Copyright (c) 2000, 2005 IBM Corporation and others.
8 * All rights reserved. This program and the accompanying materials
9 * are made available under the terms of the Eclipse Public License v1.0
10 * which accompanies this distribution, and is available at
11 *
12 *
13 * Contributors:
14 * IBM Corporation - initial API and implementation
15 *******************************************************************************/ -->
syeshin8f077832005-09-06 04:22:45 +000016<link rel="stylesheet" type="text/css" href="../../org.eclipse.wst.doc.user/common.css" />
syeshind0bdb8e2005-10-27 17:44:14 +000017<title>Adding notations</title>
syeshin8f077832005-09-06 04:22:45 +000018</head>
syeshinf3d0d4b2005-07-27 18:33:03 +000019<body id="taddnot"><a name="taddnot"><!-- --></a>
syeshind0bdb8e2005-10-27 17:44:14 +000021<h1 class="topictitle1">Adding notations</h1>
syeshinf3d0d4b2005-07-27 18:33:03 +000022<div><p>A notation is a means of associating a binary description with
syeshind0bdb8e2005-10-27 17:44:14 +000023an entity or attribute. The most common uses of notations are to include familiar
24types of binary references, such as GIFs and JPGs, in an XML file.</p>
25<div class="section"><p>For example, you are making a catalogue of your clothing and want
26to include an image of one of your shirts. You would have to create a notation
27like this: <kbd class="userinput">&lt;notation name="My_Shirt" system="GIF"&gt;&lt;/notation&gt;</kbd> which
28defines a notation for a GIF image.</p>
29<p>The following instructions were written for the Resource perspective, but
30they will also work in many other perspectives.</p>
syeshinf3d0d4b2005-07-27 18:33:03 +000031<p>To
32create a notation, follow these steps:</p>
34<ol><li class="skipspace"><span>Open your XML schema in the XML schema editor.</span></li>
syeshind0bdb8e2005-10-27 17:44:14 +000035<li class="skipspace"><span>In the Outline view, right-click your XML schema and click
36<b> <span class="uicontrol">Add
38<li class="skipspace"><span>In the Properties view, type the name of the notation in the
39<b> <span class="uicontrol">Name</span></b> field.</span></li>
40<li class="skipspace"><span>Click the <b> <span class="uicontrol">Other</span></b> tab.</span></li>
41<li class="skipspace"><span>In the <b> <span class="uicontrol">public</span></b> field, type a public identifier.</span> This is optional if you enter a value in the
42<b> <span class="uicontrol">system</span></b> field.</li>
43<li class="skipspace"><span>In the <b> <span class="uicontrol">system</span></b> field, type a URI reference.</span> This is optional if you enter a value in the
44<b> <span class="uicontrol">public</span></b> field.</li>
45<li class="skipspace"><span>Click the <b> <span class="uicontrol">Documentation</span></b> tab if you want
syeshinf3d0d4b2005-07-27 18:33:03 +000046to provide any information about this notation.</span> The <span class="uicontrol">Documentation</span> page
47is used for human readable material, such as a description, and the <span class="uicontrol">App
syeshind0bdb8e2005-10-27 17:44:14 +000048Info</span> page can be used to provide information for applications.</li>
syeshinf3d0d4b2005-07-27 18:33:03 +000049</ol>
syeshinf3d0d4b2005-07-27 18:33:03 +000051</body>