Difference between revisions of "Template:CelestialRef/test/doc"

From blackwiki
Jump to navigation Jump to search
imported>Robertinventor
imported>Robertinventor
Line 2: Line 2:
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
  
==Documentation==
+
<includeonly><!--
 +
***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
  
CelestialRefTest creates
+
-->{{#ifeq:{{{link}}}|no|<!-- link=no?
 +
-->{{strip whitespace|{{{1}}}}}<!-- link = no, param 1 as name only
 +
-->|[[{{strip whitespace|{{{1}}}}}]]<!-- link=anything else, or not set, param 1 as internal link
 +
-->}}<!-- end of link = no?
  
* 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.
+
* Case: second param
 +
-->{{#ifeq:{{strip whitespace|{{{2|}}}}}||<!-- Is it blank?
  
'''Alternative to this template''': you can use: {{t|cite simbad}} if you just want to add the SIMBAD footnote, without these extra options.
+
* Second param is blank, e.g. {{CelestialRef|Object Name|}}  
 +
* no name section at all just bare ref.
  
{| class="wikitable"
 
|-
 
! 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<br>if absent uses first param<br>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 {{t|CelestialRefTest/Extras}} for the footnote content, which is alternatively shown inline for inline=yes
+
* Second param entered by user, and not blank
 +
-->|{{#ifeq:{{{link}}}|no|<!--
 +
-->{{strip whitespace|{{{2}}}}}<!-- link=no, param 2 as name only
 +
-->|[[{{strip whitespace|{{{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
 +
 
 +
* This adds a space before the <ref> tag - but not needed
 +
* if user entered a blank value for param 2 so no preceding name
 +
-->{{#ifeq:{{{2|NoName}}}|||&#160;<!--
 +
-->{{#ifeq:{{{inline}}}|yes|{{:}} |}}<!--for inline need a :
 +
-->}}<!-- Ends test of param 2 == NoName
 +
 
 +
-->{{#ifeq:{{{inline}}}|yes|<!--
 +
-->{{CelestialRef/Extras<!--
 +
-->|{{{1}}}<!--
 +
-->|{{{2}}}<!--
 +
-->|cds={{{cds|}}}<!--
 +
-->|ids={{{ids|}}}<!--
 +
-->|bib={{{bib|}}}<!--
 +
-->|siblings={{{siblings|}}}<!--
 +
-->|plot={{{plot|}}}<!--
 +
-->|units={{{units|arcmin}}}<!--
 +
-->|image={{{image|}}}<!--
 +
-->|bwimage={{{bwimage|}}}<!--
 +
-->|sep={{{sep| - }}}<!--
 +
-->}}<!-- end CelestialRef/Extras
 +
-->|{{#tag:ref|<!--
 +
-->{{CelestialRef/Extras<!--
 +
-->|{{{1}}}<!--
 +
-->|{{{2}}}<!--
 +
-->|cds={{{cds|}}}<!--
 +
-->|ids={{{ids|}}}<!--
 +
-->|bib={{{bib|}}}<!--
 +
-->|siblings={{{siblings|}}}<!--
 +
-->|plot={{{plot|}}}<!--
 +
-->|units={{{units|arcmin}}}<!--
 +
-->|image={{{image|}}}<!--
 +
-->|bwimage={{{bwimage|}}}<!--
 +
-->|sep={{{sep| - }}}<!--
 +
-->}}<!-- end CelestialRef/Extras
 +
-->}}<!-- end #tag:ref
 +
-->}}<!-- end inline=yes?
 +
--></includeonly><noinclude>
 +
{{mbox|text=This template is currently in development. Please do not use it in articles just yet.}}
 +
{{documentation}}
 +
</noinclude>
  
 
== Examples ==
 
== Examples ==

Revision as of 00:29, 21 July 2013


Template documentation[create]


Examples

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

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

Displayed as: Template:CelestialRefTest, Template:CelestialRefTest, Template:CelestialRefTest.

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

yields Template:CelestialRefTest

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

yields Template:CelestialRefTest

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:

* {{CelestialRefTest| 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.

{{ CelestialRefTest | M 31 |Andromeda Galaxy }}

yields: Template:CelestialRefTest

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

{{ CelestialRefTest | M 42 | }}
Yields:
Template:CelestialRefTest

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

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

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

Test Template:CelestialRefTest

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

yields: Template:CelestialRefTest

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

yields: Template:CelestialRefTest

Siblings

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

Template:CelestialRefTest

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

yields Template:CelestialRefTest to plot stars within 5 arcmins of HD 189733b

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

yields Template:CelestialRefTest 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: {{ CelestialRefTest | bib=show | WASP-80b }}

Planet Mass (MJ) Period (d) SpT B - V Te?
Template:CelestialRefTest 2.03 0.813 K7 1.0 4400d
Template:CelestialRefTest 7.25 2.88 K3 4619
Template:CelestialRefTest 0.41e 32.0 K4 1.11 4640
Template:CelestialRefTest 0.53e 431.7 - - -
Template:CelestialRefTest 0.0.86 7.92 K5 0.92 4650h
Template:CelestialRefTest 0.27e 263.3 K9f - -
Template:CelestialRefTest 0.71e 1657 - - -
Template:CelestialRefTest 5.12e 655.6 K4 1.14 4714
Template:CelestialRefTest 3.06 3.09 K5 -
Template:CelestialRefTest 0.33 237.6 K3 1.07 4746
Template:CelestialRefTest 1.99 380.85 K3/4 1.04 4795
Template:CelestialRefTest 0.38e 2.82 K4 1.06 4840
Template:CelestialRefTest 1.09 1.42 N/A 1.06 4861
Template:CelestialRefTest 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: {{ CelestialRefTest | Barnard's star }}

yields Template:CelestialRefTest

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

yields Template:CelestialRefTest

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

yields Template:CelestialRefTest

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

yields Template:CelestialRefTest

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

yields Template:CelestialRefTest

Final example shows all the features in one ref

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

yields Template:CelestialRefTest

References

See also