Template:CelestialRefAll/doc

From HandWiki

Documentation

CelestialRefAll creates

  • Name or internal link to the celestial object in Wikipedia
  • Footnote with links to the SIMBAD entry
  • Extra links to other entries for the object in online databases. These are added to the footnote.
  • It shows ids, bib, image, and bwimage (and any other options like that that may be added here in the future)

It is especially useful if you have a table of celestial objects and want to add footnotes to each one.

Alternative to this template

For an external links section, use {{CelestialRefEx}} which calls {{CelestialRef/Extras}}.

If you want more configuration options use{{CelestialRef}} which is called by {{CelestialRefAll}}

If you just want to add a SIMBAD footnote, without these extra options, you can use: {{cite simbad}}.

Parameters

Parameter Example Usage
First unnamed parameter M 31 Name to pass to Simbad basic search
Second unnamed parameter (optional) Andromeda Galaxy Alternative name for internal link
if absent uses first param
If set blank, name is not shown.
Third unnamed parameter (optional) Andromeda Spiral Galaxy Display name for internal link, if different
internal Alpha Centauri useful if SIMBAD name and display name are the same, internal link different (e.g. for Alpha Centauri B, the internal link is Alpha Centauri, but you want to display as Alpha Centauri B and also use that as the name to look up in SIMBAD).
link no Set to no to show the name as plain text rather than an internal link.
plot 10 Radius of star plot (if omitted, no star plot link added)
units arcsec Measurement unit for radius for star plot, arcsec, arcmin or deg acceptable, default arcmin
siblings show set to show to add link to siblings search

Examples

Any identifier recognized by Simbad for its sim-basic will do.

So, these are all possible: {{CelestialRefAll | M 31}}, {{CelestialRefAll | Crab Nebula}}, {{CelestialRefAll | HD 189733b}} etc.

Displayed as: M 31 [1], Crab Nebula [2], HD 189733b [3].

Using a different name for the internal link

You can use a different name for the internal link and the SIMBAD lookup.

{{ CelestialRefAll | M 31 | Andromeda Galaxy }}

yields: Andromeda Galaxy [4]

You can also use a different display name for the internal link too:

{{ CelestialRefAll | M 31 | Andromeda Galaxy | Andromeda Spiral Galaxy }}

yields: Andromeda Spiral Galaxy [5]

So there,

  • M 31 = name to pass to SIMBAD
  • Andromeda Galaxy = name for internal link
  • Andromeda Spiral Galaxy = how to display the internal link,

The internal link wiki markup generated is

[[Andromeda Galaxy | Andromeda Spiral Galaxy]]

If the display name and Simbad name are identical, internal link different, you can use:
{{ CelestialRefAll | Alpha Centauri B | internal = Alpha Centauri }}

Which gives you: Alpha Centauri B [6]

Ref only

If you just want the ref without the name, use the same approach, but make the different name for the internal link blank, as in

{{ CelestialRefAll | M 42 | }}
Yields:
[7]

You can mix with other named parameters in any order, e.g.:

{{ CelestialRefAll | Epsilon Tauri | | siblings=show }} (same idea but added an extra named parameter at the end)
Yields:
[8]

Which you could then add to some text as Test {{ CelestialRefAll | M 42 | | bib=show }}

Test [9]

It doesn't matter where you put this blank field amongst the other parameters, so long as it goes after the object name.

Techy details - the template recognizes your blank field as parameter 2, the second unnamed parameter.

No internal link

If you just want the name without an internal link, add link=no as: {{ CelestialRefAll | M 31 |Andromeda Galaxy | link=no}}

yields: Andromeda Galaxy [10]

{{ CelestialRefAll | M 31 | link=no}}

yields: M 31 [11]

Star plot

The advantage of the star plot extra link is that it lets the author of the page preset the radius for the plot. For some objects this needs to be large, e.g. 20 arcmins or more. For others, that shows far too many objects and a smaller radius in arcsecs is appropriate.

Example: {{ CelestialRefAll | HD 189733b | plot = 5 }}

yields HD 189733b [12] to plot stars within 5 arcmins of HD 189733b

Example: {{ CelestialRefAll | Alpha Centauri | plot = 50 | units = arcsec }}

yields Alpha Centauri [13] to plot stars within 50 arcsecs of Alpha Centauri

Siblings

You can add a link for siblings e.g. {{ CelestialRefAll | Epsilon Tauri | siblings = show}}

Epsilon Tauri [14]

{{ CelestialRefAll | Gliese 146 | siblings = show}}

Gliese 146 [15]

This may be useful if the object is part of a larger group and this is relevant to the article citing it, in this case the Hyades cluster, and the Hyades super cluster.

Use in tables

The template can be used in tables. This was the original motivation for this template - to have an easy way to add footnotes anad add extra links to the footnotes, for every entry in a table.

Here is an example to test it.

Confirmed Giant Planets around Mid- and Late-K-type Dwarf Stars

All entries are set to add the extra Bibliography link to the refs, and with newline=no.

Example: {{ CelestialRefAll | WASP-80b }}

Planet Mass (MJ) Period (d) SpT B - V Te?
WASP-43b [16] 2.03 0.813 K7 1.0 4400d
HAT-P-20b [17] 7.25 2.88 K3 4619
GJ 439 c [18] 0.41e 32.0 K4 1.11 4640
GJ 439 d [19] 0.53e 431.7 - - -
WASP-59b [20] 0.0.86 7.92 K5 0.92 4650h
HD 113538b [21] 0.27e 263.3 K9f - -
HD 113538c [22] 0.71e 1657 - - -
BD-17 63b [23] 5.12e 655.6 K4 1.14 4714
WASP-10b [24] 3.06 3.09 K5 -
BD-08 2823b [25] 0.33 237.6 K3 1.07 4746
HD 20868b [26] 1.99 380.85 K3/4 1.04 4795
HD 63454b [27] 0.38e 2.82 K4 1.06 4840
Qatar 1b [28] 1.09 1.42 N/A 1.06 4861
CD-23 395b [29] 1.44e 345.6 K5 1.08 4962

Data from Giant Planets around Late K Dwarf Stars - Table 1

See also

References

  1. M 31 at SIMBAD - Ids - Bibliography - Image.
  2. Crab Nebula at SIMBAD - Ids - Bibliography - Image.
  3. HD 189733b at SIMBAD - Ids - Bibliography - Image.
  4. M 31 at SIMBAD - Ids - Bibliography - Image.
  5. M 31 at SIMBAD - Ids - Bibliography - Image.
  6. Alpha Centauri B at SIMBAD - Ids - Bibliography - Image.
  7. M 42 at SIMBAD - Ids - Bibliography - Image.
  8. Epsilon Tauri at SIMBAD - Ids - Bibliography - Siblings - Image.
  9. Epsilon Tauri at SIMBAD - Ids - Bibliography - Siblings - Image.
  10. M 31 at SIMBAD - Ids - Bibliography - Image.
  11. M 31 at SIMBAD - Ids - Bibliography - Image.
  12. HD 189733b at SIMBAD - Ids - Bibliography - Star plot - Image.
  13. Alpha Centauri at SIMBAD - Ids - Bibliography - Star plot - Image.
  14. Epsilon Tauri at SIMBAD - Ids - Bibliography - Siblings - Image.
  15. Gliese 146 at SIMBAD - Ids - Bibliography - Siblings - Image.
  16. WASP-43b at SIMBAD - Ids - Bibliography - Image.
  17. HAT-P-20b at SIMBAD - Ids - Bibliography - Image.
  18. GJ 439 c at SIMBAD - Ids - Bibliography - Image.
  19. GJ 439 d at SIMBAD - Ids - Bibliography - Image.
  20. WASP-59b at SIMBAD - Ids - Bibliography - Image.
  21. HD 113538b at SIMBAD - Ids - Bibliography - Image.
  22. HD 113538c at SIMBAD - Ids - Bibliography - Image.
  23. BD-17 63b at SIMBAD - Ids - Bibliography - Image.
  24. WASP-10b at SIMBAD - Ids - Bibliography - Image.
  25. BD-08 2823b at SIMBAD - Ids - Bibliography - Image.
  26. HD 20868b at SIMBAD - Ids - Bibliography - Image.
  27. HD 63454b at SIMBAD - Ids - Bibliography - Image.
  28. Qatar 1b at SIMBAD - Ids - Bibliography - Image.
  29. CD-23 395b at SIMBAD - Ids - Bibliography - Image.