This is a documentation subpage for Template:Orbitbox planet begin. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
editThis template is part of a group of templates that are used to display information about the orbital characteristics of an extrasolar planetary system. The list should always have {{OrbitboxPlanet begin}} as the first in the list, while the list should have {{Orbitbox end}} as the last in the list. This particular template can be used as follows:
{{OrbitboxPlanet begin}}
However, this template is manually set to name the title after the article's name. This can be overridden by using the syntax as followed:
{{OrbitboxPlanet begin
| name = <!--Name of star (only use if article title differs from planet host star name)-->
| table_ref = <!--Reference for values in table (optional)-->
| period_unit = <!--Unit for orbital period, defaults to "day" (should be singular form)-->
}}
The following templates are used together and (excluding the beginning and end) can be used multiple times in the same list as listed below.
- {{Orbitbox planet begin}}
- {{Orbitbox planet}} (only for extrasolar planets and unsure objects [not brown dwarfs]).
- {{Orbitbox planet hypothetical}} (only for hypothetical planets)
- {{Orbitbox planet disk}} (only for circumstellar discs)
- {{Orbitbox end}}
See also
edit- {{OrbitboxPlanet short}}
- {{Starboxes}}