sysmodellibs/sysmodelgen/doc/sysmodel/SMG-Input-Files/Values-XML-index.html
author Bob Rosenberg <bob.rosenberg@nokia.com>
Wed, 13 Oct 2010 16:21:25 +0100
changeset 7 3c36c452f013
permissions -rw-r--r--
Version 2.0 release of System Model Generator, which draws 3.x syntax system definition files

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <!-- Generated by Xbuild version: 5.0.20 -->
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="show-comments" content="" />
	<title>Values XML Files in System Model Generator Input Files</title>    
	<link href="../../_stock/css/reset.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/portal.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/iefix.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/ui.tabs.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/developer.css" rel="stylesheet" type="text/css" />
	<link rel="stylesheet" type="text/css" href="../../_stock/css/ui.css" media="screen" />
	<link rel="stylesheet" type="text/css" href="../../_stock/css/sysdoc.css" media="screen" />
	<link rel="stylesheet" type="text/css" href="../../_stock/css/sdlplugin.css" media="screen" />
    </head>
    <body>
	<div id="main_content">
	    <table width="100%" cellpadding="0" cellspacing="0" border="0">
		<tr>
		    <td valign="top" width="100%">
			<div id="main_content_txt">
			    <div class="main_content_padding">		
                                <div id="main">
                                    <div id="authoredContent">
                                        <a name=""></a>
<h1>Values XML Files</h1><a name="valuesxml"></a><p>
	The Values XML files are used to define default and per-item display
	properties. You can use a values XML file to define colors, patterns, border
	shapes, or border styles of the system model items. 
  </p><p>
	For information about how to define new values for border shapes, colors or
	patterns, see 
	<a href="../CustomSysmodel/index.html#cust%2eindex" title="This document describes how to customise a System Model diagram using a Shapes XML file to specify the styling of components and generated legend items.">Customizing the System Model Presentation</a>
.
	
  </p><p>
	There are four types of Values XML files: 
  </p><ul class="indexlinks">
<li>
<a href="Colours-XMLFile.html#coloursxml">Colors Values XML File</a></li>
<li>
<a href="Patterns-XMLFile.html#patternsxml">Patterns Values XML File</a></li>
<li>
<a href="Border-Shapes-XMLFile.html#bordershapesxml">Border Shapes Values XML File</a> (components only)</li>
<li>
<a href="Border-Style-XMLFile.html#borderstylesxml">Border Styles Values XML File</a></li>
</ul>


<h2>Syntax</h2>
<p>All Values XML files share the same basic syntax
<div class="Example"><code class="xml">&lt;?xml version="1.0"?&gt;
<br/>&lt;values <span class="opt">default="<var>presentation-value</var>"</span> <span class="opt">label="<var>label for legend section</var>"</span> <span class="default">rank="<var>item-type-list</var>"</span> <span class="default">id-namespace="<var>uri</var>" </span><span class="opt"><var>&#133;namespaces&#133;</var></span> &gt;
<div class="indent">&lt;item <span class="opt">label="<var>label for legend</var>"</span> value="<var>presentation-value</var>"&gt;
<div class="indent">&lt;m ref="<var>id</var>"/&gt;
<br/>&lt;m ref="<var>id</var>"/&gt;
<br/>&lt;m ref="<var>id</var>"/&gt;
<br>&#133;</div>
&lt;/item&gt;
<br>&lt;item &#133;&gt;<div class="indent">&#133;</div>&lt;/item&gt;<br>&#133;</div>&lt;/values&gt;</code></div><p>
		In the preceding syntax, the root element <code>values</code> contains any number of 
		<code>item</code> tags. The various attributes for the <code>values</code> tag are: 
	  </p><ul> 
	  
		<li>
		  <p>
			<code class="xml">rank="<var>item-type-list</var>"</code>: Space-separated list of the ranks (<code>component</code>, <code>collection</code>, <code>package</code> or  <code>layer</code>) of items the <code>default</code> value applies to.
			Any system model item of the listed rank <em>not</em> listed in the values file will get the <code>default</code> presentation value. 
			The (default) special value of <code>*</code> indicates this file applies to all ranks. 
		  </p> 
		</li>

		<li>
		  <p>
			<code class="xml">default="<var>presentation-value</var>"</code>: Defines the
			default presentation value for the system model item. This default value gets assigned to
			the system model items of the specified rank to which no specific value is assigned. 
		  </p> 
		</li>
 
		<li>
		  <p>
			<code class="xml">label="<var>label for legend section</var>"</code>: Defines the label that will precede the legend section.
		  </p> 
		</li>
		<li>
		  <p>
			<code class="xml">id-namespace="<var>uri</var>"</code>: The default namespace for all <code>ref</code> attributes in the XML file. Has the same meaning, usage and default value as <code>id-namespace</code> in the <a href="http://developer.symbian.org/wiki/index.php/System_Definition/Root#Attributes">System Definition</a>.
		  </p> 
		</li>

		<li>
		  <p>
			<code><var>namespaces</var></code>: Any namespace declaration should be done in the root element. ID references can use namespace prefixes to associate with system model items. See <a href="http://developer.symbian.org/wiki/index.php/System_Definition/Attributes#Namespacing_names">Namespacing names</A> in the System Definition specification.
		  </p> 
		</li>
 
	  </ul><p>
		Each <code class="xml">item</code> tag can have the following attributes: 
	  </p><ul> 
		<li>
 
		  <p>
			<code class="xml">label="<var>label for legend</var>"</code>: Defines the label for the	legend. 
		  </p> 
		</li>
 
		<li>
 
		  <p>
			<code>value="<var>presentation-value</var>"</code>: Defines the presentation
			value for the item (color, border shape, etc). This presentation value gets assigned to all the referenced system model items that are
			listed within that <code>item</code> element. 
		  </p> 
		</li>
 
	  </ul><p>
		The <code>item</code> tag also contains <code>m</code> tags to reference the IDs of system model items.
		 Everything referenced in an
		<code>item</code> tag has the same presentation value. The following is the basic syntax for <code>m</code>: 
	  </p><p>
		<code> &lt;m ref="<var>id</var>"/&gt;</code> 
	  </p><p>
		Where <var>id</var> is a reference to the ID of a system model item
		defined in a system definition file. <strong>Note:</strong> while most presentation values can apply to anything, only components can be given a border shape. 
	  </p></div>

<p>
	<b>Notes</b>:
  </p><ul> 
	<li>
 
	  <p>
		You are recommended to specify a default value when using the values to
		specify colors or shapes on components, since the components not specified in the file will
		either be black or not show up at all. 
	  </p>
	</li>
 
	<li>
 
	  <p>
		While creating a value XML file (colors, patterns, border shapes or
		border styles), you can only specify predefined set of values to the items. For
		information about the values that can be specified in each type of values XML
		file, refer to the corresponding topic. 
	  </p>
	</li>
 
	<li>
 
	  <p>
		All values in a values XML file must be of the same type. 
	  </p>
	</li>
 
  </ul>
                                    </div>
                                    <div id="printer_copyright">
                                        <div id="printer_copyright_padding">
                                            Copyright &copy;2009&nbsp; Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: <a href="http://www.symbianfoundation.org/legal/sfl-v10.html">SFL</a>
                                        </div>
                                    </div>
                                </div>
			    </div>
			</div>
		    </td>
		</tr>
	    </table>
	    <div style="clear: both"></div>
	</div>
	<div id="includedFooter">
	    <div id="devnet_footer">
            <div style="float: left;">Copyright &copy;2009&nbsp; Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: <a href="http://www.symbianfoundation.org/legal/sfl-v10.html">SFL</a>.&nbsp;</div>
            <div id='BUILD_VERSION'></div>
	    </div>
	</div>
</body>
</html>