Template:CelestialRef/test/doc

From blackwiki
< Template:CelestialRef‎ | test
Revision as of 23:47, 20 July 2013 by imported>Robertinventor (→‎Inline)
Jump to navigation Jump to search

Documentation

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

This template relies on Template:T for the footnote content, which is alternatively shown inline for inline=yes

Examples

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

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

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

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

yields Crab Nebula [4]

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

yields Crab Nebula [5]

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.

Inline

Showing all the optoins, as inline instead of ref:

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

yields:

Using a different name for the internal link

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

{{ CelestialRef | M 31 |Andromeda Galaxy }}

yields: Andromeda Galaxy [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

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

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

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

Which you could then add to some text as Test {{ CelestialRef | 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: {{ CelestialRef | M 31 |Andromeda Galaxy | link=no}}

yields: Andromeda Galaxy [10]

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

yields: M 31 [11]

Siblings

You can add a link for siblings e.g. {{ 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 [12]

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 | HD 189733b | plot = 5 }}

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

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

yields Alpha Centauri [14] 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 | bib=show | WASP-80b }}

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

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

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 | Barnard's star }}

yields Barnard's star [29]

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

yields Barnard's star [30]

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

yields [31]

Example: {{ CelestialRefTest | M 31 | Andromeda Galaxy }} to display as Andromeda Galaxy but look up as M 31

yields Andromeda Galaxy [32]

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

yields Andromeda Galaxy [33]

Final example shows all the features in one ref

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

yields Crab Nebula [34]

References

See also