View source for Template:Earthquake energy class/doc

{{documentation subpage}}
Displays "K", the label for earthquake magnitude used in the  ''[[energy class ]]'' (K-class) system. Optionally includes: an explanatory wikilink, a subscripted code to indicate a variant scale, and (in parentheses) the source catalog or network. Recommended use of this template is for the first use of "K" in an article. In all cases the article is added to a tracking category.

For M (magnitude) values that have been calculated from the published K value please use the {{Earthquake magnitude|k}} form ({{tlx|Earthquake magnitude|k}}) via [[:Template:Earthquake magnitude]]. There are a variety of formulas for such calculations; any such calculation done in an article should note the formula used and the source describing it.

=== Usage ===

* <code><nowiki>{{Earthquake energy class| <code> | src = <source> | link=y }}</nowiki></code>

Does not take a value or relation. All parameters optional.

===Examples===

Label only:
* {{tlx|Earthquake energy class}}&nbsp;→ {{Earthquake energy class|}}

Automatically wikilinked to the article.

To indicate a variant scale:
* {{tlx|Earthquake energy class|R}}&nbsp;→ {{Earthquake energy class|R}}

Same as above, but add the explanatory wikilink with {{para|link|y}}:
* {{tlx|Earthquake energy class|R|link&#61;y}}&nbsp;→ {{Earthquake energy class|R|link=y}}

To indicate the source from which K is taken – the catalog, a regional
network, a specific station, or the particular version of K used in a
source – use the {{para|src}} parameter:
* {{tlx|Earthquake energy class|src&#61;GNRL}}&nbsp;→ {{Earthquake energy class|src=GNRL}}
* {{tlx|Earthquake energy class|src&#61;F68}}&nbsp;→ {{Earthquake energy class|src=F68}}

* {{tlx|Earthquake energy class|src&#61;ESSN|link&#61;y}}&nbsp;→ {{Earthquake energy class|src=ESSN|link=y}}
* {{tlx|Earthquake energy class|S|src&#61;Kamchatka|link&#61;y}}&nbsp;→ {{Earthquake energy class|S|src=Kamchatka|link=y}}

==See also==
* [[Energy class]]
* [[Seismic scale]]. Brief descriptions of the most common magnitude scales.
* [[:Template:Earthquake magnitude]]
* {{cl|Articles using templated earthquake magnitude scale}}
<includeonly>{{Sandbox other||
<!-- Categorization of the template itself -->
[[Category:Unit indicator templates]]
[[Category:Earthquakes]]
}}</includeonly>