View source for Template:CelestialRef/doc

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

CelestialRef creates an internal link to the object in wikipedia with attached footnote linking to its SIMBAD entry - that in turn gives observational details, often a photograph, and bibliography of articles referring to the object.

It creates

* Name or internal link to the celestial object in Wikipedia
* Footnote with links to the SIMBAD entry
* Optionally, extra links to other entries for the object in online databases. These are added to the footnote.

It is especially useful if you have a table of celestial objects and want to add footnotes to each one, and maybe add extra entries in the footnotes such as pre-expanded SIMBAD bibliography, star plot, or link to a photograph of the object, as appropriate.

===Alternative to this template===

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

If you want to add all the extra links, it may be easier to use {{tl|CelestialRefAll}} which calls {{tl|CelestialRef}} with all=yes, and has fewer options.

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

===Parameters ===

{| class="wikitable"
|-
! Parameter !! Example !! Usage
|-
| First unnamed parameter || M 31 || Name to pass to Simbad basic search
|-
| Second unnamed parameter (optional) || Andromeda Galaxy || Name to use for internal link<br>if absent uses first param<br>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.
|-
| all || show  || set to '''''show''''' to show ids, bib, image, and bwimage (and any other options like that that may be added here in the future)
siblings and plot need to be set separately if required, because many objects don't have siblings, and because the plot needs its radius set otherwise may be either too dense, or have nothing in it.
|-
| ids || show  || set to '''''show''''' to add link to ids section of SIMBAD page. Shown for '''''all=show'''''.
|-
| bib || show  || set to '''''show''''' to add link to pre-expanded bibliography section, Shown for '''''all=show'''''.
|-
| image || show  || set to '''''show''''' to add link to aladin preview image, colour, Shown for '''''all=show'''''.
|-
| bwimage || show  || set to '''''show''''' to add link to aladin preview image, B&w, Shown for '''''all=show'''''.
|-
| plot || 10 || Radius of star plot (if omitted, no star plot link added)
|-
| units || arcsec || Measurement unit for radius, '''''arcsec''''', '''''arcmin''''' or '''''deg''''' acceptable, default arcmin
|-
| siblings || show  || set to '''''show''''' to add link to siblings search
|-
| inline|| yes  || Does everything inline, not as a footnote
|-
| radio || yes || Adds the extra links as an indented radio followed by Links: suitable for use in Extra References section of a page
|-
| newline || yes || Set to '''''yes''''' to show the extra links on a new line, then indented. 
|-
|}

Note, radio overrides newline if both are set, so radio=yes | newline=no will still show the radio, which of course is on a new line

'''Convention:''' - attributes in this template are assigned "yes" or "no" if to do with formatting and "show" if to do with display of various elements. That seems to help with readability when you have many params to pass.

===Rarely used parameters===

These are mainly included for possible use in other templates that call this one. Some are used in {{tl|CelestialRefEx}}. They can be set directly as well.

{| class="wikitable"
|-
! Parameter !! Example !! Usage
|-
| images || hide || set to '''''hide''''' to hide the image links, e.g. for all=yes
|-
|-
| at || yes || shows as "at the SIMBAD Astronomical Database" similar to the JPL small bodies external links section, better for external links than the footnote style method of presentation.
|-
| simbad || long || set to '''''long''''' to display as "at the SIMBAD Astronomical Database", instead of "at SIMBAD" for use with at=yes
|-
| cds || short || set to '''''short''''' to display as "CDS" instead of "Centre de données astronomiques de Strasbourg", for use with at=no
|-
| extrasep || .<br>:* || Adds any text you like at the start of the extra links such as ids, bibliography etc. The example shown here gives same effect as radio=yes . This parameter is ignored if none of the extra links are shown. Overrides newline and radio.
|-
| sep|| ,  || Separator for the extra entries. Default currently is to separate with dashes using &amp;#32;- This method, using &amp;#32; for the white space prevents it getting stripped by the template. You can also use &amp;#160; for non breaking white space. Is followed by a space
|-
|}

'''Techy note:''' {{tl|CelestialRef}} uses {{tl|CelestialRef/Extras}} for the contents of the footnote (shown inline for inline=yes ) also uses  {{tl|CelestialRef/ExtraSep}} for the newline, radio and extrasep logic.

== Examples ==

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

So, these are all possible: <nowiki>{{CelestialRef | M 31}}, {{CelestialRef | Crab Nebula}}, {{CelestialRef | HD 189733b}}</nowiki> etc.

Displayed as: {{CelestialRef | M 31}}, {{CelestialRef | Crab Nebula}}, {{CelestialRef | HD 189733b}}.

===all=show option===

This adds ids, bib, image, and bwimage (and anything else added in future relevant for all objects) all in one go. Here it is with new line:

<nowiki>{{ CelestialRef | Crab Pulsar | all=show }}</nowiki>

{{ CelestialRef | Crab Pulsar | all=show }}

===Extras as radio in footnote===

You can use the radio in a footnote like this:

E.g. <nowiki>{{ CelestialRef | Crab Pulsar | all=show |  radio=yes }}</nowiki>

{{ CelestialRef | Crab Pulsar | all=show | radio=yes }}

===Footnote on separate line===

To put the links all on one line in the footnote, set newline=yes: <nowiki>{{ CelestialRef | Crab Pulsar | all=show |  newline=yes}}</nowiki>

{{ CelestialRef | Crab Pulsar | all=show |   newline=yes}}

The long form of "at SIMBAD" could be useful in this situation: <nowiki>{{ CelestialRef | Crab Pulsar | all=show |  newline=yes | simbad=long }}</nowiki>

{{ CelestialRef | Crab Pulsar | all=show |   newline=yes | simbad=long }}

===Using a different name for the internal link===

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

<nowiki> {{ CelestialRef | M 31 | Andromeda Galaxy }}</nowiki>

yields:  {{ CelestialRef | M 31 | Andromeda Galaxy }}

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

<nowiki> {{ CelestialRef | M 31 | Andromeda Galaxy | Andromeda Spiral Galaxy }}</nowiki>

yields:  {{ CelestialRef | M 31 | Andromeda Galaxy | Andromeda Spiral Galaxy }}

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

<nowiki>[[Andromeda Galaxy | Andromeda Spiral Galaxy]]</nowiki>

If the display name and Simbad name are identical, internal link different, you can use:<br>
<nowiki>{{ CelestialRef | Alpha Centauri B | internal = Alpha Centauri }}</nowiki>

Which gives you: {{ CelestialRef | Alpha Centauri B | internal = Alpha Centauri }}

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

<nowiki>{{ CelestialRef | M 42 | }}</nowiki><br>
Yields:<br>
{{CelestialRef | M 42 | }}

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

<nowiki>{{ CelestialRef | M 42 | | bib=show }}</nowiki> (same idea but added an extra named parameter at the end)<br>
Yields:<br>
{{CelestialRef | M 42 | | bib=show }}

Which you could then add to some text as Test <nowiki>{{ CelestialRef | M 42 | | bib=show }}</nowiki>

Test {{CelestialRef | M 42 | | bib=show }}

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:  <nowiki>{{ CelestialRef | M 31 |Andromeda Galaxy | link=no}}</nowiki>

yields:  {{ CelestialRef | M 31 |Andromeda Galaxy | link=no}}

<nowiki>{{ CelestialRef | M 31 | link=no}}</nowiki>

yields:  {{ CelestialRef | M 31 | link=no}}

===Siblings===

You can add a link for siblings e.g.  <nowiki>{{ CelestialRef | Epsilon Tauri | siblings = show}} </nowiki>

{{ CelestialRef | Epsilon Tauri | siblings = show}}

<nowiki>{{ CelestialRef | Gliese 146 | siblings = show}} </nowiki>

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

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.

===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: <nowiki>{{ CelestialRef | HD  189733b | plot = 5 }}</nowiki>

yields  {{ CelestialRef | HD  189733b | plot = 5 }} to plot stars within 5 arcmins of [[HD 189733b]]

Example: <nowiki>{{ CelestialRef | Alpha Centauri | plot = 50 | units = arcsec  }}</nowiki>

yields  {{ CelestialRef |  Alpha Centauri | plot = 50 | units = arcsec }} to plot stars within 50 arcsecs of Alpha Centauri

===Inline===

Showing as inline instead of ref, and all on one line:<br>
<nowiki>{{CelestialRef| Crab Nebula | cds=short | all=show | inline=yes |  }}</nowiki>

yields:<br>
{{CelestialRef| Crab Nebula | cds=short | all=show | inline=yes }}

Or on a new line: <nowiki>{{CelestialRef| Crab Nebula  | all=show | inline=yes | newline=yes }}</nowiki>

yields:<br>
{{CelestialRef| Crab Nebula  | all=show | inline=yes | newline=yes }}

===Format for external links section===

This follows the example of {{tl|JPL small body}}

I've made this into an easier to use external links template which calls this one with suitable defaults {{tl|CelestialRefEx}}

<nowiki>* {{CelestialRefEx | Crab Nebula | plot=10 | units=arcsec }}</nowiki>

yields:
* {{CelestialRefEx | Crab Nebula | plot=10 | units=arcsec }}

For details see {{tl|CelestialRefEx/doc}}

You can also so the same here, by setting radio=yes | at=yes  | inline=yes . I've put this in as one of the test cases at the bottom if you want to check what it's like.

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

Example: <nowiki>{{ CelestialRef | bib=show  | WASP-80b }}</nowiki>

{|class="wikitable"
|-
!Planet!!Mass (MJ)!!Period (d)!!SpT!!B - V!!Te?
|-
|{{CelestialRef|bib=show|WASP-43b}}||2.03||0.813||K7||1.0||4400d
|-
|{{CelestialRef|bib=show|HAT-P-20b}}||7.25||2.88||K3||—||4619
|-
|{{CelestialRef|bib=show|GJ 439 c}}||0.41e||32.0||K4||1.11||4640
|-
|{{CelestialRef|bib=show|GJ 439 d}}||0.53e||431.7||-||-||-
|-
||{{CelestialRef|bib=show|WASP-59b}}||0.0.86||7.92||K5||0.92||4650h
|-
|{{CelestialRef|bib=show|HD 113538b}}||0.27e||263.3||K9f||-||-
|-
|{{CelestialRef|bib=show|HD 113538c}}||0.71e||1657||-||-||-
|-
|{{CelestialRef|bib=show|BD-17 63b}}||5.12e||655.6||K4||1.14||4714
|-
|{{CelestialRef|bib=show|WASP-10b}}||3.06||3.09||K5||—||-
|-
|{{CelestialRef|bib=show|BD-08 2823b}}||0.33||237.6||K3||1.07||4746
|-
|{{CelestialRef|bib=show|HD 20868b}}||1.99||380.85||K3/4||1.04||4795
|-
|{{CelestialRef|bib=show|HD 63454b}}||0.38e||2.82||K4||1.06||4840
|-
|{{CelestialRef|bib=show|Qatar 1b}}||1.09||1.42||N/A||1.06||4861
|-
|{{CelestialRef|bib=show|CD-23 395b}}||1.44e||345.6||K5||1.08||4962
|}

Data from [https://arxiv.org/pdf/1305.3228v1.pdf Giant Planets around Late K Dwarf Stars - Table 1]

====Same table but with new lines in footnotes and all=show====

{|class="wikitable"
|-
!Planet!!Mass (MJ)!!Period (d)!!SpT!!B - V!!Te?
|-
|{{CelestialRef|bib=show|all=show|WASP-43b}}||2.03||0.813||K7||1.0||4400d
|-
|{{CelestialRef|bib=show|all=show|HAT-P-20b}}||7.25||2.88||K3||—||4619
|-
|{{CelestialRef|bib=show|all=show|GJ 439 c}}||0.41e||32.0||K4||1.11||4640
|-
|{{CelestialRef|bib=show|all=show|GJ 439 d}}||0.53e||431.7||-||-||-
|-
||{{CelestialRef|bib=show|all=show|WASP-59b}}||0.0.86||7.92||K5||0.92||4650h
|-
|{{CelestialRef|bib=show|all=show|HD 113538b}}||0.27e||263.3||K9f||-||-
|-
|{{CelestialRef|bib=show|all=show|HD 113538c}}||0.71e||1657||-||-||-
|-
|{{CelestialRef|bib=show|all=show|BD-17 63b}}||5.12e||655.6||K4||1.14||4714
|-
|{{CelestialRef|bib=show|all=show|WASP-10b}}||3.06||3.09||K5||—||-
|-
|{{CelestialRef|bib=show|all=show|BD-08 2823b}}||0.33||237.6||K3||1.07||4746
|-
|{{CelestialRef|bib=show|all=show|HD 20868b}}||1.99||380.85||K3/4||1.04||4795
|-
|{{CelestialRef|bib=show|all=show|HD 63454b}}||0.38e||2.82||K4||1.06||4840
|-
|{{CelestialRef|bib=show|all=show|Qatar 1b}}||1.09||1.42||N/A||1.06||4861
|-
|{{CelestialRef|bib=show|all=show|CD-23 395b}}||1.44e||345.6||K5||1.08||4962
|}

==Test cases==

Included mainly to check all the features are working correctly, check this after editing the code and add more test cases if nec if you add new features.

===Test of display for name===

Example: <nowiki>{{ CelestialRef | Barnard's star }}</nowiki>

yields {{ CelestialRef | Barnard's star }}

Example: <nowiki>{{ CelestialRef | Barnard's star |link=no}}</nowiki>

yields {{ CelestialRef | Barnard's star |link=no}}

Example: <nowiki>{{ CelestialRef | Barnard's star | }}</nowiki> for ref only

yields {{ CelestialRef | Barnard's star | }}

Example: <nowiki>{{ CelestialRef | M 31 | Andromeda Galaxy }}</nowiki> to display as Andromeda Galaxy but look up as M 31

yields {{ CelestialRef | M 31 | Andromeda Galaxy }}

Same example, name only, no internal link: <nowiki>{{ CelestialRef | M 31 | Andromeda Galaxy |link=no}} </nowiki>

yields {{ CelestialRef | M 31 | Andromeda Galaxy |link=no}}

Final example shows all the features in one ref

Example:  <nowiki>{{CelestialRef| Crab Nebula | cds=short | ids=show | bib=show | plot = 10 |units = arcsec | image=show | bwimage=show }}</nowiki>

yields {{CelestialRef| Crab Nebula | cds=short | ids=show | bib=show | plot = 10 |units = arcsec | image=show | bwimage=show }}

===Test that first - is omitted in list of extras ===

Tests code in {{tl|CelestialRef/Extras}} which is done individually for each case depending on which is first in the line.

There should be no leading - in the second line for any of these:

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | ids=show | bib=show | siblings=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | ids=show | bib=show | siblings=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | bib=show | siblings=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | bib=show | siblings=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | siblings=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | siblings=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes |  plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | image=show | bwimage=show | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | image=show | bwimage=show | inline=yes }}

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | bwimage=show | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | bwimage=show | inline=yes }}

===Format for extra links section===

Normally you would use {{tl|CelestialRefEx}} but is included here as a test case for the parameters called by {{tl|CelestialRefEx}}

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | simbad=long | all=show | plot=10 |units=arcsec | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | simbad=long | all=show | plot=10 |units=arcsec | inline=yes }}

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | simbad=long | all=show | images=hide | plot=10 |units=arcsec | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | simbad=long | all=show | images=hide | plot=10 |units=arcsec | inline=yes }}

If none of the extra options are set, then the new line or radio is ignored, as there would be nothing to put on the line after it:

<nowiki>* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | simbad=long | inline=yes }}</nowiki>

yields:
* {{CelestialRef| Crab Nebula | | radio=yes | at=yes | simbad=long | inline=yes }}

==SIMBAD urls documentation==

See [http://simbad.u-strasbg.fr/simbad/sim-help?Page=sim-url SIMBAD - Query by urls]/

== See also ==

* {{tl|CelestialRefEx}}
* {{tl|CelestialRefExNoImages}}
* {{tl|CelestialRefAll}}
* {{tl|CelestialRefAllNoImages}}

==References ==

{{reflist}}

<includeonly>
<!-- Categories go here, and interwikis go in Wikidata -->

</includeonly>