Skip to content

Commit

Permalink
Add a rule priorizing the 'general' tab
Browse files Browse the repository at this point in the history
  • Loading branch information
tobolar committed Oct 27, 2023
1 parent 86d1f7c commit 54d744a
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions Modelica/package.mo
Original file line number Diff line number Diff line change
Expand Up @@ -1232,41 +1232,45 @@ The annotations "tab" and "group" define the placement of
component or of variables in a dialog.
</p>
<p>
Using the <strong>tab</strong> annotation, the following rules shall be followed:
Using the <strong>group</strong> annotation, the following rules shall be followed:
</p>
<ul>
<li>
Label tabs based on their pattern. The label shall clearly reflect
the content of the collected variables.
</li>
<ol>
<li>
Avoid long tab labels. One or two words are mostly sufficient.
Avoid excessively long group labels.
</li>
<li>
Use nouns rather than verbs, without ending punctuation.
</li>
<li>
Use sentence-style capitalization.
</li>
<li>
Visibility of parameters collected in one tab shall not be dependent
on parameters shown in another tab.
</li>
</ul>
</ol>
<p>
Using the <strong>group</strong> annotation, the following rules shall be followed:
Using the <strong>tab</strong> annotation, the following rules shall be followed:
</p>
<ul>
<ol>
<li>
Avoid excessively long group labels.
Try to group components or variables in the default \"general\" tab first.
But feel free to define a&nbsp;new tab it they are so many.
</li>
<li>
Label tabs based on their pattern. The label shall clearly reflect
the content of the collected variables.
</li>
<li>
Avoid long tab labels. One or two words are mostly sufficient.
</li>
<li>
Use nouns rather than verbs, without ending punctuation.
</li>
<li>
Use sentence-style capitalization.
</li>
</ul>
<li>
Visibility of parameters collected in one tab shall not be dependent
on parameters shown in another tab.
</li>
</ol>
</html>"));
end Format;

Expand Down

0 comments on commit 54d744a

Please sign in to comment.