Template:CelestialRef/workpage

Template documentation[view] [edit] [history] [purge]

Documentation

{{CelestialRef/workpage}} 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: you can use: {{cite simbad}} if you just want to add the SIMBAD footnote, without these extra options.

Parameter	Example	Usage
First unnamed parameter	M 31	Name to pass to Simbad basic search
Second unnamed parameter	Andromeda Galaxy	Alternative name for internal link if absent uses first param If set blank, name is not shown.
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
ids	show	set to show to add link to ids section of SIMBAD page
bib	show	set to show to add link to pre-expanded bibliography section
siblings	show	set to show to add link to siblings search
cds	short	set to short to display as "CDS" instead of "Centre de données astronomiques de Strasbourg"
image	show	set to show to add link to aladin preview image, colour
bwimage	show	set to show to add link to aladin preview image, B&w
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.
sep	,	Separator for the extra entries. Default currently is to separate with dashes using  -  This method, using   for the white space prevents it getting stripped by the template. You can also use   for non breaking white space.
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	Adds the extra links as new line, then indented followed by Links: suitable for footnotes
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.
extrasep	. :* Links:	Adds any text you like at the start of the extras (e.g. footnote content) The example shown here is what is used for radio=yes

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.

Techy note: uses {{CelestialRef/workpage/Extras}} for the contents of the footnote (shown inline for inline=yes )

Examples

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

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

Displayed as: M 31 , Crab Nebula , HD 189733b .

This shows all the features in use: Example: {{CelestialRef/workpage| Crab Nebula | cds=short | ids=show | bib=show | plot=10 |units=arcsec | image=show | bwimage=show }}

yields Crab Nebula 

Same example with commas instead of dashes : {{CelestialRef/workpage| Crab Nebula | sep=, |cds=short | ids=show | bib=show | plot=10 |units=arcsec | image=show | bwimage=show }}

yields Crab Nebula 

That might be useful in an article for a single celestial object, for instance, to add all those links in a footnote for the object which is the subject of the article.

See HD 133600 for a try out of that approach

Inline

Showing all the options, as inline instead of ref:
{{CelestialRef/workpage| Crab Nebula | cds=short | ids=show | bib=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}

yields:
Crab Nebula: " Crab Nebula " , SIMBAD, CDS - Ids - Bibliography - Star plot - Image - B&W Image.

{{CelestialRef/workpage| Crab Nebula | radio=yes | ids=show | bib=show | plot=10 |units=arcsec | image=show | bwimage=show | inline=yes }}

yields:
Crab Nebula: " Crab Nebula " , SIMBAD, Centre de données astronomiques de Strasbourg.

• Links: - Ids - Bibliography - Star plot - Image - B&W Image.

Format for external links section

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

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

yields:

• " Crab Nebula " at the SIMBAD Astronomical Database.

• Links: - Ids - Bibliography - Star plot - Image - B&W Image.

Once the details are all sorted out, this could be made into an easier to use external links template which calls this one with suitable defaults e.g. {{CelestialRefEx}}

It would be preset to | radio=yes | at=yes | all=show probably, then user can override e.g. set extras like siblings, or if they want it minimal can do all=no and say what they want included individually. Or some such, details to be thought through later.

Extras as radio or new line in footnote

You can also use the radio in a footnote like this:

E.g. {{ CelestialRef | Crab Pulsar | ids=show | bib=show | plot= 50 | units=arcsec | image=show | bwimage=show | radio=yes }}

Crab Pulsar 

Or just put the links into a new line in the footnote indented as: {{CelestialRef/workpage| Crab Pulsar | ids=show | bib=show | plot= 50 | units=arcsec | image=show | bwimage=show | newline=yes }}

Crab Pulsar 

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:

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

Crab Pulsar 

Using a different name for the internal link

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

{{CelestialRef/workpage| M 31 |Andromeda Galaxy }}

yields: Andromeda Galaxy 

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

{{CelestialRef/workpage| M 42 | }}
Yields:

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

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

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

Test

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

yields: Andromeda Galaxy 

{{CelestialRef/workpage| M 31 | link=no}}

yields: M 31 

Siblings

You can add a link for siblings e.g. {{CelestialRef/workpage| GL 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 super cluster.

Gliese 146 

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

yields HD 189733b  to plot stars within 5 arcmins of HD 189733b

Example: {{CelestialRef/workpage| Alpha Centauri | plot = 50 | units = arcsec }}

yields Alpha Centauri  to plot stars within 50 arcsecs of Alpha Centauri

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: {{CelestialRef/workpage| bib=show | WASP-80b }}

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

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

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

Planet	Mass (MJ)	Period (d)	SpT	B - V	Te?
WASP-43b	2.03	0.813	K7	1.0	4400d
HAT-P-20b	7.25	2.88	K3	—	4619
GJ 439 c	0.41e	32.0	K4	1.11	4640
GJ 439 d	0.53e	431.7	-	-	-
WASP-59b	0.0.86	7.92	K5	0.92	4650h
HD 113538b	0.27e	263.3	K9f	-	-
HD 113538c	0.71e	1657	-	-	-
BD-17 63b	5.12e	655.6	K4	1.14	4714
WASP-10b	3.06	3.09	K5	—	-
BD-08 2823b	0.33	237.6	K3	1.07	4746
HD 20868b	1.99	380.85	K3/4	1.04	4795
HD 63454b	0.38e	2.82	K4	1.06	4840
Qatar 1b	1.09	1.42	N/A	1.06	4861
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.

Example: {{CelestialRef/workpage| Barnard's star }}

yields Barnard's star 

Example: {{CelestialRef/workpage| Barnard's star |link=no}}

yields Barnard's star 

Example: {{CelestialRef/workpage| Barnard's star | }} for ref only

yields

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

yields Andromeda Galaxy 

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

yields Andromeda Galaxy 

Final example shows all the features in one ref

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

yields Crab Nebula 

References

See also

The above documentation is transcluded from Template:CelestialRef/workpage/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.