View source for Template:Infobox star/doc

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

{{tl|Infobox star}} is an {{tl|Infobox}}-based template designed to present a summary of important facts about a specified [[star]]. It is intended to be used at the top of an article about a star, but may also be used in a section about a star in an article about a broader or loosely related topic, if appropriate. Designed as a replacement for the {{tl|Starbox begin}} series, it features an integrated star map and interchangeable sections that can be activated by simple cell parameters, with support for a summary of double and triple [[star system]]s. It is an intricate template that is made up of inputs for 25 parameters, with up to 24 additional parameters for expansion when summarising information about a two or three-star system. A <code><nowiki><div></nowiki></code> phrase is used to create the [[Wikipedia:Manual of Style/Images#Size|frameless]] location map that appears as the default lead image, and 37 [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code> parser functions]] are used for the template's interchangeable sections.

== Syntax ==
{{Stack|{{Infobox star
| name           = Alpha Centauri
| image          = Alpha, Beta and Proxima Centauri (1).jpg
| caption        = {{longitem|α Centauri AB is the bright star to the left, with Proxima Centauri circled in red. The bright star to the right is [[β Centauri]] | style=font-size: 1em; padding: 4px 0;}}<!-- Please do not change. The two bright stars are Alpha and Beta, not just A and B. -->
| constellation  = Centaurus
| ascension      = {{RA|14|39|36.49400}}
| declination    = {{DEC|–60|50|02.3737}}
| distance       = 4.37 [[light year]]s
| epoch          = [[J2000.0]]

| proper name    = Rigil Kentaurus
| magnitude      = +0.01
| spectral       = G2V
| age            = ≈4.4 billion years
| mass           = 1.100 [[Solar mass|solar masses]]
| radius         = {{Val|1.2234|0.0053}} [[Solar radius|solar radii]]
| rotation       = {{Val|22|5.9}} days

| proper name b  = Toliman
| magnitude b    = +1.33
| spectral b     = K1V
| age b          = ≈6.5 billion years
| mass b         = 0.907 solar masses
| radius b       = {{Val|0.8632|0.0037}} solar radii
| rotation b     = 36 days

| period b       = {{Val|79.91|0.011}} years
| axis b         = {{Val|17.57|0.022}}°
| eccentricity b = {{Val|0.5179|0.00076}}
| inclination b  = {{Val|79.205|0.041}}°
}}}}{{Stack|{{Infobox star
| name           = PSR B1257+12
| map x          = 46
| map y          = 16
| caption        = Location of PSR B1257+12 in Virgo (circled)
| proper name    = Lich
| constellation  = Virgo
| ascension      = {{RA|13|00|01}}
| declination    = {{DEC|+12|40|57}}
| distance       = 2,300 [[light year]]s
| epoch          = [[J2000.0]]
| age            = 1-3 billion years
| mass           = 1.100 [[Solar mass|solar masses]]
| radius         = {{Val|1.2234|0.0053}} [[Solar radius|solar radii]]
| rotation       = 6.219 milliseconds
| planets        = {{Hlist|[[PSR B1257+12 A|Draugr]]|[[PSR B1257+12 B|Poltergeist]]|[[PSR B1257+12 C|Phobetor]]}}
}}}}
{{tl|Infobox star}}'s syntax features a base of 25 parameters for an article or section describing a single star. An additional 12 parameters can be used to convert the infobox into one that describes a two-star system. It can also be expanded by another 12 parameters to convert the infobox into one that describes a three-star system. These additional parameters are shown below in the example code, separated by line breaks from the base parameters. The examples presented at right show the template as it appears when the base parameters are used for the pulsar [[PSR B1257+12]], and when the first expanded set of 12 parameters are used for the [[Alpha Centauri]] system, with [[Proxima Centauri]] excluded due to it having its own article. The syntax for this template, in its intended order and spacing, is presented below.
<pre style="width:20%;">
{{Infobox star
| name           = 
| image          = 
| caption        = 
| alt            = 
| map x          = 
| map y          = 
| map circle     = 
| proper name    = 
| constellation  = 
| galaxy         = 
| ascension      = 
| declination    = 
| distance       = 
| epoch          = 
| magnitude      = 
| spectral       = 
| age            = 
| mass           = 
| radius         = 
| rotation       = 
| planets        = 
| period         = 
| axis           = 
| eccentricity   = 
| inclination    = 

| proper name b  = 
| magnitude b    = 
| spectral b     = 
| age b          = 
| mass b         = 
| radius b       = 
| rotation b     = 
| planets b      = 
| period b       = 
| axis b         = 
| eccentricity b = 
| inclination b  = 

| proper name c  = 
| magnitude c    = 
| spectral c     = 
| age c          = 
| mass c         = 
| radius c       = 
| rotation c     = 
| planets c      = 
| period c       = 
| axis c         = 
| eccentricity c = 
| inclination c  = 
}}</pre>

== Parameters ==
=== Header and image ===
[[File:Aquarius constellation map.svg|thumb|Setting {{Para|constellation}} to <code>Aquarius</code> produces a map of the constellation [[Aquarius]] as the lead image when {{Para|image}} is not active.]]
The {{Para|name}} parameter sets the name of the template, displayed in large, bold font at its heading. {{tl|Infobox star}} features a [[Wikipedia:WikiProject Maps/Conventions/Location maps|location map]] as a default lead image if {{Para|image}} is not active. It uses an English-language map of a constellation specified in {{Para|constellation}}, created by [[User:Bronger|Torsten Bronger]]. For example, [[:File:Orion constellation map.svg|a map of Orion]] will be displayed if the parameter is set to {{Para|constellation|Orion}}. This is achieved by fixing the infobox image to <code><nowiki>File:{{{constellation|}}} constellation map.svg</nowiki></code>, taking advantage of the maps' harmonised filenames [[Commons:Commons:File renaming|under Wikimedia Commons guidelines]]. The minimalist design of these vector maps are preferred over the maps published by the [[International Astronomical Union]] as [[Wikipedia:Manual of Style/Images#Choosing images|they are hard to read at a thumbnail level]]. A <code><nowiki><div></nowiki></code> phrase is used to create the location map instead of {{tl|Location map+}}, as the template, along with its variants, do not have support for frameless thumbnails, which allow users to display thumbnail sizes according to their preferences [[Wikipedia:Manual_of_Style/Images#Size|as advised by the Manual of Style]]. The Location map templates are by default fixed to 250px width, and any attempt to set it to a frameless width will result in a Lua error. A caption for the map is also fixed and the corresponding {{Para|caption}} parameter disabled if {{Para|image}} is not active. Its syntax is written as "{{xt|Location of <nowiki>{{{name|}}} in {{{constellation|}}}</nowiki> (circled)}}". Coordinates for the location map's circle will have to be inputted as well, through {{Para|map x}} and {{Para|map y}}. The circle used for the location map, [[:File:Red circle.svg]], is set to a width of 12px as default. This can be changed through a {{Para|map circle}} parameter, where its width in pixels, excluding the "{{xt|px}}" affix, can be inputted.

When an input for {{Para|image}} is detected, the location map is disabled entirely, through the use of an [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code> parser function]]. In this instance, {{Para|image}} is used to input the filename of an image to be displayed as the lead image, excluding its "{{xt|File:}}" prefix. Per the [[Wikipedia:Manual_of_Style/Images#Size|Manual of Style's image size guidelines]], the width of the image is fixed to <code>frameless</code>, to ensure that users' preferences for thumbnail sizes are respected. Both {{Para|caption}} and {{Para|alt}} are also made active when {{Para|image}} is, with {{Para|caption}} intended to be used to input an appropriate descriptive caption for the image displayed in {{Para|image}}, and {{Para|alt}} intended to be used to input an [[Wikipedia:Manual of Style/Accessibility/Alternative text for images|alt caption]] for the same image. The use of {{tl|Longitem}} is highly encouraged if the caption is larger than a single line.

=== Parameters ===
{| class="wikitable"
! scope="col" | Cell
! scope="col" | Parameter
! scope="col" | Description
|-
! scope="row" colspan="2" | Summary
| style="background: #ecfcf4;"| A summary of the basic information about the star or star system, comprising its name, location, and distance. The "Summary" header name does not appear in the infobox at all, as its inclusion would unnecessarily take up space in the infobox; [[Wikipedia:What "Ignore all rules" means#Use common sense|it is presumed that casual readers would understand]] that this section is a basic summary even in the header's absence.
|-
! scope="row" | [[List of proper names of stars|Proper name]]
| <code>proper name</code>
| style="background: #ecfcf4;"| The proper name for the star, as defined by the [[International Astronomical Union]] and its [[IAU Working Group on Star Names|Working Group on Star Names]], if not already defined in the article title; the star's proper name might not be the article title because of [[Wikipedia:Article titles#Use commonly recognizable names|common name guidelines]]. A primary source for proper names of stars can be found at the Working Group's [https://www.iau.org/public/themes/naming_stars/ catalogue of star names]. When {{Para|proper name b}} and/or {{Para|proper name c}} is active, the position of this cell is moved down to the "Characteristics" section of the A star in the system, and described the proper name of the A star. This is achieved with multiple [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code> parser functions]]. 
|-
! scope="row" | [[Constellation]]
| <code>constellation</code>
| style="background: #ecfcf4;"| The name of the constellation in which the star is located. The input for this parameter is directly tied to a wikilink, with the related syntax being "{{xt|<nowiki>[[{{{constellation|}}} (constellation)|{{{constellation|}}}]]</nowiki>}}", so only a bare input of the constellation's name is required, with no wikilink tags. This is also important as {{Para|constellation}} also inputs the name of the constellation into the lead image and its caption when {{Para|image}} is not active, as described in the "Header and image" section above.
|-
! scope="row" | [[Galaxy]]
| <code>galaxy</code>
| style="background: #ecfcf4;"| The name of the galaxy in which the star is located, if not the [[Milky Way]].
|-
! scope="row" | [[Celestial coordinate system|Coordinates]]
| <code>ascension</code>, <code>declination</code>
| style="background: #ecfcf4;"| The [[right ascension]] and [[declination]] of a star in the night sky. The use of {{tl|RA}} and {{tl|DEC}} for each parameter is highly encouraged. The two parts of the celestial coordinate system are merged into one cell as this arrangement takes up less space in the infobox than having them as separate cells. The coordinates are separated on two lines using {{tl|Unbulleted list}}, per the [[Wikipedia:Manual of Style/Text formatting|Manual of style guidelines on text formatting]].
|-
! scope="row" | [[Cosmic distance ladder|Distance]]
| <code>distance</code>
| style="background: #ecfcf4;"| The distance of the star from the [[Earth]] and [[Sun|the Sun]]. Use the units of [[light-year]]s, [[parsec]]s, or megaparsecs in their full spelling, when appropriate. For example, it would be appropriate to write the distance of the star in parsecs if it is located beyond the Milky Way.
|-
! scope="row" | [[Epoch (astronomy)|Epoch]]
| <code>epoch</code>
| style="background: #ecfcf4;"| The epoch in which certain time-sensitive information presented in the article would be, or was, true. [[Epoch (astronomy)#Julian years and J2000|J2000]] is the most common reference point for astronomers.
|-
! scope="row" colspan="2" | Characteristics
| style="background: #ecfcf4;"| A summary of the physical characteristics of the star. This header appears when any {{Para|b}} and {{Para|c}} parameters are not active. When any of those parameters are made active, the heading is converted into a heading bearing the [[Bayer designation]] name of the star being described in the section, which would be A, B, or C. This is achieved through the use of multiple [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code> parser functions]].
|-
! scope="row" | [[Apparent magnitude|Apparent {{Mvar|m}}]]
| <code>magnitude</code>
| style="background: #ecfcf4;"| The apparent magnitude of the star as it appears from [[Earth]] in visible wavelengths. Use + and - symbols to denote a positive or negative {{Mvar|m}}. The cell label is truncated to "Apparent {{Mvar|m}}" so that the label column in the infobox is thin as possible as to allow the cell column to fit a reasonable amount of detail on a single line. <!--[[Absolute magnitude]] is not included in the infobox as it is mostly irrelevant to readers with only a casual interest in astronomy, and not necessary for readers gauging an understanding of how to observe the star with an everyday telescope. Apparent and absolute magnitudes in different wavelengths such as [[infrared]] are excluded for similar reasons. Such information can be presented in the article prose instead to ensure the infobox is [[Wikipedia:Manual_of_Style/Infoboxes#Purpose of an infobox|a summary of ''key'' facts]] that appear in an article, and not ''all'' facts.-->
|-
! scope="row" | [[Stellar classification|Spectral type]]
| <code>spectral</code>
| style="background: #ecfcf4;"| The star's spectral classification. A wikilink to the classification's proper name is highly encouraged. For example, "DA2" should wikilink to [[White dwarf]].
|-
! scope="row" | [[Stellar evolution|Age]]
| <code>age</code>
| style="background: #ecfcf4;"| The star's age in units of either millions of years or billions of years. If the star's age is greater than 1 billion years, use "{{xt|{{Mvar|n}} billion years}}", and if it is less, use "{{xt|{{Mvar|n}} million years}}"
|-
! scope="row" | [[Stellar mass|Mass]]
| <code>mass</code>
| style="background: #ecfcf4;"| The mass of the star in units of [[solar mass]]es. Be sure to wikilink the units used, as <code><nowiki>[[solar mass]]es</nowiki></code>.
|-
! scope="row" | [[Radius]]
| <code>radius</code>
| style="background: #ecfcf4;"| The radius of the star in units of [[solar radii]]. Be sure to wikilink the units used, as <code><nowiki>[[solar radii]]</nowiki></code>.
|-
! scope="row" | [[Stellar rotation|Rotation]]
| <code>rotation</code>
| style="background: #ecfcf4;"| The time it takes for a star to rotate once on its axis. Use either units of milliseconds, seconds, minutes, hours, days, or years where appropriate. For example, it would be inappropriate to write the rotation period of a pulsar as "{{xt|0.000046296 days}}" if it can be more easily written and understood as "{{xt|4 seconds}}".
|-
! scope="row" | [[Planetary system|Planets]]
| <code>planets</code>
| style="background: #ecfcf4;"| The [[List of named exoplanets|proper names of planets]] orbiting the star in order of closest to farthest periapsis, presented in a {{tl|Hlist}} format with wikilinks, if articles for the planets exist on Wikipedia. If no proper names exist, use their [[Bayer designation]] names, "a, b, c, etc."
|-
! scope="row"  colspan="2" | Orbit
| style="background: #ecfcf4;"| A summary of the main four orbital parameters of the star – time, distance, shape, and tilt. This header always appears despite any segregation of the infobox into details about separate stars, distinguishing these four cells from the "Characteristics" cells for each star.
|-
! scope="row" | [[Orbital period|Period]]
| <code>period</code>
| style="background: #ecfcf4;"| The time it takes for a star to complete one orbit around its parent star. Use either units of minutes, hours, days, months, or years where appropriate. For example, it would be inapproporiate to write the orbital period of a star as "{{xt|0.0273973 years}}" if it can be more easily written and understood as "{{xt|10 days}}".
|-
! scope="row" | [[Semi-major and semi-minor axes|{{Mvar|a}} axis]]
| <code>axis</code>
| style="background: #ecfcf4;"| The distance of the star's [[Semi-major and semi-minor axes|Semi-major axis]] from its parent star. Use [[astronomical unit]]s, with the unit written as "{{xt|AU}}" to aid in keeping the cell as short as possible. The cell's header has been truncated to "{{Mvar|a}} axis", as {{Mvar|a}} is often used to describe the semi-major axis in orbital equations. For similar reasons to the truncation of the "Apparent {{Mvar|m}}" cell header, this is to ensure that the label column in the infobox is thin as possible as to allow the cell column to fit a reasonable amount of detail on a single line.
|-
! scope="row" | [[Orbital eccentricity|Eccentricity]]
| <code>eccentricity</code>
| style="background: #ecfcf4;"| The value that determines the shape of the orbit in orbital equations. A value of 0 is a circular orbit, values between 0 and 1 form an [[elliptic orbit]], 1 is a [[parabola|parabolic]] [[escape orbit]], and greater than 1 is a [[hyperbola]].
|-
! scope="row" | [[Orbital inclination|Inclination]]
| <code>inclination</code>
| style="background: #ecfcf4;"| The tilt of a star's orbit from the [[Rotation around a fixed axis|axis of rotation]] of its parent star. This value is measured in degrees, and should be denoted with a [[degree symbol]] (°).
|}

=== Expansion cells ===
{{Infobox
| title       = Sirius
| headerstyle = font-size: 100%; background-color: #FFFFC0
| header1     = Sirius A
| label2      = [[Stellar classification|Spectral type]]
| data2       = A0mA1 Va
| header3     = Sirius B
| label4      = Spectral type
| data4       = DA2
}}

For articles or sections describing a star system, it would be appropriate to expand {{tl|Infobox star}} with a suite of parameters that add support for information on two-star and three-star systems. This is possible by simply adding a "b" or "c" to the end of parameter names under "Characteristics" and "Orbit", such as {{Para|radius b}} or {{Para|eccentricity c}}. "b" parameters help describe a secondary star in the system, while "c" parameters help describe a tertiary star in the system. Additionally, the {{Para|proper name}} parameter can be expanded with "b" and "c" names as well. When any "b" or "c" cell is active, the infobox design is rearranged from a structure describing a single star to that describing a star system. The "Characteristics" headings become title headers with the [[Bayer designation]] for the stars displayed; the "Orbit" headers remain consistent, however. When any particular "b" or "c" cell is active, [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code> parsers]] check to see if a wikilink to that cell's label already exists in the infobox. If it does, the wikilink is removed, and if there is not, a wikilink is placed onto the label. An example on the right shows how the wikilink for {{Para|spectral b}}'s label is removed if one already exists for {{Para|spectral}}'s label. This is to comply with the [[Wikipedia:Manual of Style/Linking#Overlinking|Manual of Style's guidelines on overlinking]].

== Succession ==
{{tl|Infobox star}} was designed to be a replacement for the "Starbox" series of templates that were primarily used as summary boxes prior to the standardisation of {{tl|Infobox}}es. They were used from 2005 to 2019. The series was made up of 15 separate templates, of which their purpose has now been succeeded by <nowiki>{{Infobox star}}</nowiki>. The "Starbox" series as a whole featured many more cells than <nowiki>{{Infobox star}}</nowiki>, and often went into detail that exceeded the [[Wikipedia:Manual_of_Style/Infoboxes#Purpose of an infobox|purpose of an infobox]] as a summary (and not supplant) of key facts that appear in an article. This inspired and informed the selection of <nowiki>{{Infobox star}}</nowiki>'s limited amount of parameters and cells, in order to resolve this issue. The 15 templates of the "Starbox" series are presented below.
{{col-start}}
{{col-break}}
* {{tl|Starbox begin}}
* {{tl|Starbox image}}
* {{tl|Starbox observe}}
* {{tl|Starbox observe 2s}}
* {{tl|Starbox observe 3s}}
{{col-break}}
* {{tl|Starbox character}}
* {{tl|Starbox astrometry}}
* {{tl|Starbox orbit}}
* {{tl|Starbox detail}}
* {{tl|Starbox relpos}}
{{col-break}}
* {{tl|Starbox catalog}}
* {{tl|Starbox reference}}
* {{tl|Starbox sources}}
* {{tl|Starbox end}}
* {{tl|Starbox short}}
{{col-end}}

== See also ==
* {{tl|Infobox astronomical object}}
* {{tl|Infobox comet}}
* {{tl|Infobox galaxy cluster}}
* {{tl|Infobox globular cluster}}
* {{tl|Infobox open cluster}}
* {{tl|Infobox planet}}

<includeonly>{{basepage subpage|
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Astronomy infobox templates|Star]]
}}</includeonly>