View source for Template:Minor planet/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- This /doc is used for & on multiple templates: [[Template:Minor planet]], [[Template:Minor planet link]], [[Template:Minor planet link abridged]], [[Template:Minor planet moon link]], [[Template:Minor planet moon link abriged]] -->

= Usage =
The template '''minor planet''' easily formats the nomenclature of those minor planets that are known in whole or in part by their [[provisional designation]]. The template '''minor planet link''' obeys exactly the same syntax but outputs a wikilink to an article at the appropriate namespace. Use of these templates avoids [[Unicode]] complexities in article titles while still rendering subscripts.

The templates have been designed to allow the designations to be entered with a minimum of modification needed; pipe <code>|</code> characters replace transitions to and from subscript, as well as slashes <code>/</code> and parentheses <code>( )</code>.

==[[Template:minor planet]]==
{{template shortcut|mp}}
* To quickly format a minor planet ''identified solely by its provisional designation'' (i.e. without a catalogue number), use the following pseudocode:
*:: <span style="color:#009"><code><nowiki>{{minor planet|<leading numbers and letters>|<subscript number, if applicable>}}</nowiki></code></span>
*: For example, to create {{minor planet|2004 MN|4}}, use:
*:: <span style="color:#900"><code><nowiki>{{minor planet|2004 MN|4}}</nowiki></code></span>

* To quickly format a minor planet known by ''a combination of a permanent catalogue number and a provisional designation'', use the following pseudocode:
*:: <span style="color:#009"><code><nowiki>{{minor planet|<catalogue number>|<provisional designation's leading numbers and letters>|<provisional designation's subscript number, if applicable>}}</nowiki></code></span>
*:  For example,  to create {{mp|15788|1993 SB}}, use:
*:: <span style="color:#900"><code><nowiki>{{minor planet|15788|1993 SB}}</nowiki></code></span>
*:  Or, to create {{mp|15760|1992 QB|1}}, use:
*:: <span style="color:#900"><code><nowiki>{{minor planet|15760|1992 QB|1}}</nowiki></code></span>
*:  Note that similar results as the above can also be obtained by placing both the catalogue number (in parentheses) and the provisional designation in a single field.  For example, {{minor planet|(15760) 1992 QB|1}} can also be created by using:
*:: <span style="color:#900"><code><nowiki>{{minor planet|(15760) 1992 QB|1}}</nowiki></code></span>

* The provisional designations for ''satellites of minor planets'' make reference to the primary (the "parent body"): either to the primary's permanent catalogue number, or to the primary's provisional designation, but never both. To quickly format the provisional designation of a satellite of a minor planet, use the following pseudocode:
*:: <span style="color:#009"><code><nowiki>{{minor planet|S|<satellite's year of discovery>|<primary's catalogue number OR primary's provisional designation's leading numbers and letters>|<primary's provisional designation's subscript number, if applicable>|<satellite's trailing number>}}</nowiki></code></span>
*: Note that the template functions with either four or five fields used; in the event there is no subscripted text to be included, one can use only four fields and the last field will be assumed to define the trailing number.
*: For example, to create {{minor planet|S|2000|1998 WW|31|1}}, use:
*:: <span style="color:#900"><code><nowiki>{{minor planet|S|2000|1998 WW|31|1}}</nowiki></code></span>
*: Or, to create {{mp|S|2005|1994 XD|1}}, use:
*:: <span style="color:#900"><code><nowiki>{{minor planet|S|2005|1994 XD|1}}</nowiki></code></span>
*: Or, to create {{mp|S|2003|11264|1}}, use:
*:: <span style="color:#900"><code><nowiki>{{minor planet|S|2003|11264|1}}</nowiki></code></span>

==[[Template:minor planet link]]==
{{template shortcut|mpl}}
To create a wikilink in the same way, use [[Template:minor planet link]]. It obeys exactly the same input syntax as described above, but instead outputs wikilinks to the appropriate namespace.

For example, to create a wikilink to {{minor planet link|2009 YE|7}}, use:
::: <span style="color:#900"><code><nowiki>{{minor planet link|2009 YE|7}}</nowiki></code></span>
Or, to create a wikilink to {{minor planet link|15760|1992 QB|1}}, use:
::: <span style="color:#900"><code><nowiki>{{minor planet link|15760|1992 QB|1}}</nowiki></code></span>
Note, as with ''Template:minor planet'', that a similar output as the above can also be obtained by placing both the catalogue number (in parentheses) and the provisional designation in a single field. To use the above example again, {{minor planet link|(15760) 1992 QB|1}} can also be created by using:
::: <span style="color:#900"><code><nowiki>{{minor planet link|(15760) 1992 QB|1}}</nowiki></code></span>
Finally, to create a wikilink to {{minor planet link|S|2000|1998 WW|31|1}}, use:
::: <span style="color:#900"><code><nowiki>{{minor planet link|S|2000|1998 WW|31|1}}</nowiki></code></span>

==[[Template:minor planet link abridged]]==
{{template shortcut|mpl-}}
Sometimes, you may wish to create a wikilink to a minor planet with a permanent catalogue number while abridging the catalogue number from in-line display. For this purpose use [[Template:minor planet link abridged]]
::: <span style="color:#009"><code><nowiki>{{minor planet link abridged|<catalogue number>|<provisional designation's leading numbers and letters>|<subscript number, if applicable>}}</nowiki></code></span>
To create a wikilink to {{mp|15760|1992 QB|1}} without showing the "(15760)" part (like so: {{minor planet link abridged|15760|1992 QB|1}}), use:
::: <span style="color:#900"><code><nowiki>{{minor planet link abridged|15760|1992 QB|1}}</nowiki></code></span>

==[[Template:minor planet moon link]]==
{{template shortcut|mpm}}
To create a wikilink to a minor planet's moon (where the minor planet is known by a provisional designation), use the following pseudocode:
::: <span style="color:#009"><code><nowiki>{{minor planet moon link|<leading numbers and letters>|<subscript number>|<trailing letters and numbers>}}</nowiki></code></span>
For example, to create {{minor planet moon link|S/2000 (1998 WW|31|) 1}}, use:
::: <span style="color:#900"><code><nowiki>{{minor planet moon link|S/2000 (1998 WW|31|) 1}}</nowiki></code></span>

==[[Template:minor planet moon link abridged]]==
{{template shortcut|mpm-}}
To format the name of a minor planet's moon (where the minor planet is known by a provisional designation), use the following pseudocode:
::: <span style="color:#009"><code><nowiki>{{minor planet moon link abridged|<leading numbers and letters>|<subscript number>|<trailing letters and numbers>}}</nowiki></code></span>
For example, to create {{minor planet moon link abridged|S/2000 (1998 WW|31|) 1}}, use:
::: <span style="color:#900"><code><nowiki>{{minor planet moon link abridged|S/2000 (1998 WW|31|) 1}}</nowiki></code></span>

=See also=
{{Minor planet templates/See also}}

<includeonly>{{Sandbox other||
[[Category:Minor planet formatting and function templates]]

}}</includeonly>