View source for Template:SI light units/doc

{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->

== Usage ==

This template displays a table of SI photometry units for usage in articles about photometry. It may also serve as a navigation box at the end of corresponding articles.

The template supports three optional parameters to finetune its behaviour.

== Parameters ==

Documentation of parameters:

=== Parameter 1 ===

'''1 = undefined or empty'''

The template will not display the string "Table X. " in front of the table's title "SI photometry units".

'''1 = <number>'''

The template will display the table number as part of the table header in the following form: "Table <number>. SI photometry units.", where <number> is a placeholder for the number (or other table designation) given as parameter.

=== Parameter 2 ===

'''2 = undefined or empty'''

The template will not show a "(Compare)" link in the table footer.

'''2 = "self"'''

The template will display a "(Compare) link in the table footer to jump to the corresponding radiometry table within the same article for quick comparisons. In order for this to work, the radiometry table must be included using the template <code><nowiki>{{SI radiometry units}}</nowiki></code> as well. It is not necessary to reload the article for comparison.

'''2 = any non-empty string other than "self"'''

The template will display a "(Compare)" link (as above). However, the link will point to the corresponding radiometry table in the separate article on "[[Radiometry]]", not to within the article, where the <code><nowiki>{{SI light units}}</nowiki></code> template has been included. This is useful, if the other table should not be included in the article.

=== Parameter 3 ===

'''3 = undefined'''

The table's footnotes will be grouped in a reference group named "nb" and displayed immediately after the table. In order to avoid conflicts with other references in the article, it is advisable to use other group names for external references (default is ""). Otherwise, these external references would be listed after the table as well.

'''3 = empty, that is: ""'''

The table's footnotes will be grouped in the article's default group "", as used for all other references without specific group names. It is important to manually include a <code><nowiki><references/></nowiki></code> tag or the <code><nowiki>{{Reflist}}</nowiki></code> template somewhere in the article. This is the place where the footnotes will show up. 

'''3 = <groupname>'''

The table's footnotes will be grouped in a reference group named as specified in the groupname. It is important to manually include a <code><nowiki><references group="<groupname>"/></nowiki></code> tag or the <code><nowiki>{{Reflist|group=<groupname>}}</nowiki></code> template somewhere in the article. This is the place where the footnotes will show up. Try to use a short groupname, as the table will look nicer this way.

=== Examples ===

Some easy examples:

<pre>
{{SI light units}}
{{SI light units|1}}
{{SI light units|1|compare}}
{{SI light units||compare}}
{{SI light units|1|compare|""}}
{{SI light units|1||""}}
{{SI light units||compare|""}}
{{SI light units|1|compare|Note}}
{{SI light units|||notes}}
{{SI light units||compare|Note}}
</pre>

Combining both tables in a single article (individually grouped footnotes in group "nb"):

<pre>
{{SI light units|1|self}}
{{SI radiometry units|2|self}}
</pre>

Combining both tables in a single article (individual footnotes in separately named groups, for example "T1" and "T2"):

<pre>
{{SI light units|1|self|T1}}
{{Reflist|group=T1}}
{{SI radiometry units|2|self|T2}}
{{Reflist|group=T2}}
</pre>

Combining both tables in a single article (combined footnotes, for example in group "nb"):

<pre>
{{SI light units|1|self|nb}}
{{SI radiometry units|2|self|nb}}
...
{{Reflist|group=nb}}
</pre>

Combining both tables in a single article (combined footnotes with default references):

<pre>
{{SI light units|1|self|""}}
{{SI radiometry units|2|self|""}}
...
{{Reflist}}
</pre>

== Notes ==

Ideally, the "(Compare)" link would show up to the left or right of the table header, similar to the "v d e" links. Thereby, the cursor would remain in the same position and one could flip back and forth between the two tables without any necessary window realignment. However, this would require a small change in the <code><nowiki>{{Tnavbar-header}}</nowiki></code> template.

== See also ==

* [[Template:SI radiometry units]]
* [[Template:SI photon units]]
* [[Template:Navbar-header]]

<includeonly>
<!-- Categories and interwikis go here: -->
[[Category:SI unit templates]]

[[fr:Modèle:SI unités photométriques]]
</includeonly>