Template:CelestialRefAll

From blackwiki
Revision as of 08:32, 24 July 2013 by imported>Robertinventor
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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 Template:T which calls Template:T.

If you want more configuration options useTemplate:T which is called by Template:T

If you just want to add a SIMBAD footnote, without these extra options, you can use: Template:T.

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: <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [1]<-- --><-- ends test of 2 not set -->, <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [2]<-- --><-- ends test of 2 not set -->, <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [3]<-- --><-- ends test of 2 not set -->.

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: <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set Andromeda Galaxy [4]<-- --><-- ends test of 2 not set -->

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

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

yields: <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set Andromeda Galaxy [5]<-- --><-- ends test of 2 not set -->

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: <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [6]<-- --><-- ends test of 2 not set -->

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:
<--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [7]<-- --><-- ends test of 2 not set -->

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:
<--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [8]<-- --><-- ends test of 2 not set -->

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

Test <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [9]<-- --><-- ends test of 2 not set -->

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: <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set Andromeda Galaxy [10]<-- --><-- ends test of 2 not set -->

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

yields: <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [11]<-- --><-- ends test of 2 not set -->

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 <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [12]<-- --><-- ends test of 2 not set --> to plot stars within 5 arcmins of HD 189733b

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

yields <--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [13]<-- --><-- ends test of 2 not set --> to plot stars within 50 arcsecs of Alpha Centauri

Siblings

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

<--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [14]<-- --><-- ends test of 2 not set -->

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

<--

  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [15]<-- --><-- ends test of 2 not set -->

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?
<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [16]<-- --><-- ends test of 2 not set -->||2.03||0.813||K7||1.0||4400d

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [17]<-- --><-- ends test of 2 not set -->||7.25||2.88||K3||—||4619

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [18]<-- --><-- ends test of 2 not set -->||0.41e||32.0||K4||1.11||4640

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [19]<-- --><-- ends test of 2 not set -->||0.53e||431.7||-||-||-

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [20]<-- --><-- ends test of 2 not set -->||0.0.86||7.92||K5||0.92||4650h

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [21]<-- --><-- ends test of 2 not set -->||0.27e||263.3||K9f||-||-

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [22]<-- --><-- ends test of 2 not set -->||0.71e||1657||-||-||-

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [23]<-- --><-- ends test of 2 not set -->||5.12e||655.6||K4||1.14||4714

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [24]<-- --><-- ends test of 2 not set -->||3.06||3.09||K5||—||-

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [25]<-- --><-- ends test of 2 not set -->||0.33||237.6||K3||1.07||4746

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [26]<-- --><-- ends test of 2 not set -->||1.99||380.85||K3/4||1.04||4795

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [27]<-- --><-- ends test of 2 not set -->||0.38e||2.82||K4||1.06||4840

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [28]<-- --><-- ends test of 2 not set -->||1.09||1.42||N/A||1.06||4861

<--
  • For footnotes if you want all the extra features
  • sets all=yes and calls Template:T, and
  • passes plot and siblings.
  • leaves out the other options so simpler documentation

-->2 set [29]<-- --><-- ends test of 2 not set -->||1.44e||345.6||K5||1.08||4962

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

See also

References

Template:Uncat