sysmodellibs/sysmodelgen/doc/sysmodel/Command-lineOptions/Labels-options.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>Labels Options in System Model Generator Command-line Options</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">
                                        <div class="section">
<a name="labeloptions"></a><h1>Labels Options</h1>
<p>All of these take a plain text value which is displayed on the model</p>

<table class="TableWrap" border="1" cellpadding="1" cellspacing="0"><tr valign="top"><th>Options</th><th>Description</th></tr>
<tr valign="top"><td class="Cell"><p><code>
 -system_name     </code></p></td><td class="Cell"><p>       The name of the product described in the model.
                       It appears at  the bottom right on the system model diagram. The default value is
			<code>Symbian OS</code>. 
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -system_version    </code></p></td><td class="Cell"><p>     The version of the product described in the
                       model. It appears  at the bottom right after the
                       name. </p> 
		  <p>
			<b>Note</b>: You can set this option to an empty string, if
			you do not want system version to appear on the system model diagram. 
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -model_name      </code></p></td><td class="Cell"><p>       The label for the model. It appears at the
                       bottom right,  under the name. The default value is <code>System Model</code>. 
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -model_version    </code></p></td><td class="Cell"><p>      A number which appears before the model-revision-type. 
					  If specified this overrides the
                       build number used in any attached Dependencies XML files.  Otherwise, this defaults to <code>1</code>
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -model_version_type </code></p></td><td class="Cell"><p>    One of <code>draft</code>, <code>issued</code>, <code>build</code> or free-text
                       value. Appears below the model label. If
                       specified this overrides the build number used
                       in any attached Dependencies XML files. Otherwise, this
                       defaults to <code>draft</code>.
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -legend_title    </code></p></td><td class="Cell"><p>       The title to appear in the leftmost part of the
                       legend. The default value is <code>Key</code>. 
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -distribution      </code></p></td><td class="Cell"><p>     Text to appear on the bottom centre to indicate
                       to whom the  model can be show. Informational
                       only. Suggested values are <code>internal</code>, <code>secret</code>
                       or <code>unrestrictred</code>. Not shown if not set. </p><p>
			The location of the text can be overridden using the model XML. 
		  </p>
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -note       </code></p></td><td class="Cell"><p>            Free text to appear inside the legend box, on
                       the rightmost side. If multiple ones are
                       provided, they will appear as separate boxes
                       from left to right. Newlines and other special
                       characters can be entity-encoded (e.g. <code class="xml">&#xa;</code>).
                       When using entities in an INI file, you *must*
                       quote the value, otherwise the <code>#</code> will be treated
                       as a comment delimiter. Can specify multiple
                       times.
	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
 -copyright      </code></p></td><td class="Cell"><p>        The copyright to appear in the lower left. Set
                       to empty string to leave out. Defaults to "<code><var>year</var> Nokia Corporation</code>".<br/>
					   You can set this option
			to an empty string if you don not want copyright text to appear on the system
			model diagram. 
	</p></td></tr>
	</table><div class="section">
<h2> See also</h2><p>
		<a href="Basic-Options.html#Basicoptions">Basic Options</a> 
	  </p><p>
		<a href="Build-Control-options.html#BuildControl">Build Control Options</a> 
	  </p><p>
		<a href="Files-or-uri-options.html#fileorurioptions">Files or URIs Options</a> 
	  </p><p>
		<a href="Model-Control-options-ref.html#modelcontrol">Model Control Options</a> 
	  </p></div>
</div>

                                    </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>