Difference between revisions of "Template:CODATA2010/doc"

From blackwiki
Jump to navigation Jump to search
imported>Electrical & computer engineer
(copied documentation from Template:CODATA2006 with modifications)
 
imported>Electrical & computer engineer
(updated documentation)
Line 3: Line 3:
  
 
=== Usage ===
 
=== Usage ===
'''CODATA2010''' is for referencing the 2010 [[CODATA]] recommended values of physical constants.  
+
'''CODATA2010''' is for transcluding and/or referencing the 2010 [[CODATA]] recommended values of physical constants.  
 +
 
 +
==== Parameter ====
 +
*'''constant''' (''optional''): the short or long name of the physical constant to be transcluded, if any.
 +
*'''include-units''' (''optional''): (<code>no</code>, <code>no link</code>, or default '''<code>link</code>'''). Respectively, omits the units (appropriate when the units are given elsewhere in the article), merely includes the units, or includes the units as links to the page about the unit. Requires '''constant''' to be set.
 +
*'''link-to-value''' (''optional''): (<code>no</code> or default '''<code>yes</code>'''). If <code>yes</code>, includes a link to NIST's webpage on that specific constant. Requires '''constant''' to be set.
 +
*'''ref''' (''optional''): (<code>no</code> or default '''<code>yes</code>'''). If <code>yes</code>, creates a reference.
 +
 
 +
==== Examples ====
 +
See [[Template:CODATA2010/testcases#Testing main template]]
  
 
=== See also ===
 
=== See also ===

Revision as of 01:09, 17 June 2011

Usage

CODATA2010 is for transcluding and/or referencing the 2010 CODATA recommended values of physical constants.

Parameter

  • constant (optional): the short or long name of the physical constant to be transcluded, if any.
  • include-units (optional): (no, no link, or default link). Respectively, omits the units (appropriate when the units are given elsewhere in the article), merely includes the units, or includes the units as links to the page about the unit. Requires constant to be set.
  • link-to-value (optional): (no or default yes). If yes, includes a link to NIST's webpage on that specific constant. Requires constant to be set.
  • ref (optional): (no or default yes). If yes, creates a reference.

Examples

See Template:CODATA2010/testcases#Testing main template

See also