User:Robertinventor/CelestialRef/doc

Documentation

User:Robertinventor/CelestialRef 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
sep	,	Separator for the extra entries. Default currently is to separate with dashes
inline	yes	Does everything inline, not as a footnote

Examples

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

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

Displayed as: M 31

-->, Crab Nebula

-->, HD 189733b

-->.

This shows all the features in use: Example: {{User:Robertinventor/CelestialRef| 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 : {{User:Robertinventor/CelestialRef| 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.

Using a different name for the internal link

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

{{ User:Robertinventor/CelestialRef | 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

{{ User:Robertinventor/CelestialRef | M 42 | }}
Yields:

-->

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

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

yields: Andromeda Galaxy

-->

{{ User:Robertinventor/CelestialRef | M 31 | link=no}}

yields: M 31

-->

Siblings

You can add a link for siblings e.g. {{ User:Robertinventor/CelestialRef | 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: {{ User:Robertinventor/CelestialRef | HD 189733b | plot = 5 }}

yields HD 189733b

--> to plot stars within 5 arcmins of HD 189733b

Example: {{ User:Robertinventor/CelestialRef | 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: {{ User:Robertinventor/CelestialRef | 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

Use in tables

The template can be used in tables. Here is an example to test it. Data from Giant Planets around Late K Dwarf Stars - Table 1:

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

Planet	Mass (MJ)	Period (d)	SpT	B - V	Te?
--> ||0.55|| 3.068|| K7-M0 ||0.94|| ~4000
HIP 70849b -->|| > 3 ||> 5 yr|| K7 ||1.42 ||4100c (2011)
WASP-43b -->||2.03||0.813||K7||1.0||4400d
HAT-P-20b -->||7.25||2.88||K3||—||4619
HIP 57274c -->||0.41e||32.0||K4||1.11||4640
HIP 57274d -->||0.53e||431.7||-||-||-
WASP-59b -->||0.0.86||7.92||K5||0.92||4650h
HID 113538b -->||0.27e||263.3||K9f||-||-
HID 113585c -->||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
HID 20868b -->||1.99||380.85||K3/4||1.04||4795
HID 63454b -->||0.38e||2.82||K4||1.06||4840
Qatar-1b -->||1.09||1.42||N/A||1.06||4861
HIP 5158bg -->||1.44e||345.6||K5||1.08||4962

Code Documentation

The code for the displayed name section is complex and may be difficult for future coders to update. It also needs to be done all as a single line since otherwise it breaks table formatting when including in tables.

So, here is a commented version. Sadly, there doesn't seem to be any way to include comments inside of a wikipedia template but hopefully this will make it clear how it works.

I use a c like convention here // for comments.

Everything from the /// to end of line ignored, also though, any preceding and following white space also ignored including previous and following returns

// ***Displayed object name section***
{{#ifeq:{{{2|NoName}}}|NoName// Has user entered second parameter?
// Here NoName as preset value for param 2 makes the test possible
// if it remains at preset value then they didn't enter a second parameter at all. 
// Preset value here can be anything that's not suitable for a SIMBAD id.

| // Case: no second param 

|{{#ifeq:{{{link}}}|no| // link=no?
{{{1}}} // link = no, param 1 as name only
|[[{{{1}}}]] //  link=anything else, or not set, param 1 as internal link
}}// end of link = no?

| // Case: second param
{{#ifeq:{{{2|}}}|
| // Second param is blank, e.g. {{CelestialRef|Object Name|}} 
// no name section at all just bare ref.

| // Second param entered by user, and not blank
// 
|{{#ifeq:{{{link}}}|no
|{{{2}}} // // link=no, param 2 as name only
|[[{{{2}}}]] // link=yes or not set, param 2 as internal link
}}// end of link=?
}}// end of test that param 2 is blank
}}// end of test to see if user entered param 2 at all

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: {{ User:Robertinventor/CelestialRef | Barnard's star }}

yields Barnard's star

-->

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

yields Barnard's star

-->

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

yields

-->

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

yields Andromeda Galaxy

-->

Final example shows all the features in one ref

Example: {{User:Robertinventor/CelestialRef| M 31 | cds=short | ids=show | bib=show | plot = 10 |units = arcsec | image=show | bwimage=show }}

yields M 31

-->