Changeset 952

Show
Ignore:
Timestamp:
01/03/08 15:43:37 (11 months ago)
Author:
otter
Message:

ModelicaReference: Changed <h3> to <h4> and removed superfluous headings ( fixes #35 )

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • Modelica/trunk/ModelicaReference/package.mo

    r950 r952  
    4747</html>")); 
    4848 
    49 package Annotations "Annotations"  
    50   class choices "choices"  
    51      
    52     annotation (Documentation(info="<html> 
    53 <h3><font color=\"#008000\" size=5>choices</font></h3> 
     49 
     50package Annotations "Annotations" 
     51  class choices "choices" 
     52 
     53    annotation (Documentation(info="<html> 
    5454<p> 
    5555Define graphical layout of choices in a parameter menu 
    5656</p> 
    5757 
    58 <h3><font color=\"#008000\">Examples</font></h3> 
     58<h4><font color=\"#008000\">Examples</font></h4> 
    5959 
    6060<pre><b>replaceable model</b> MyResistor=Resistor  
    … …  
    8888 
    8989 
    90 <h3><font color=\"#008000\">Description</font></h3> 
     90<h4><font color=\"#008000\">Description</font></h4> 
    9191 
    9292<p> 
    … …  
    9898  end choices; 
    9999 
    100   class defaultComponentName "defaultComponentName"  
    101      
    102     annotation (Documentation(info="<html> 
    103 <h3><font color=\"#008000\" size=5>defaultComponentName</font></h3> 
     100  class defaultComponentName "defaultComponentName" 
     101 
     102    annotation (Documentation(info="<html> 
    104103<p> 
    105104Default name when dragging component 
    106105</p> 
    107106 
    108 <h3><font color=\"#008000\">Syntax</font></h3> 
     107<h4><font color=\"#008000\">Syntax</font></h4> 
    109108 
    110109<pre>   <b>annotation</b>\"(\" defaultComponentName \"=\" STRING \")\" 
    … …  
    112111 
    113112 
    114 <h3><font color=\"#008000\">Description</font></h3> 
     113<h4><font color=\"#008000\">Description</font></h4> 
    115114 
    116115<p> 
    … …  
    122121  end defaultComponentName; 
    123122 
    124   class defaultComponentPrefixes "defaultComponentPrefixes"  
    125      
    126     annotation (Documentation(info="<html> 
    127 <h3><font color=\"#008000\" size=5>defaultComponentPrefixes</font></h3> 
     123  class defaultComponentPrefixes "defaultComponentPrefixes" 
     124 
     125    annotation (Documentation(info="<html> 
    128126<p> 
    129127Default prefixes when dragging component 
    130128</p> 
    131129 
    132 <h3><font color=\"#008000\">Examples</font></h3> 
     130<h4><font color=\"#008000\">Examples</font></h4> 
    133131 
    134132<pre><b>annotation</b>(defaultComponentPrefixes=\"inner\", 
    … …  
    136134</pre> 
    137135 
    138 <h3><font color=\"#008000\">Syntax</font></h3> 
     136<h4><font color=\"#008000\">Syntax</font></h4> 
    139137 
    140138<pre>   <b>annotation</b>\"(\" defaultComponentPrefixes \"=\" STRING \")\" 
    … …  
    142140 
    143141 
    144 <h3><font color=\"#008000\">Description</font></h3> 
     142<h4><font color=\"#008000\">Description</font></h4> 
    145143 
    146144<p> 
    … …  
    151149  end defaultComponentPrefixes; 
    152150 
    153   class derivative "derivative"  
    154      
    155     annotation (Documentation(info="<html> 
    156 <h3><font color=\"#008000\" size=5>derivative</font></h3> 
     151  class derivative "derivative" 
     152 
     153    annotation (Documentation(info="<html> 
    157154<p> 
    158155Define derivative of function 
    159156</p> 
    160157 
    161 <h3><font color=\"#008000\">Examples</font></h3> 
     158<h4><font color=\"#008000\">Examples</font></h4> 
    162159 
    163160<pre><b>function</b> foo0 <b>annotation</b>(derivative=foo1); <b>end</b> foo0; 
    … …  
    168165 
    169166 
    170 <h3><font color=\"#008000\">Description</font></h3> 
     167<h4><font color=\"#008000\">Description</font></h4> 
    171168 
    172169<p> 
    … …  
    334331  end derivative; 
    335332 
    336   class Dialog "Dialog"  
    337      
    338     annotation (Documentation(info="<html> 
    339 <h3><font color=\"#008000\" size=5>Dialog</font></h3> 
     333  class Dialog "Dialog" 
     334 
     335    annotation (Documentation(info="<html> 
    340336<p> 
    341337Define graphical layout of parameter menu 
    342338</p> 
    343339 
    344 <h3><font color=\"#008000\">Examples</font></h3> 
     340<h4><font color=\"#008000\">Examples</font></h4> 
    345341 
    346342<pre><b>model</b> BodyShape 
    … …  
    354350</pre> 
    355351 
    356 <h3><font color=\"#008000\">Syntax</font></h3> 
     352<h4><font color=\"#008000\">Syntax</font></h4> 
    357353 
    358354<pre>   <b>annotation</b>(Dialog(enable = parameter-expression, tab = \"tab\", group = \"group\")) 
    … …  
    360356 
    361357 
    362 <h3><font color=\"#008000\">Description</font></h3> 
     358<h4><font color=\"#008000\">Description</font></h4> 
    363359 
    364360<p> 
    … …  
    380376  end Dialog; 
    381377 
    382   class Documentation "Documentation"  
    383      
    384     annotation (Documentation(info="<html> 
    385 <h3><font color=\"#008000\" size=5>Documentation</font></h3> 
     378  class Documentation "Documentation" 
     379 
     380    annotation (Documentation(info="<html> 
    386381<p> 
    387382Annotations for documentation 
    388383</p> 
    389384 
    390 <h3><font color=\"#008000\">Syntax</font></h3> 
     385<h4><font color=\"#008000\">Syntax</font></h4> 
    391386 
    392387<pre>documentation_annotation: 
    … …  
    395390</pre> 
    396391 
    397 <h3><font color=\"#008000\">Description</font></h3> 
     392<h4><font color=\"#008000\">Description</font></h4> 
    398393<P> 
    399394The \"Documentation\" annotation can contain the \"info\" annotation giving a textual description, the \"revisions\" annotation giving a list of revisions and other annotations defined by a tool [The \"revisions\" documentation may be omitted in printed documentation]. How the tool interprets the information in \"Documentation\" is unspecified. Within a string of the \"Documentation\" annotation, the tags &lt;HTML&gt; and &lt;/HTML&gt; or &lt;html&gt; and &lt;/html&gt; define optionally begin and end of content that is HTML encoded. Links to Modelica classes may be defined with the HTML link command using scheme \"Modelica\", e.g., 
    … …  
    412407</html>")); 
    413408  end Documentation; 
    414    
    415    
    416    
    417    
    418    
    419    
    420    
     409 
    421410  annotation (Documentation(info="<html> 
    422411<p> 
    … …  
    426415 
    427416</html>")); 
    428   class Evaluate "Evaluate"  
    429      
    430     annotation (Documentation(info="<html> 
    431 <h3><font color=\"#008000\" size=5>Evaluate</font></h3> 
     417  class DynamicSelect "DynamicSelect" 
     418 
     419    annotation (Documentation(info="<html> 
     420<p> 
     421Define schematic animation of diagram layer  
     422</p> 
     423 
     424<h4><font color=\"#008000\">Examples</font></h4> 
     425 
     426<blockquote> 
     427<p> 
     428The level of a tank is animated by a rectangle expanding in vertical direction and its color depending on a variable overflow: 
     429</p> 
     430 
     431<pre><b>annotation</b>( 
     432  Icon(graphics={Rectangle( 
     433    extent=<b>DynamicSelect</b>({{0,0},{20,20}},{{0,0},{20,level}}),  
     434    fillColor=<b>DynamicSelect</b>({0,0,255},  
     435                            <b>if</b> overflow <b>then</b> {255,0,0} <b>else</b> {0,0,255}))} 
     436); 
     437</pre></blockquote> 
     438 
     439 
     440<h4><font color=\"#008000\">Description</font></h4> 
     441 
     442<p> 
     443Any value (coordinates, color, text, etc) in graphical annotations can be dependent on class variables using the DynamicSelect expression. DynamicSelect has the syntax of a function call with two arguments, where the first argument specifies the value of the editing state and the second argument the value of the non-editing state. The first argument must be a literal expression 
     444and this value is used for the annotation when editing and/or browsing the diagram layer. 
     445The second argument may contain references to variables to enable a dynamic behavior 
     446and the actual value is used for the annotation for schematic animation 
     447of the diagram layer, e.g., after a simulation. 
     448</p> 
     449 
     450</html>")); 
     451  end DynamicSelect; 
     452 
     453  class Evaluate "Evaluate" 
     454 
     455    annotation (Documentation(info="<html> 
    432456<p> 
    433457Annotation for code generation (evaluate parameter value) 
    434458</p> 
    435459 
    436 <h3><font color=\"#008000\">Syntax</font></h3> 
     460<h4><font color=\"#008000\">Syntax</font></h4> 
    437461 
    438462<pre>   <b>annotation</b>\"(\" Evaluate \"=\" ( <b>false</b> | <b>true</b> ) \")   
    … …  
    440464 
    441465 
    442 <h3><font color=\"#008000\">Description</font></h3> 
     466<h4><font color=\"#008000\">Description</font></h4> 
    443467 
    444468<p> 
    … …  
    461485  end Evaluate; 
    462486 
    463   class experiment "experiment"  
    464      
    465     annotation (Documentation(info="<html> 
    466 <h3><font color=\"#008000\" size=5>experiment</font></h3> 
     487  class experiment "experiment" 
     488 
     489    annotation (Documentation(info="<html> 
    467490<p> 
    468491Define default experiment parameters  
    469492</p> 
    470493 
    471 <h3><font color=\"#008000\">Examples</font></h3> 
     494<h4><font color=\"#008000\">Examples</font></h4> 
    472495 
    473496<pre><b>annotation</b>(experiment(StartTime=0, StopTime=5, Tolerance=1e-6)) 
    … …  
    475498 
    476499 
    477 <h3><font color=\"#008000\">Syntax</font></h3> 
     500<h4><font color=\"#008000\">Syntax</font></h4> 
    478501 
    479502<pre>experiment_annotation: 
    … …  
    487510 
    488511 
    489 <h3><font color=\"#008000\">Description</font></h3> 
     512<h4><font color=\"#008000\">Description</font></h4> 
    490513 
    491514<p> 
    … …  
    496519  end experiment; 
    497520 
    498   class HideResult "HideResult"  
    499      
    500     annotation (Documentation(info="<html> 
    501 <h3><font color=\"#008000\" size=5>HideResult</font></h3> 
     521  class HideResult "HideResult" 
     522 
     523    annotation (Documentation(info="<html> 
    502524<p> 
    503525Annotation for code generation (hide result) 
    504526</p> 
    505527 
    506 <h3><font color=\"#008000\">Syntax</font></h3> 
     528<h4><font color=\"#008000\">Syntax</font></h4> 
    507529 
    508530<pre>   <b>annotation</b>\"(\" HideResult \"=\" ( <b>false</b> | <b>true</b> ) \")   
    … …  
    510532 
    511533 
    512 <h3><font color=\"#008000\">Description</font></h3> 
     534<h4><font color=\"#008000\">Description</font></h4> 
    513535 
    514536<p> 
    … …  
    527549  end HideResult; 
    528550 
    529   class Inline "Inline"  
    530      
    531     annotation (Documentation(info="<html> 
    532 <h3><font color=\"#008000\" size=5>Inline</font></h3> 
     551  class Inline "Inline" 
     552 
     553    annotation (Documentation(info="<html> 
    533554<p> 
    534555Annotation for code generation (inline function body) 
    535556</p> 
    536557 
    537 <h3><font color=\"#008000\">Syntax</font></h3> 
     558<h4><font color=\"#008000\">Syntax</font></h4> 
    538559 
    539560<pre>   <b>annotation</b>\"(\" Inline \"=\" ( <b>false</b> | <b>true</b> ) \")   
    … …  
    541562 
    542563 
    543 <h3><font color=\"#008000\">Description</font></h3> 
     564<h4><font color=\"#008000\">Description</font></h4> 
    544565 
    545566<p> 
    … …  
    563584  end Inline; 
    564585 
    565   class LateInline "LateInline"  
    566      
    567     annotation (Documentation(info="<html> 
    568 <h3><font color=\"#008000\" size=5>LateInline</font></h3> 
     586  class LateInline "LateInline" 
     587 
     588    annotation (Documentation(info="<html> 
    569589<p> 
    570590Annotation for code generation (inline function body after symbolic processing) 
    571591</p> 
    572592 
    573 <h3><font color=\"#008000\">Syntax</font></h3> 
     593<h4><font color=\"#008000\">Syntax</font></h4> 
    574594 
    575595<pre>   <b>annotation</b>\"(\" LateInline \"=\" ( <b>false</b> | <b>true</b> ) \")   
    … …  
    577597 
    578598 
    579 <h3><font color=\"#008000\">Description</font></h3> 
     599<h4><font color=\"#008000\">Description</font></h4> 
    580600 
    581601<p> 
    … …  
    598618  end LateInline; 
    599619 
    600   class missingInnerMessage "missingInnerMessage"  
    601      
    602     annotation (Documentation(info="<html> 
    603 <h3><font color=\"#008000\" size=5>missingInnerMessage</font></h3> 
     620  class missingInnerMessage "missingInnerMessage" 
     621 
     622    annotation (Documentation(info="<html> 
    604623<p> 
    605624Warning message, if inner declaration is missing 
    606625</p> 
    607626 
    608 <h3><font color=\"#008000\">Examples</font></h3> 
     627<h4><font color=\"#008000\">Examples</font></h4> 
    609628 
    610629<pre><b>model</b> World 
    … …  
    616635</pre> 
    617636 
    618 <h3><font color=\"#008000\">Syntax</font></h3> 
     637<h4><font color=\"#008000\">Syntax</font></h4> 
    619638 
    620639<pre>   <b>annotation</b>\"(\" missingInnerMessage \"=\" STRING \")\" 
    … …  
    622641 
    623642 
    624 <h3><font color=\"#008000\">Description</font></h3> 
     643<h4><font color=\"#008000\">Description</font></h4> 
    625644 
    626645<p> 
    … …  
    631650  end missingInnerMessage; 
    632651 
    633   class PreferredView "preferredView"  
    634      
    635     annotation (Documentation(info="<html> 
    636 <h3><font color=\"#008000\" size=5>preferredView</font></h3> 
     652  class PreferredView "preferredView" 
     653 
     654    annotation (Documentation(info="<html> 
    637655<p> 
    638656Define default view when selecting class 
    639657</p> 
    640658 
    641 <h3><font color=\"#008000\">Syntax</font></h3> 
     659<h4><font color=\"#008000\">Syntax</font></h4> 
    642660 
    643661<pre>preferred view_annotation: 
    … …  
    646664 
    647665 
    648 <h3><font color=\"#008000\">Description</font></h3> 
     666<h4><font color=\"#008000\">Description</font></h4> 
    649667 
    650668<p> 
    … …  
    655673  end PreferredView; 
    656674 
    657   class smoothOrder "smoothOrder"  
    658      
    659     annotation (Documentation(info="<html> 
    660 <h3><font color=\"#008000\" size=5>smoothOrder</font></h3> 
     675  class smoothOrder "smoothOrder" 
     676 
     677    annotation (Documentation(info="<html> 
    661678<p> 
    662679Define differentiability of function body 
    663680</p> 
    664681 
    665 <h3><font color=\"#008000\">Syntax</font></h3> 
     682<h4><font color=\"#008000\">Syntax</font></h4> 
    666683 
    667684<pre>   <b>annotation</b>\"(\" smoothOrder \"=\" UNSIGNED_INTEGER \")\"  
    … …  
    669686 
    670687 
    671 <h3><font color=\"#008000\">Description</font></h3> 
     688<h4><font color=\"#008000\">Description</font></h4> 
    672689 
    673690<p> 
    … …  
    686703  end smoothOrder; 
    687704 
    688   class version "version"  
    689      
    690     annotation (Documentation(info="<html> 
    691 <h3><font color=\"#008000\" size=5>Version</font></h3> 
     705  class version "version" 
     706 
     707    annotation (Documentation(info="<html> 
    692708<p> 
    693709Define version information of package 
    694710</p> 
    695711 
    696 <h3><font color=\"#008000\">Examples</font></h3> 
     712<h4><font color=\"#008000\">Examples</font></h4> 
    697713 
    698714<pre><b>package</b> Modelica 
    … …  
    722738 
    723739 
    724 <h3><font color=\"#008000\">Description</font></h3> 
     740<h4><font color=\"#008000\">Description</font></h4> 
    725741 
    726742<p> 
    … …  
    793809  end version; 
    794810 
    795   class unassignedMessage "unassignedMessage"  
    796      
    797     annotation (Documentation(info="<html> 
    798 <h3><font color=\"#008000\" size=5>unassignedMessage</font></h3> 
     811  class unassignedMessage "unassignedMessage" 
     812 
     813    annotation (Documentation(info="<html> 
    799814<p> 
    800815Error message, if variable is not assigned 
    801816</p> 
    802817 
    803 <h3><font color=\"#008000\">Examples</font></h3> 
     818<h4><font color=\"#008000\">Examples</font></h4> 
    804819 
    805820<pre><b>connector</b> Frame \"Frame of a mechanical system\"  
    … …  
    815830 
    816831 
    817 <h3><font color=\"#008000\">Syntax</font></h3> 
     832<h4><font color=\"#008000\">Syntax</font></h4> 
    818833 
    819834<pre>   <b>annotation</b>\"(\" unassignedMessage \"=\" STRING \")\" 
    … …  
    821836 
    822837 
    823 <h3><font color=\"#008000\">Description</font></h3> 
     838<h4><font color=\"#008000\">Description</font></h4> 
    824839 
    825840<p> 
    … …  
    832847 
    833848 
    834 package Classes "Classes (model, function, ...)"  
    835   class Block "block"  
    836      
    837     annotation (Documentation(info="<html> 
    838 <h3><font color=\"#008000\" size=5>block</font></h3> 
     849package Classes "Classes (model, function, ...)" 
     850  class Block "block" 
     851 
     852    annotation (Documentation(info="<html> 
    839853<p> 
    840854Define specialized class <i>block</i> 
    841855</p> 
    842 <h3><font color=\"#008000\">Examples</font></h3> 
     856<h4><font color=\"#008000\">Examples</font></h4> 
    843857 
    844858<pre><b>block</b> Integrator 
    … …  
    852866<b>end</b> Integrator;</pre> 
    853867 
    854 <h3><font color=\"#008000\">Syntax</font></h3> 
     868<h4><font color=\"#008000\">Syntax</font></h4> 
    855869 
    856870<PRE>   [ <B>encapsulated</B> ][ <B>partial </B>] <B>block</B> 
    … …  
    864878<p>See Modelica Language Specification for further details.</p> 
    865879 
    866 <h3><font color=\"#008000\">Description</font></h3> 
     880<h4><font color=\"#008000\">Description</font></h4> 
    867881<P> 
    868882A block class is the same as a model class 
    … …  
    876890</html>")); 
    877891  end Block; 
    878    
    879   class Class "class"  
    880      
    881     annotation (Documentation(info="<html> 
    882 <h3><font color=\"#008000\" size=5>class</font></h3> 
     892 
     893  class Class "class" 
     894 
     895    annotation (Documentation(info="<html> 
    883896<p> 
    884897Define class 
    885898</p> 
    886 <h3><font color=\"#008000\">Examples</font></h3> 
     899<h4><font color=\"#008000\">Examples</font></h4> 
    887900 
    888901<pre><b>class</b> MyTable 
    … …  
    897910<b>end</b> MyTable;</pre> 
    898911 
    899 <h3><font color=\"#008000\">Syntax</font></h3> 
     912<h4><font color=\"#008000\">Syntax</font></h4> 
    900913<PRE>   [ <B>encapsulated</B> ][ <B>partial </B>] <B>class</B> 
    901914   IDENT class_specifier 
    … …  
    908921<p>See Modelica Language Specification for further details.</p> 
    909922 
    910 <h3><font color=\"#008000\">Description</font></h3> 
     923<h4><font color=\"#008000\">Description</font></h4> 
    911924 
    912925<p> 
    … …  
    919932</html>")); 
    920933  end Class; 
    921    
    922   class Connector "connector"  
    923      
    924     annotation (Documentation(info="<html> 
    925 <h3><font color=\"#008000\" size=5>connector</font></h3> 
     934 
     935  class Connector "connector" 
     936 
     937    annotation (Documentation(info="<html> 
    926938<p> 
    927939Define specialized class <i>connector</i> 
    928940</p> 
    929 <h3><font color=\"#008000\">Examples</font></h3> 
     941<h4><font color=\"#008000\">Examples</font></h4> 
    930942 
    931943<pre><b>connector</b> flange 
    … …  
    934946<b>end</b> flange;</pre> 
    935947 
    936 <h3><font color=\"#008000\">Syntax</font></h3> 
     948<h4><font color=\"#008000\">Syntax</font></h4> 
    937949<PRE>   [ <B>encapsulated</B> ][ <B>partial </B>] <B>connector</B> 
    938950   IDENT class_specifier 
    … …  
    945957<p>See Modelica Language Specification for further details.</p> 
    946958 
    947 <h3><font color=\"#008000\">Description</font></h3> 
     959<h4><font color=\"#008000\">Description</font></h4> 
    948960<P>The keyword connector is used to define connectors, which are used 
    949961in connect statements. In connectors, no equations are allowed in the 
    … …  
    954966</html>")); 
    955967  end Connector; 
    956    
    957   class Function "function"  
    958      
    959     annotation (Documentation(info="<html> 
    960 <h3><font color=\"#008000\" size=5>function</font></h3> 
     968 
     969  class Function "function" 
     970 
     971    annotation (Documentation(info="<html> 
    961972<p> 
    962973Define specialized class <i>function</i> 
    963974</p> 
    964 <h3><font color=\"#008000\">Examples</font></h3> 
     975<h4><font color=\"#008000\">Examples</font></h4> 
    965976 
    966977<pre><b>function</b> si 
    … …  
    973984<p align=\"center\"><img src=\"../Images/function.png\" width=\"400\" height=\"280\" alt=\"Simulation result\"></p> 
    974985 
    975 <h3><font color=\"#008000\">Syntax</font></h3> 
     986<h4><font color=\"#008000\">Syntax</font></h4> 
    976987 
    977988<PRE>   [ <B>encapsulated</B> ][ <B>partial </B>] <B>function</B> 
    … …  
    985996<p>See Modelica Language Specification for further details.</p> 
    986997 
    987 <h3><font color=\"#008000\">Description</font></h3> 
     998<h4><font color=\"#008000\">Description</font></h4> 
    988999 
    9891000<P>The keyword function is used to define functions as known from programming 
    … …  
    10771088</html>")); 
    10781089  end Function;