Webel: SysML4Mathematica: Convention: A prefix 'sym$' indicates a markup variable "symbol" for a documented variable. It need not be a String, but each referenced part MUST be a String, not a raw Mathematica Symbol, to avoid namespace clashes!

Each documented variable may be accompanied by a definition of a markup "symbol" (does not mean a Mathematica Symbol) for use in generation of human friendly markup equations. Some examples from the Webel Psy library for Psychrometrics in Mathematica:

sym$psy$p = "p";

Note how in the above a String "p" is used to avoid clashes with the Symbol p.

Where subscripts are used, they MUST also be Strings:

sym$psy$m$wat$i = Subscript["m","w","in"];

sym$psy$m$a = Subscript["m","a"];

sym$psy$w1 = Subscript["w","1"];

sym$psy$w2 = Subscript["w","2"];

Defined 'sym$' markup variables may then be used to create human friendly equations:

eq$psy$E$m$wat$i = sym$psy$m$wat$i ==
 psy$E$m$wat$i[sym$psy$m$a, sym$psy$w1, sym$psy$w2];

The human friendly Mathematica equation output is:

Note that:

For an example of this convention being used to create an equation registry visit:

This convention works together with: