.BuildingControlLib.BuildingControl.VDI3813.UsersGuide.Convention

Information

Overview

Conventions which should be applied when implementing models in this package. As for now only a convention for the documentation is included.

The figures of the functions which are taken from the VDI 3813 are unified to the same width of 600 pixels. Just the width is determined and coupled to the heigth so the size ratio stays the same. The class diagrams are also adjusted to a width of 600 pixels.

We recommend and applied when ever possible to enclose test in separate paragraphs (i.e. <p></p>).

Modelica-Vorgabe: Text in der Dokumentation immer in Paragraphen, nicht freistehend. Whenever a newline is required refrain from using <br></br> but enclose in a separate paragraph. All references are gathered in the UsersGuide and referred to when cited.

Contents

Name	Description
DocumentationTemplate	Template documentation of control functions implementation

Revisions

• March 07, 2017  by Georg Ferdinand Schneider & Georg Ambrosius Peßler:
  Implemented.