.Modelica.UsersGuide.Conventions.Documentation.Format.Hyperlinks

Information

1. Hyperlinks should always be made when referring to a component or package.
2. The hyperlink text in between <a href="..."> and </a> should include the full main package name.
3. A link to an external component should include the full name of the package that it is referred to.
4. Modelica hyperlinks have to use the scheme "modelica://..."
5. For hyperlinks referring to a Modelica component, see Example 1 and 2.
6. No links to commercial web sites are allowed.

Examples

Example 1

<a href="modelica://Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops">
         Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops</a>

appears as

Example 2

<p>
  The feeder cables are connected to an
  <a href="modelica://Modelica.Electrical.Machines.BasicMachines.InductionMachines.IM_SquirrelCage">
  induction machine</a>.
</p>

appears as

The feeder cables are connected to an induction machine.