Changeset 548

Show
Ignore:
Timestamp:
08/17/2007 09:18:14 AM (17 months ago)
Author:
otter
Message:

Improved formatting (issues reported by Dietmar Winkler):
- User's Guide should have "class" at the lowest level, not "package",

since otherwise "+" is shown in the package browser.
Changed all user's guides so that no double list of the content is
displayed (for "package", Dymola includes a contents list, but not for "class").

- Now "User's Guide of XXX Libray" used consistently
- "users guide" in docu replaced by "user's guide"

Location:
Modelica/trunk/Modelica
Files:
9 modified

Legend:

Unmodified
Added
Removed

  • Modelica/trunk/Modelica/Electrical/Digital.mo

    r540 r548  
     1within Modelica.Electrical; 
    12package Digital  
    23  "Library for digital electrical components based on the VHDL standard with 9-valued logic and conversion to 2-,3-,4-valued logic"  
    3 package UsersGuide "User's Guide"  
     4class UsersGuide "User's Guide"  
    45     
    56  annotation (DocumentationClass=true, Documentation(info="<html> 
    … …  
    910components to model <b>digital</b> electronic 
    1011systems based on combinational and sequential logic in a convenient 
    11 way. This package contains the <b>users guide</b> for 
     12way. This package contains the <b>user's Guide</b> for 
    1213the library and has the following content: 
    1314</p> 

  • Modelica/trunk/Modelica/Mechanics/MultiBody/package.mo

    r540 r548  
     1within Modelica.Mechanics; 
    12package MultiBody "Library to model 3-dimensional mechanical systems" 
    23annotation ( 
    … …  
    5960 
    6061 
    61 package UsersGuide "User's Guide of MultiBody Library"  
     62class UsersGuide "User's Guide of MultiBody Library"  
     63   
    6264  annotation (DocumentationClass=true, Documentation(info="<HTML> 
    6365<p> 
    … …  
    9496</HTML>")); 
    9597   
    96   package Tutorial "Tutorial"  
     98  class Tutorial "Tutorial"  
     99     
    97100    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    98101<p> 
    … …  
    335338    end FirstExample; 
    336339     
    337     package LoopStructures "Loop structures"  
     340    class LoopStructures "Loop structures"  
    338341       
    339342      class Introduction "Introduction"  
    … …  
    767770   
    768771  class Upgrade "Upgrade from Former Versions"  
     772     
    769773    annotation (Documentation(info="<HTML> 
    770774<p> 

  • Modelica/trunk/Modelica/Mechanics/Rotational.mo

    r544 r548  
    33  "Library to model 1-dimensional, rotational mechanical systems"  
    44package UsersGuide "User's Guide of Rotational Library"  
     5     
    56  annotation (DocumentationClass=true, Documentation(info="<HTML> 
    67<p> 
    … …  
    1112</HTML>")); 
    1213     
    13   package Overview "Overview"  
     14  class Overview "Overview"  
     15       
    1416    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    1517  
    … …  
    7375  end Overview; 
    7476     
    75   package FlangeConnectors "Flange Connectors"  
     77  class FlangeConnectors "Flange Connectors"  
     78       
    7679    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    7780<p> 
    … …  
    99102  end FlangeConnectors; 
    100103     
    101   package SupportTorques "Support Torques"  
     104  class SupportTorques "Support Torques"  
     105       
    102106    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    103107  
    … …  
    124128  end SupportTorques; 
    125129     
    126   package SignConventions "Sign Conventions"  
     130  class SignConventions "Sign Conventions"  
     131       
    127132    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    128133  
    … …  
    183188  end SignConventions; 
    184189     
    185   package UserDefinedComponents "User Defined Components"  
     190  class UserDefinedComponents "User Defined Components"  
     191       
    186192    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    187193<p> 
    … …  
    267273  end UserDefinedComponents; 
    268274     
    269   package RequirementsForSimulationTool "Requirements for Simulation Tools"  
     275  class RequirementsForSimulationTool "Requirements for Simulation Tools"  
     276       
    270277    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    271278  

  • Modelica/trunk/Modelica/Media/Incompressible.mo

    r544 r548  
    770770systems, see the section about 
    771771<a href=\"Modelica:Modelica.Media.UsersGuide.MediumUDefinition.StaticStateSelection\">Static 
    772 state selection</a> in the Modelica.Media users guide. 
     772state selection</a> in the Modelica.Media user's Guide. 
    773773  
    774774</p> 

  • Modelica/trunk/Modelica/Media/package.mo

    r547 r548  
    5858 
    5959 
    60 package UsersGuide "User's Guide of Media Library"  
     60class UsersGuide "User's Guide of Media Library"  
    6161   
    6262  annotation (DocumentationClass=true, Documentation(info="<HTML> 
    … …  
    135135</HTML>")); 
    136136   
    137   package MediumUsage "Medium usage"  
     137  class MediumUsage "Medium usage"  
    138138     
    139139    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    … …  
    12601260  end MediumUsage; 
    12611261   
    1262   package MediumDefinition "Medium definition"  
     1262  class MediumDefinition "Medium definition"  
    12631263     
    12641264    annotation (DocumentationClass=true, Documentation(info="<HTML> 
    … …  
    21122112Many improvements in the library, e.g., providing mixtures 
    21132113of the ideal gases, table based media, test suite for all media, improved and 
    2114 updated users guide. 
     2114updated user's Guide. 
    21152115</p> 
    21162116<h4><font color=\"#008000\">Version 0.9, 2004-10-18</font></h4> 
    … …  
    21602160<li> The effort for the development of the Modelica.Media library has been 
    21612161     organized by Martin Otter who also contributed to the design, 
    2162      implemented part of the generic models, contributed to the users guide 
     2162     implemented part of the generic models, contributed to the user's Guide 
    21632163     and provided the generic test suite Modelica.Media.Examples.Tests.</li> 
    21642164<li> The basic idea for the medium model interface based on packages 
    … …  
    21822182        and Modelica_Fluid libraries and gave valuable feedback.</li> 
    21832183<li> Francesco Casella has been the most relentless bug-hunter and tester of the  
    2184      water and ideal gas properties. He also contributed to the users guide.</li>       
     2184     water and ideal gas properties. He also contributed to the user's Guide.</li>       
    21852185<li> John Batteh, Daniel Bouskela, Jonas Eborn, Andreas Idebrant, Charles Newman,  
    21862186     Gerhart Schmitz, and the users of the ThermoFluid library provided 

  • Modelica/trunk/Modelica/SIunits.mo

    r540 r548  
     1within Modelica; 
    12package SIunits  
    23  "Type and unit definitions based on SI units according to ISO 31-1992"  
    3 package UsersGuide "User's Guide"  
     4package UsersGuide "User's Guide of SIunits Library"  
     5     
    46  annotation (DocumentationClass=true, Documentation(info="<HTML> 
    5 <h4>User's Guide of package SIunits</h4> 
    67<p> 
    78Library <b>SIunits</b> is a <b>free</b> Modelica package providing 
    … …  
    1213</HTML>")); 
    1314     
    14   package HowToUseSIunits "How to use SIunits"  
     15  class HowToUseSIunits "How to use SIunits"  
    1516       
    1617    annotation (DocumentationClass=true, Documentation(info="<html> 
    17 <h4>How to use SIunits</h4> 
    18  
    1918<p> 
    2019When implementing a Modelica model, every variable needs to 
    … …  
    128127  end HowToUseSIunits; 
    129128     
    130   package Conventions "Conventions"  
     129  class Conventions "Conventions"  
    131130       
    132131    annotation (DocumentationClass=true, Documentation(info="<html> 
    133 <h4>Conventions</h4> 
    134  
    135132<p>The following conventions are used in package SIunits:</p> 
    136133<ul> 
    … …  
    177174       
    178175    annotation (Documentation(info="<html> 
    179 <h4>Literature</h4> 
    180  
    181176<p> This package is based on the following references 
    182177</p> 
    … …  
    203198       
    204199    annotation (Documentation(info="<html> 
    205 <h4>Contact</h4> 
    206  
    207200<dl> 
    208201<dt><b>Main Author:</b> 
    … …  
    280273<li><i>Dec. 14, 2005</i> 
    281274       by <a href=\"http://www.robotic.dlr.de/Martin.Otter/\">Martin Otter</a>:<br> 
    282        Add users guide and removed \"min\" values for Resistance and Conductance.</li> 
     275       Add user's Guide and removed \"min\" values for Resistance and Conductance.</li> 
    283276<li><i>October 21, 2002</i> 
    284277       by <a href=\"http://www.robotic.dlr.de/Martin.Otter/\">Martin Otter</a> 

  • Modelica/trunk/Modelica/StateGraph.mo

    r540 r548  
     1within Modelica; 
    12package StateGraph  
    23  "Library to model discrete event and reactive systems by hierarchical state machines"  
    … …  
    118119      Rectangle(extent=[26,-22; 64,-56],  style(color=0, rgbcolor={0,0,0})))); 
    119120   
    120 package UsersGuide "User's Guide of StateGraph Library"  
     121class UsersGuide "User's Guide of StateGraph Library"  
    121122     
    122123  annotation (DocumentationClass=true, Documentation(info="<html> 
    … …  
    125126components to model <b>discrete event</b> and <b>reactive</b>  
    126127systems in a convenient 
    127 way. This package contains the <b>users guide</b> for  
     128way. This package contains the <b>user's Guide</b> for  
    128129the library and has the following content: 
    129130</p> 

  • Modelica/trunk/Modelica/Utilities/package.mo

    r540 r548  
     1within Modelica; 
    12package Utilities "Utility functions especially for scripting (operating on files, streams, strings, system)" 
    23  extends Modelica.Icons.Library; 
    … …  
    5455 
    5556 
    56 package UsersGuide "User's Guide of Utilities Library"  
     57class UsersGuide "User's Guide of Utilities Library"  
     58   
    5759  annotation (DocumentationClass=true, Documentation(info="<HTML> 
    5860<p> 
    5961Library <b>Modelica.Utilities</b> contains Modelica <b>functions</b> that are 
    6062especially suited for <b>scripting</b>. Currently, only a rudimentary 
    61 users guide is present. This will be improved in the next releases. 
    62 The users guide has currently the following chapters: 
     63user's Guide is present. This will be improved in the next releases. 
     64The user's Guide has currently the following chapters: 
    6365</p> 
    6466<ol> 

  • Modelica/trunk/Modelica/package.mo

    r547 r548  
    8181</p> 
    8282<p> 
    83 This package contains a short <b>users guide</b> for  
     83This package contains a short <b>user's Guide</b> for  
    8484the overall library. Some of the main sublibraries have their own 
    85 users guides that can be accessed by the following links: 
     85user's Guides that can be accessed by the following links: 
    8686</p> 
    8787 
    … …  
    14561456     description texts to parameters, connector instances, function input 
    14571457     and output arguments etc., in order that the automatically generated 
    1458      tables do not have empty entries. Also new users guides for sublibraries 
    1459      Rotational and SIunits have been added and the users guide on top 
     1458     tables do not have empty entries. Also new user's Guides for sublibraries 
     1459     Rotational and SIunits have been added and the user's Guide on top 
    14601460     level (Modelica.UsersGuide) has been improved.<br>&nbsp;</li> 
    14611461  
    … …  
    15381538  <tr><td colspan=\"2\"><b>Modelica.Mechanics.Rotational.</b></td></tr> 
    15391539  <tr><td>UsersGuide</td> 
    1540       <td> A users guide has been added by using the documentation previously 
     1540      <td> A user's Guide has been added by using the documentation previously 
    15411541           present in the package documentation of Rotational.</td> </tr> 
    15421542  <tr><td>Sensors.PowerSensor</td> 
    … …  
    15651565  <tr><td colspan=\"2\"><b>Modelica.SIunits.</b></td></tr> 
    15661566  <tr><td>UsersGuide</td> 
    1567       <td> A users guide has been added that describes unit handling.</td> </tr> 
     1567      <td> A user's Guide has been added that describes unit handling.</td> </tr> 
    15681568  <tr><td> Resistance<br> 
    15691569           Conductance</td>