Template:Starbox new/doc

Usage

This template is used to display information about a specific star.

Starbox new is a revamped version of the classic {{Starbox}} family of templates. The most obvious benefit of Starbox new is that only one template is required to make the infobox work. Starbox new also has a few new features compared to classic Starbox, including:

• A new section for basic details on a star's planetary system
• Subboxes that allow for data on additional stars in a multiple star system
• Auto-wiki-linking of star types, variable types, and constellations
• Auto-categorizing based on spectral class and number of confirmed exoplanets (can be disabled)
• Easier image format
• Additional common parameters and units

Full list of added and changed features

• The template now uses the infobox image Lua module, which means that images can be added to the infobox without having to specify the size or File: prefix
• Constellations are automatically wikilinked—both names and abbreviations can be used. (See full list of possible parameters below)
• Star type (evolutionary stage) is automatically wikilinked. Types not recognized by the template will be displayed as-written. (See full list of possible parameters below)
• Common photometric bands for the apparent magnitude section now have their own parameters and are wikilinked, so there is no need to add each of the passbands. However, 9 additional, user-specified passbands can also be entered, as in the classic Starbox. The photometric passbands supported by the template are: U, B, G, V, R, I, Z, Y, J, H, K, L, M, N, and Q.
• Variable type is automatically wikilinked. Types not recognized by the template will be displayed as-written. (See full list of possible parameters below)
• Radial velocity and total velocity now support user-specified unit options rather than just the default km/s
• Proper motion RA and proper motion Dec now support user-specified unit options rather than just the default mas/year
• Distance now supports a kiloparsecs option
• Orbital period now supports a days option
• The wording and display of some magnitude and luminosity labels is slightly altered
• Semi-major axis now supports astronomical units, milliarcseconds, kilometers, parsecs, and light years as units.
• Habitable zone inner radius and habitable zone outer radius now default to astronomical units, with an option to specify a different unit type
• Surface gravity now supports multiples of Earth gravity (gs) and m/s² as units, and also adds an option for a user-defined unit
• Rotation is re-labelled as "Rotation period"
• A "Rotation rate" parameter is added
• A user-specified unit option for rotational velocity is added
• A user-specified unit option for star age is added
• Relpos now automatically pulls the epoch from the observation section if no separate epoch is specified
• A user-specified unit option for projected separation is added
• An exoplanet section is added, which allows parent stars to be defined and subboxes to be added for each planet. The following parameters can be defined for each planet:
  • type (up to 2, full list of possible parameters below)
  • mass (in Jupiter masses, Earth masses, or user-specified units)
  • radius (in Jupiter radii, Earth radii, or user-specified units)
  • orbital radius (defaults to astronomical units, user-specified units are also available)
  • orbital period (in Earth days or Earth years; the template will automatically convert between the two and display both.) Alternatively, user-specified units may be provided.
• In the reference section, up to 3 custom databases may be provided, as well as 3 data links per custom database
• Up to 9 sources can now be added to the sources section, rather than just 4 with classic Starbox
• The template automatically adds categories for number of confirmed planets and spectral type if those categories exist (can be disabled).
• Up to 9 subboxes may be added each for the sections on observation, character, astrometry, orbit, detail, and relative position. These are added for additional stars within a star system (or, in the case of the orbit parameter, this may also involve nested binaries)

Known issues and lacking features

• Error bounds for distance are not currently supported
• There is currently no option to disable automatic unit conversion for distance
• The kiloparsecs unit option for distance does not have an option for automatic unit conversion to light years
• The radius parameter does not yet natively support kilometers as a unit, although they can be entered manually
• There is currently no option to convert from parallax to distance
• No unit options are currently given for rotation period or rotation rate
• The template does not currently have the option to auto-convert between rotation period and rotation rate
• Relpos can only be specified relative to a single star, even when there are multiple components added via subboxes
• The Planetary System header does not show when a number of planets or confirmed planets is not entered, even when planet subboxes or parent star names are entered
• Mass and radius of an exoplanet do not currently support solar units
• There is currently no option to disable automatic unit conversion for orbital period of an exoplanet
• Spectral types given in subboxes do not currently auto-categorize
• The spectral type categorization is currently broken due to a copy-paste error
• The template currently does not have options to automatically add categories based on variable type or constellation (these would be opt-in rather than opt-out)
• Some of the parameter names are inconsistent
• The astrometry subbox is currently not working
• The details subbox is currently not working
• The relpos subbox is currently not working