Difference between revisions of "Template:CODATA2010/linktovalue/doc"

From blackwiki
Jump to navigation Jump to search
imported>Electrical & computer engineer
(created documentation)
 
imported>Electrical & computer engineer
(→‎Parameters: updated documentation for parameter "text" and →‎See also: added Template:CODATA2010/longname)
 
Line 7: Line 7:
 
=== Parameters ===
 
=== Parameters ===
 
*'''constant''': The name of the constant whose webpage is to be linked to. Using the name of a constant as an unnamed parameter is the same as using it for the value of the parameter <code>constant</code>; if both parameters are included, <code>constant</code> takes precedence.
 
*'''constant''': The name of the constant whose webpage is to be linked to. Using the name of a constant as an unnamed parameter is the same as using it for the value of the parameter <code>constant</code>; if both parameters are included, <code>constant</code> takes precedence.
*'''text''' (''optional''): specifies whether the link is to contain text. The default is for the link to contain no text; if <code>text=dltv</code>, the text is "Direct link to value". In the future, "Direct link to value" may be replaced with the title of the linked webpage, namely "CODATA Value:    ''name of constant'' ".  
+
*'''text''' (''optional''): specifies the text the link is to contain, if any. If <code>text</code> is not set or <code>text=none</code>, the link will not contain any text. If <code>text=title</code>, the text will be "CODATA Value:    ''name of constant'' ". If <code>text=dltv</code>, the text will be "Direct link to value". If <code>text</code> is anything else, the text of the link will be the value of <code>text</code>.  
  
 
=== Usage examples ===
 
=== Usage examples ===
Line 16: Line 16:
  
 
[[Template:CODATA2010/abbrev]]
 
[[Template:CODATA2010/abbrev]]
 +
 +
[[Template:CODATA2010/longname]]
  
 
[[Template:CODATA2006]]
 
[[Template:CODATA2006]]

Latest revision as of 23:52, 23 June 2011

Purpose

This template produces an external link to the NIST webpage for a specific constant.

Parameters

  • constant: The name of the constant whose webpage is to be linked to. Using the name of a constant as an unnamed parameter is the same as using it for the value of the parameter constant; if both parameters are included, constant takes precedence.
  • text (optional): specifies the text the link is to contain, if any. If text is not set or text=none, the link will not contain any text. If text=title, the text will be "CODATA Value: name of constant ". If text=dltv, the text will be "Direct link to value". If text is anything else, the text of the link will be the value of text.

Usage examples

See Template:CODATA2010/linktovalue/testcases#Testing main template

See also

Template:CODATA2010

Template:CODATA2010/abbrev

Template:CODATA2010/longname

Template:CODATA2006