Jump to content

Template:EquationRef/doc

From ARC Technical Repository

{{#ifeq:EquationRef|EquationRef|

}}

{{#ifeq:doc |doc

    | 

{{#ifeq:show |show

|

        }}{{#if:|
         |{{#ifexist:Template:EquationRef
                  | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  | 
                 }}
        }}
    | 
   }}

The pair of templates {{EquationRef}} and {{EquationNote}} is used for labeling equations in text.

For example, {{#if: |{{#if:||}}

  • :{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math>
    {{#if: |{{{2}}}|Eq. 1}} x2+x+1=0|*:{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math>
    {{#if: |{{{2}}}|Eq. 1}} x2+x+1=0}}{{#if: |
  • }}{{#if: |
  • }}{{#if: |
  • }}{{#if: |
  • }}

Here, the identifier "Eq. 1" is a label which can be later referred to with a call to {{EquationNote}}. That is, {{EquationNote|Eq. 1}} produces a link {{#if:|{{{2}}}|Eq. 1}} to this equation.

Similarly, {{#if: |{{#if:||}}

  • :{{EquationRef|2|Eq. 2:}} <math>x^2-2x+1=0</math>
    {{#if: Eq. 2:|Eq. 2:|2}} x22x+1=0|*:{{EquationRef|2|Eq. 2:}} <math>x^2-2x+1=0</math>
    {{#if: Eq. 2:|Eq. 2:|2}} x22x+1=0}}{{#if: |
  • }}{{#if: |
  • }}{{#if: |
  • }}{{#if: |
  • }}

which can be referred to by {{EquationNote|2}} or even {{EquationNote|2|Equation 2}} (i.e., {{#if:Equation 2|Equation 2|2}}).

This template can be used together with {{NumBlk}} to produce nicely formatted numbered equations. For instance:

  • {{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|3}}}}
which may then be referred to by {{EquationNote|3}} or even {{EquationNote|3|Eq. 3}} (i.e., {{#if:Eq. 3|Eq. 3|3}}).
  • {{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|4|Eq.4}}}}
which may be referred to by {{EquationNote|4}} (i.e., {{#if:|{{{2}}}|4}}).
  • {{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|Eq.5}}}}
which may be referred to by {{EquationNote|Eq. 5}} (i.e., {{#if:|{{{2}}}|Eq. 5}}).

The common shorthand (#) can be written using {{EqNote}}, e.g. {{EqNote|5}} gives ({{#if:|{{{2}}}|5}})

See Also[edit source]