sysmodellibs/sysmodelgen/doc/sysmodel/Command-lineOptions/Model-Control-options-ref.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>Model Control 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="modelcontrol"></a><h1>Model Control Options</h1><table class="TableWrap" border="1" cellpadding="1" cellspacing="0"><tr valign="top"><th>Options</th><th>Description</th></tr>
       
    27 <tbody><tr valign="top"><td class="Cell"><p><code>
       
    28  -sysdef <var>file/uri</var>   </code></p></td><td class="Cell"><p>   Location for the System
       
    29                        Definition XML file(s) used to build the model.
       
    30 					   Multiple files will be merged according to the normal rules. Can
       
    31                        specify multiple times.
       
    32 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    33  -srcvar             </code></p></td><td class="Cell"><p> 
       
    34  The root directory (in the local filesystem) for the system definition. The order of this parameter must match the order
       
    35                        of the <code>-sysdef</code> parameter. Can specify multiple
       
    36                        times.
       
    37 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    38  -sysdef-prefix    </code></p></td><td class="Cell"><p>      Can specify multiple times.
       
    39 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    40  -sysdef-path <var>path</var>  </code></p></td><td class="Cell"><p>   The directory which the system definition file
       
    41                        should be considered to be in when turning
       
    42                        unit's relative links into absolute paths. This
       
    43                        is only necessary to provide if the result
       
    44                        requires the absolute paths to be meaningful.
       
    45                        The order of this parameter must match the order
       
    46                        of the <code>-sysdef</code> parameter. Can specify multiple
       
    47                        times.
       
    48 	</p></td></tr>
       
    49 	</tbody><tbody><tr valign="top"><td class="Cell"><p><code>
       
    50  -detail <var>item-type</var>   </code></p></td><td class="Cell"><p>  The type of the smallest System Model entity to
       
    51                        draw. One of <code>layer</code>, <code>package</code>, <code>collection</code> or
       
    52                        <code>component</code>.  Defaults to <code>component</code>
       
    53 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    54  -detail-type fixed</code></p></td><td class="Cell"><p>    If set to <code>fixed</code>, the smallest System Model
       
    55                        entity drawn will have a fixed with (rather then
       
    56                        sized by their invisible components). This can
       
    57                        be used to reduce the size and complexity of the
       
    58                        overall model. 
       
    59 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    60  -filter-has <var>filter-name</var> </code></p></td><td class="Cell"><p>  Like <code>-filter</code>, except any filter on an item must
       
    61                        be present in this list in order for that item
       
    62                        to appear. Include <code>*</code> in the list in order to
       
    63                        show items with no filters. <br/>Equivalent to <code>-show-attr filter <var>xxx</var></code>
       
    64 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    65  <code>-show-attr</code> <var>attr<var>=<var>val</var> </code></p></td><td class="Cell"><p>  A mechanism of filtering which allows filtering
       
    66                        based on component attribute values. If a value
       
    67                        is set for that attribute, the component will be
       
    68                        shown. Use in conjunction with <code>-hide-attr</code> for
       
    69                        fine contol of what is shown. <code>class</code> and
       
    70                        <code>filter</code> attribtues are handled specially -- see
       
    71                        the documentation for details
       
    72 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    73  -hide-attr <var>attr<var>=val </code></p></td><td class="Cell"><p>  A mechanism of filtering which allows filtering
       
    74                        based on component attribute values. If a value
       
    75                        is set for that attribute, the component will
       
    76                        not be shown on the model. Use in conjunction
       
    77                        with <code>-show-attr</code> for fine contol of what is
       
    78                        shown. <code>class</code> and <code>filter</code> attribtues are
       
    79                        handled specially -- see the documentation for
       
    80                        details
       
    81 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    82  -ignore <var>item</var>     </code></p></td><td class="Cell"><p>     The ID of a model entity to not draw. Any number
       
    83                        of these can be used. Can specify multiple
       
    84                        times.
       
    85 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    86  -ignore-meta <var>rel</var>  </code></p></td><td class="Cell"><p>   The <code>rel</code> meta value to ignore. Takes the form
       
    87                        of "<code><var>relvalue</var></code>" or "<code><var>relvalue</var>:<var>type</var></code>". Can specify multiple
       
    88                        times.
       
    89 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
    90  -version-list</code></p></td><td class="Cell"><p>    
       
    91 			Specifies the space-separated list of version numbers, ordered from
       
    92 			oldest to newest. This is used to compare version numbers in the VERSION rule
       
    93 			function. If not present, the value used are the Symbian Ltd version numbers from <code>ER5</code> through <code>9.5</code> and
       
    94 	Symbian Foundation version numbers from <code>^1</code> onward. <code>Future</code> is always last.
       
    95 	</p></td></tr>
       
    96 </tbody>
       
    97 <tbody>	
       
    98 	<tr valign="top"><td class="Cell"><p><code>
       
    99  -placeholder <var>item-type</var></code></p></td><td class="Cell"><p>   The type of the smallest <strong>empty</strong> System Model
       
   100                        entity to draw. One of <code>layer</code>, <code>package</code>,
       
   101                        <code>collection</code> or <code>component</code>.  For example, if
       
   102                        set to <code>package</code> empty layers and packages will
       
   103                        be drawn, but empty collections will be ignored.
       
   104                        If not set, no empty items will be drawn.
       
   105 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   106  -level-detail  <span class="aux">[</span>show<span class="aux">/</span>hide</var><span class="aux">]</span> </code></p></td><td class="Cell"><p>  Toggles display of level names on packages or
       
   107                        layers. A value of <code>show</code> will display level
       
   108                        names inside either layers (at <code>layer</code> level of
       
   109                        detail only) or packages (at <code>package</code> level of
       
   110                        detail only). A value of <code>hide</code> (default) will
       
   111                        not show any level names.
       
   112 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   113 -legend-width <var>%</var>    </code></p></td><td class="Cell"><p>   The percent width of the model the legend takes
       
   114                        up. This will scale the size of the legend and
       
   115                        model title, but not the logo, to fill the
       
   116                        specified space. If a logo is included, but no
       
   117                        width specified, the legend cannot be scaled
       
   118                        since it will not be able to determine the
       
   119                        available space. <br/>Note that that <code>-max-legend-scale</code> will further limit the potential width.
       
   120 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   121  -legend-max-scale <var>scale</var></code></p></td><td class="Cell"><p>   Specifies the maximum scale factor for resizing
       
   122                        the legend. If this is present and <code>-legend-width</code>
       
   123                        is not, the legend and title will scale to 100%
       
   124                        of the available width. If both are present the
       
   125                        scale factor will take precedent. If neither is
       
   126                        present, the legend will not resize. 
       
   127 		  </p> 
       
   128 		  <p>Note that
       
   129                        when this is used, the legend can shrink if it
       
   130                        would normally be wider than the model.
       
   131 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   132  -title-scale <var>scale</var> </code></p></td><td class="Cell"><p>   Specifies the scale factor for the size of the
       
   133                        title font (the text in the lower right). </p><p>Use
       
   134                        this instead of CSS to control the size, since
       
   135                        the model generator needs to explicitly know how
       
   136                        much space to allocate for the title.
       
   137 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   138  -logo <var>file/uri</var>  </code></p></td><td class="Cell"><p>      If present, the logo will be drawn in the lower-
       
   139                        left corner of the model. If the logo is an SVG
       
   140                        file, <code>-logo-width</code> and <code>-logo-height</code> are optional,
       
   141                        otherwise the must both be specified
       
   142 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   143  -logo-height <var>length</var> </code></p></td><td class="Cell"><p>  Specifies the height of the logo (if any) in mm.
       
   144                        Width is scaled along with height unless
       
   145                        otherwise specified. Both width and height MUST
       
   146                        be specified if a bitmap image is used
       
   147 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   148  -logo-width <var>length</var>  </code></p></td><td class="Cell"><p>  Specifies the width of the logo (if any) in mm.
       
   149                        Height is scaled along with width unless
       
   150                        otherwise specified. Both width and height MUST
       
   151                        be specified if a bitmap image is used
       
   152 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   153  -legend_float <var>boolean</var> </code></p></td><td class="Cell"><p>   If set, the legend will appear when the mouse
       
   154                        hovers over the bottom of the window. The
       
   155                        floating legend will span the full width of the
       
   156                        window. This may not be readable, depending on
       
   157                        the amonent of content in the legend.
       
   158 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   159  -static <var>boolean</var> </code></p></td><td class="Cell"><p>      If present, the model will not have any
       
   160                        mouseover effects (this is  overriden when drawing dependencies).
       
   161 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   162  -navctrl <var>boolean</var>  </code></p></td><td class="Cell"><p>    If set, a navigation control widget will appear
       
   163                        in the upper left corner of the model. The
       
   164                        control might not work on some SVG viewers.
       
   165 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   166  -dpi <var>number</var>   </code></p></td><td class="Cell"><p>        The DPI to use when printing from the Adobe SVG
       
   167                        Viewer. If not present, it will print well at A4             size. A value of <code>300</code> will look good on A3 size                      paper
       
   168 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   169  -model_font <var>font</var> </code></p></td><td class="Cell"><p>     The name of the base font to use to draw the
       
   170                        model. This will be overriden by any custom CSS
       
   171                        in the Shapes XML
       
   172 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   173  -link-expr     <var>expression</var>  </code></p></td><td class="Cell"><p>       The link used on any system model item. Any
       
   174                        values within <code>{<span class="aux">...</span>}</code> are evaluled as an
       
   175                        expression on the item. All xpath locations in
       
   176                        the expresion must be set otherwise the link
       
   177                        will not be created for the item. Can specify
       
   178                        multiple times.
       
   179 	</p></td></tr></tbody>
       
   180 	<tbody class="deprecated"><tr valign="top"><td class="Cell"><p><code>
       
   181  -filter <var>filter-name</var> </code></p></td><td class="Cell"><p>  The name of a filter to turn on when building
       
   182                        the model.  All filters on an item must be
       
   183                        present in this list in order for that item to
       
   184                        appear. Can have any number of these Defaults to
       
   185                        <code>java</code> and <code>gt</code>. Can specify multiple times..
       
   186                        <br/><strong>DEPRECATED</strong>: Only works on 2.0 syntax and older
       
   187                        models
       
   188 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   189  -coreos <span class="aux">[</span>on<span class="aux">/</span>off<span class="aux">/</span>new</var><span class="aux">]</span> 
       
   190    </code></p></td><td class="Cell"><p>  Turn on or off Core OS colouring for 9.4 and
       
   191                        later models -- For backwards compatibility
       
   192                        only! Use <code>on</code> for Symbian OS 9.4 models and
       
   193                        <code>new</code> for Symbian OS 9.5 and later models (non-
       
   194                        Foundation)
       
   195 	</p></td></tr><tr valign="top"><td class="Cell"><p><code>
       
   196  -page-width <var>length</var> </code></p></td><td class="Cell"><p>   The width of the drawn image (with units). If
       
   197                        not specified it will fit the viewer window.
       
   198                        Valid units: <code>in</code>, <code>mm</code>, <code>cm</code>, <code>px</code>, <code>pt</code>.
       
   199                        <br/><strong>DEPRECATED</strong>: Only works on 2.0 syntax and older  models
       
   200 	</p></td></tr>
       
   201 	
       
   202 	</tbody></table><div class="section">
       
   203 <h2> See also</h2><p>
       
   204 		<a href="Basic-Options.html#Basicoptions">Basic Options</a> 
       
   205 	  </p><p>
       
   206 		<a href="Build-Control-options.html#BuildControl">Build Control Options</a> 
       
   207 	  </p><p>
       
   208 		<a href="Files-or-uri-options.html#fileorurioptions">Files or URIs Options</a> 
       
   209 	  </p><p>
       
   210 		<a href="Labels-options.html#labeloptions">Labels Options</a> 
       
   211 	  </p></div>
       
   212 </div>
       
   213 
       
   214                                     </div>
       
   215                                     <div id="printer_copyright">
       
   216                                         <div id="printer_copyright_padding">
       
   217                                             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>
       
   218                                         </div>
       
   219                                     </div>
       
   220                                 </div>
       
   221 			    </div>
       
   222 			</div>
       
   223 		    </td>
       
   224 		</tr>
       
   225 	    </table>
       
   226 	    <div style="clear: both"></div>
       
   227 	</div>
       
   228 	<div id="includedFooter">
       
   229 	    <div id="devnet_footer">
       
   230             <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>
       
   231             <div id='BUILD_VERSION'></div>
       
   232 	    </div>
       
   233 	</div>
       
   234 </body>
       
   235 </html>