Template:EquationRef/doc: Difference between revisions

From Flowpedia
Created page with "{{#ifeq:{{ROOTPAGENAME}}|EquationRef|{{tsh|EqRef}}}} {{Documentation subpage}} The pair of templates {{tl|EquationRef}} and {{tl|EquationNote}} is used for labeling equations in text. For example, {{markup2|m=<nowiki>:{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math></nowiki>|r= :{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math>}} Here, the identifier "'''Eq. 1'''" is a label which can be later referred to with a call to {{tl|EquationNote}}. That is, {{tlb|EquationNote|Eq. 1}} pr..."
 
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#ifeq:{{ROOTPAGENAME}}|EquationRef|{{tsh|EqRef}}}}
{{#ifeq:{{ROOTPAGENAME}}|EquationRef|{{tsh|EqRef}}}}
{{Documentation subpage}}
{{Documentation subpage}}
The pair of templates {{tl|EquationRef}} and {{tl|EquationNote}} is used for labeling equations in text.


For example, {{markup2|m=<nowiki>:{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math></nowiki>|r=
The pair of templates <nowiki>{{tl|EquationRef}}</nowiki> and <nowiki>{{tl|EquationNote}}</nowiki> is used for labeling equations in text.
:{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math>}}
Here, the identifier "'''Eq. 1'''" is a label which can be later referred to with a call to {{tl|EquationNote}}. That is, {{tlb|EquationNote|Eq. 1}} produces a link {{EquationNote|Eq. 1}} to this equation.


Similarly, {{markup2|m=<nowiki>:{{EquationRef|2|Eq. 2:}} <math>x^2-2x+1=0</math></nowiki>|r=
For example,  
:{{EquationRef|2|Eq. 2:}} <math>x^2-2x+1=0</math>}}
which can be referred to by {{tlb|EquationNote|2}} or even {{tlb|EquationNote|2|Equation 2}} (i.e., {{EquationNote|2|Equation 2}}).


This template can be used together with {{tl|NumBlk}} to produce nicely formatted numbered equations.  For instance:
* <code><nowiki>:{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math></nowiki></code>


* <code><nowiki>{{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|3}}}}</nowiki></code>
:{{EquationRef|Eq. 1}} <math>x^2+x+1=0</math>


{{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|3}}}}
Here, the identifier "'''Eq. 1'''" is a label which can be later referred to with a call to <nowiki>{{tl|EquationNote}}</nowiki>. That is, <nowiki>{{tlb|EquationNote|Eq. 1}}</nowiki> produces a link <nowiki>{{EquationNote|Eq. 1}}</nowiki> to this equation.


:which may then be referred to by {{tlb|EquationNote|3}} or even {{tlb|EquationNote|3|Eq. 3}} (i.e., {{EquationNote|3|Eq. 3}}).
Similarly,  


* <code><nowiki>{{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|4|Eq.4}}}}</nowiki></code>
* <code><nowiki>:{{EquationRef|2|Eq. 2:}} <math>x^2-2x+1=0</math></nowiki></code>


{{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|4|Eq. 4}}}}
:{{EquationRef|2|Eq. 2:}} <math>x^2-2x+1=0</math>


:which may be referred to by {{tlb|EquationNote|4}} (i.e., {{EquationNote|4}}).
which can be referred to by <nowiki>{{tlb|EquationNote|2}}</nowiki> or even <nowiki>{{tlb|EquationNote|2|Equation 2}}</nowiki> (i.e., {{EquationNote|2|Equation 2}}).


* <code><nowiki>{{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|Eq.5}}}}</nowiki></code>
This template can be used together with <nowiki>{{tl|NumBlk}}</nowiki> to produce nicely formatted numbered equations.  For instance:


{{NumBlk|::|<math>x^2+x+1=0</math>|{{EquationRef|Eq. 5}}}}
* <code><nowiki>{{NumBlk2|::|<math>x^2+x+1=0</math>|3}}</nowiki></code>


:which may be referred to by {{tlb|EquationNote|Eq. 5}} (i.e., {{EquationNote|Eq. 5}}).
{{NumBlk2|::|<math>x^2+x+1=0</math>|3}}


The common shorthand '''(#)''' can be written using {{template|EqNote}}, e.g. {{tlb|EqNote|5}} gives {{EqNote|5}}
:which may then be referred to by <nowiki>{{tlb|EquationNote|3}}</nowiki> or even <nowiki>{{tlb|EquationNote|3|Eq. 3}}</nowiki> (i.e., {{EquationNote|3|Eq. 3}}).


=== See Also ===
* <code><nowiki>{{NumBlk2|::|<math>x^2+x+1=0</math>|Eq.4}}</nowiki></code>
* {{t|EqNote}}


<includeonly>{{Sandbox other||
{{NumBlk2|::|<math>x^2+x+1=0</math>|Eq.4}}
[[Category:Mathematical formatting templates]]


}}</includeonly>
:which may be referred to by <nowiki>{{tlb|EquationNote|4}}</nowiki> (i.e., {{EquationNote|4}}).
 
* <code><nowiki>{{NumBlk2|::|<math>x^2+x+1=0</math>|Eq.5}}</nowiki></code>
 
{{NumBlk2|::|<math>x^2+x+1=0</math>|5}}
 
:which may be referred to by <nowiki>{{tlb|EquationNote|Eq. 5}}</nowiki> (i.e., {{EquationNote|Eq. 5}}).
 
The common shorthand '''(#)''' can be written using <nowiki>{{template|EqNote}}</nowiki>, e.g. <nowiki>{{tlb|EqNote|5}}</nowiki> gives {{EqNote|5}}