sysmodellibs/sysmodelgen/doc/sysmodel/Command-lineOptions/Labels-options.html
changeset 7 3c36c452f013
equal deleted inserted replaced
6:5b32dc297d05 7:3c36c452f013
       
     1 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     2     <!-- Generated by Xbuild version: 5.0.20 -->
       
     3     <head>
       
     4         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
       
     5 	<meta name="show-comments" content="" />
       
     6 	<title>Labels Options in System Model Generator Command-line Options</title>    
       
     7 	<link href="../../_stock/css/reset.css" rel="stylesheet" type="text/css" />
       
     8 	<link href="../../_stock/css/portal.css" rel="stylesheet" type="text/css" />
       
     9 	<link href="../../_stock/css/iefix.css" rel="stylesheet" type="text/css" />
       
    10 	<link href="../../_stock/css/ui.tabs.css" rel="stylesheet" type="text/css" />
       
    11 	<link href="../../_stock/css/developer.css" rel="stylesheet" type="text/css" />
       
    12 	<link rel="stylesheet" type="text/css" href="../../_stock/css/ui.css" media="screen" />
       
    13 	<link rel="stylesheet" type="text/css" href="../../_stock/css/sysdoc.css" media="screen" />
       
    14 	<link rel="stylesheet" type="text/css" href="../../_stock/css/sdlplugin.css" media="screen" />
       
    15     </head>
       
    16     <body>
       
    17 	<div id="main_content">
       
    18 	    <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    19 		<tr>
       
    20 		    <td valign="top" width="100%">
       
    21 			<div id="main_content_txt">
       
    22 			    <div class="main_content_padding">		
       
    23                                 <div id="main">
       
    24                                     <div id="authoredContent">
       
    25                                         <div class="section">
       
    26 <a name="labeloptions"></a><h1>Labels Options</h1>
       
    27 <p>All of these take a plain text value which is displayed on the model</p>
       
    28 
       
    29 <table class="TableWrap" border="1" cellpadding="1" cellspacing="0"><tr valign="top"><th>Options</th><th>Description</th></tr>
       
    30 <tr valign="top"><td class="Cell"><p><code>
       
    31  -system_name     </code></p></td><td class="Cell"><p>       The name of the product described in the model.
       
    32                        It appears at  the bottom right on the system model diagram. The default value is
       
    33 			<code>Symbian OS</code>. 
       
    34 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    35  -system_version    </code></p></td><td class="Cell"><p>     The version of the product described in the
       
    36                        model. It appears  at the bottom right after the
       
    37                        name. </p> 
       
    38 		  <p>
       
    39 			<b>Note</b>: You can set this option to an empty string, if
       
    40 			you do not want system version to appear on the system model diagram. 
       
    41 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    42  -model_name      </code></p></td><td class="Cell"><p>       The label for the model. It appears at the
       
    43                        bottom right,  under the name. The default value is <code>System Model</code>. 
       
    44 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    45  -model_version    </code></p></td><td class="Cell"><p>      A number which appears before the model-revision-type. 
       
    46 					  If specified this overrides the
       
    47                        build number used in any attached Dependencies XML files.  Otherwise, this defaults to <code>1</code>
       
    48 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    49  -model_version_type </code></p></td><td class="Cell"><p>    One of <code>draft</code>, <code>issued</code>, <code>build</code> or free-text
       
    50                        value. Appears below the model label. If
       
    51                        specified this overrides the build number used
       
    52                        in any attached Dependencies XML files. Otherwise, this
       
    53                        defaults to <code>draft</code>.
       
    54 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    55  -legend_title    </code></p></td><td class="Cell"><p>       The title to appear in the leftmost part of the
       
    56                        legend. The default value is <code>Key</code>. 
       
    57 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    58  -distribution      </code></p></td><td class="Cell"><p>     Text to appear on the bottom centre to indicate
       
    59                        to whom the  model can be show. Informational
       
    60                        only. Suggested values are <code>internal</code>, <code>secret</code>
       
    61                        or <code>unrestrictred</code>. Not shown if not set. </p><p>
       
    62 			The location of the text can be overridden using the model XML. 
       
    63 		  </p>
       
    64 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    65  -note       </code></p></td><td class="Cell"><p>            Free text to appear inside the legend box, on
       
    66                        the rightmost side. If multiple ones are
       
    67                        provided, they will appear as separate boxes
       
    68                        from left to right. Newlines and other special
       
    69                        characters can be entity-encoded (e.g. <code class="xml">&#xa;</code>).
       
    70                        When using entities in an INI file, you *must*
       
    71                        quote the value, otherwise the <code>#</code> will be treated
       
    72                        as a comment delimiter. Can specify multiple
       
    73                        times.
       
    74 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    75  -copyright      </code></p></td><td class="Cell"><p>        The copyright to appear in the lower left. Set
       
    76                        to empty string to leave out. Defaults to "<code><var>year</var> Nokia Corporation</code>".<br/>
       
    77 					   You can set this option
       
    78 			to an empty string if you don not want copyright text to appear on the system
       
    79 			model diagram. 
       
    80 	</p></td></tr>
       
    81 	</table><div class="section">
       
    82 <h2> See also</h2><p>
       
    83 		<a href="Basic-Options.html#Basicoptions">Basic Options</a> 
       
    84 	  </p><p>
       
    85 		<a href="Build-Control-options.html#BuildControl">Build Control Options</a> 
       
    86 	  </p><p>
       
    87 		<a href="Files-or-uri-options.html#fileorurioptions">Files or URIs Options</a> 
       
    88 	  </p><p>
       
    89 		<a href="Model-Control-options-ref.html#modelcontrol">Model Control Options</a> 
       
    90 	  </p></div>
       
    91 </div>
       
    92 
       
    93                                     </div>
       
    94                                     <div id="printer_copyright">
       
    95                                         <div id="printer_copyright_padding">
       
    96                                             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>
       
    97                                         </div>
       
    98                                     </div>
       
    99                                 </div>
       
   100 			    </div>
       
   101 			</div>
       
   102 		    </td>
       
   103 		</tr>
       
   104 	    </table>
       
   105 	    <div style="clear: both"></div>
       
   106 	</div>
       
   107 	<div id="includedFooter">
       
   108 	    <div id="devnet_footer">
       
   109             <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>
       
   110             <div id='BUILD_VERSION'></div>
       
   111 	    </div>
       
   112 	</div>
       
   113 </body>
       
   114 </html>