Knowledge Base Article

Using the Equation Editor Markup Tab

In the Equation Editor, go to the Markup Tab.  The Markup Tab is used to create a graphical math display that accompanies your equation.  When your equation is used, the contents of the Markup Tab are displayed to the user.  The Markup Tab includes some important features that enhance the display of your equation.  These include:

  1. Equation display:  The content on the left hand side (LHS) and right hand side of the equal sign are displayed to convey information to your equation user.
  2. Ascii Math:  The syntax for both sides of the equation are interpreted by the Ascii Math function and translated into more realistic math format.  This includes a powerful list of display features for parenthesis, brackets, braces, Greek letters, math operation symbols, vectors and matrices.  Click HERE for help with Ascii Math.  After you have entered values in the Markup windows, click inside the Preview window and the markup will be displayed as rendered in Ascii Math.
  3. Runtime Numeric Substitution: The vCalc display of your equation can be updated real-time when a user enters numeric values for input parameters.  If the input parameters from the Algorithm are used in the Markup with the # symbol before the name, vCalc will substitute the symbol with the user entered value.  In the example below, (b) base and (h) height are the two input parameters from the Algorithm.  When the user enters their values, the display will be updated with the numeric values appropriately substituted.  This feature is optional, and not always practical.  Some equations and algorithms are too complex for math rendering.  However, a convention is often used to say that an equation is a function of input parameters, .e.g `w = f(x,y,z)`.  In this case, the substitutions of `x, y` and `z` can still be made in the display.

Summary Steps for the Markup Tab

  1. Enter the name of the equation on the LHS of the equal sign (see the figure below). The name of the equation should be in double quotes e.g. "Area".
  2. Enter the equation's variables on the RHS beginning with a "#" start symbol before each variable. These will be substituted with the user-entered value.
  3. Click on the preview pane to see the math display of the equation.

MathMarkup.png                                                    Equation Editor : Markup Tab