Template:Unit/doc: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>David Yamakuchi
mNo edit summary
imported>David Yamakuchi
mNo edit summary
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Usage ==
== Usage ==


This template is dual purpose:
This template is multi-purpose:


#Format the units notation such that it can be compactly displayed in tables, etc.  
#Format the units notation such that it can be compactly displayed in tables, etc.  
#Remove the units for certain pages that may need to do math with the numeric (magnitude) value.
#Remove the units for certain pages (currently /Sandbox and /Data pages) that may need to do math with the numeric (magnitude) value.
#Specify conditions under which the data is valid.


Please see [[Oxygen/Boiling_point]],{{Tl|Unit/Doc/Properties}} and {{Tl|Unit/Doc/Data}} for examples of usage in context.
Please see [[Oxygen/Boiling_point]], {{Tl|Unit/Doc/Properties}}, and {{Tl|Unit/Doc/Data}} for examples of usage in context.


<nowiki>{{Unit|kJ/mol}}</nowiki>
<nowiki>{{Unit|kJ/mol}}</nowiki>
Line 17: Line 18:


{{Unit|kJ/mol}}
{{Unit|kJ/mol}}
== Code ==
<pre><includeonly>{{#switch: {{SUBPAGENAME}}
|Doc
|doc
|Properties='''''<small>{{{1|}}}</small>'''''{{#if:{{{2|}}}|<nowiki>*</nowiki>}}{{#if:{{{3|}}}|<sup><small>†</small></sup>}}{{#if:{{{4|}}}|<sup><small>‡</small></sup>}}
|Sandbox=
|Data=
|{{BASEPAGENAME}}='''''<small>{{{1|}}}</small>'''''{{#if:{{{2|}}}|<nowiki>*</nowiki>}}
|'''''<small>{{{1|}}}</small>'''''{{#if:{{{2|}}}|<nowiki>*</nowiki>}}{{#if:{{{3|}}}|<sup>†</sup>}}{{#if:{{{4|}}}|<sup>‡</sup>}}{{#if:{{{2|}}}|<br /><blockquote><nowiki>*</nowiki>{{{2|}}}</blockquote>}}{{#if:{{{3|}}}|<br /><blockquote>†{{{3|}}}</blockquote>}}{{#if:{{{4|}}}|<br /><blockquote>‡{{{4|}}}</blockquote>}}
}}</includeonly><noinclude>{{TlDoc}}</noinclude>
</pre>
== Explanation of code ==
The behavior is controlled (#switched) by the SUBPAGENAME. 
*In the case the subpage is a /Doc, a /doc, or a /Properties, Show a small, bold, italicized, unit (<nowiki>{{{1|}}}</nowiki>) with an asterisk for note (#if: <nowiki>{{{2|}}}</nowiki>), sword for note2 (#if: <nowiki>{{{3|}}}</nowiki>), etc.  Don't actually show the notes themselves.
*In the case the subpage is a /Sandbox or a /Data page, do nothing.  don't include any unit info.  ''This'' subpage can do arithmetic operations on the data and won't want pesky unit information making things difficult.
*In the case of SUBPAGENAME = BASEPAGENAME , we are '''''in''''' an article!  Just show a small, bold, italicized, unit with an asterisk if there are notes.  Don't actually show the notes themselves, or even more symbols if there are multiple notes.
*In all other cases show:
**the small, bold, italicized, '''''<small>unit</small>'''''<sup>*†‡</sup> immediately followed by any symbols indicating notes.
<blockquote><nowiki>*</nowiki>Then do a line break and show each symbol again,<br/>
†followed by it's note.<br/>
‡Up to three notes are supported, separated by line breaks.<br/></blockquote>

Latest revision as of 06:07, 16 December 2008

Usage

This template is multi-purpose:

  1. Format the units notation such that it can be compactly displayed in tables, etc.
  2. Remove the units for certain pages (currently /Sandbox and /Data pages) that may need to do math with the numeric (magnitude) value.
  3. Specify conditions under which the data is valid.

Please see Oxygen/Boiling_point, {{Unit/Doc/Properties}}, and {{Unit/Doc/Data}} for examples of usage in context.

{{Unit|kJ/mol}}

Example:

{{Unit|kJ/mol}}

gives:

kJ/mol

Code

<includeonly>{{#switch: {{SUBPAGENAME}}
|Doc
|doc
|Properties='''''<small>{{{1|}}}</small>'''''{{#if:{{{2|}}}|*}}{{#if:{{{3|}}}|<sup><small>†</small></sup>}}{{#if:{{{4|}}}|<sup><small>‡</small></sup>}}
|Sandbox=
|Data=
|{{BASEPAGENAME}}='''''<small>{{{1|}}}</small>'''''{{#if:{{{2|}}}|*}}
|'''''<small>{{{1|}}}</small>'''''{{#if:{{{2|}}}|*}}{{#if:{{{3|}}}|<sup>†</sup>}}{{#if:{{{4|}}}|<sup>‡</sup>}}{{#if:{{{2|}}}|<br /><blockquote>*{{{2|}}}</blockquote>}}{{#if:{{{3|}}}|<br /><blockquote>†{{{3|}}}</blockquote>}}{{#if:{{{4|}}}|<br /><blockquote>‡{{{4|}}}</blockquote>}}
}}</includeonly><noinclude>{{TlDoc}}</noinclude>


Explanation of code

The behavior is controlled (#switched) by the SUBPAGENAME.

  • In the case the subpage is a /Doc, a /doc, or a /Properties, Show a small, bold, italicized, unit ({{{1|}}}) with an asterisk for note (#if: {{{2|}}}), sword for note2 (#if: {{{3|}}}), etc. Don't actually show the notes themselves.
  • In the case the subpage is a /Sandbox or a /Data page, do nothing. don't include any unit info. This subpage can do arithmetic operations on the data and won't want pesky unit information making things difficult.
  • In the case of SUBPAGENAME = BASEPAGENAME , we are in an article! Just show a small, bold, italicized, unit with an asterisk if there are notes. Don't actually show the notes themselves, or even more symbols if there are multiple notes.
  • In all other cases show:
    • the small, bold, italicized, unit*†‡ immediately followed by any symbols indicating notes.

*Then do a line break and show each symbol again,

†followed by it's note.

‡Up to three notes are supported, separated by line breaks.