Difference between revisions of "Template:CelestialRefExNoImages/doc"

From blackwiki
Jump to navigation Jump to search
imported>Robertinventor
(Created page with '{{Documentation subpage}} <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> {{info| '''Work in Progress''' This template is a wo...')
 
imported>Robertinventor
Line 11: Line 11:
 
==Documentation==
 
==Documentation==
  
CelestialRefExNoImages is suitable for use in External Links sections. It is the same as {{t|CelestialRefEx}} without the image links, suitable for objects which don't show up on the images such as distant pulsars.
+
CelestialRefExNoImages is suitable for use in External Links sections.
  
 
* Link to its entry in the [[SIMBAD | SIMBAD Astronomical Database]]
 
* Link to its entry in the [[SIMBAD | SIMBAD Astronomical Database]]
Line 19: Line 19:
  
 
Example:
 
Example:
* <nowiki>{{CelestialRefExNoImages | Crab Nebula }}</nowiki>
+
* <nowiki>{{CelestialRefExNoImages | Crab Pulsar }}</nowiki>
  
 
Yields:
 
Yields:
  
* {{CelestialRefExNoImages | Crab Nebula }}
+
* {{CelestialRefExNoImages | Crab Pulsar }}
 +
 
 +
It is the same as {{t|CelestialRefEx}} without the image links. It's useful for objects which don't show up on the images such as distant pulsars, or if you don't want to show the image links.
  
 
The other parameters you are most likely to use are Siblings = show and Plot = (radius in arcmins).
 
The other parameters you are most likely to use are Siblings = show and Plot = (radius in arcmins).
Line 59: Line 61:
 
So, these are all possible:  
 
So, these are all possible:  
 
* <nowiki>{{CelestialRefExNoImages | M 31}}</nowiki>
 
* <nowiki>{{CelestialRefExNoImages | M 31}}</nowiki>
* <nowiki>{{CelestialRefExNoImages | Crab Nebula}}</nowiki>
+
* <nowiki>{{CelestialRefExNoImages | Crab Pulsar}}</nowiki>
 
* <nowiki>{{CelestialRefExNoImages | HD 189733b}}</nowiki>
 
* <nowiki>{{CelestialRefExNoImages | HD 189733b}}</nowiki>
 
etc.
 
etc.
Line 66: Line 68:
  
 
* {{CelestialRefExNoImages | M 31}}
 
* {{CelestialRefExNoImages | M 31}}
* {{CelestialRefExNoImages | Crab Nebula}}
+
* {{CelestialRefExNoImages | Crab Pulsar}}
 
* {{CelestialRefExNoImages | HD 189733b}}
 
* {{CelestialRefExNoImages | HD 189733b}}
  

Revision as of 10:11, 25 July 2013

Documentation

CelestialRefExNoImages is suitable for use in External Links sections.

It follows a similar format to Template:T

Example:

  • {{CelestialRefExNoImages | Crab Pulsar }}

Yields:

It is the same as Template:T without the image links. It's useful for objects which don't show up on the images such as distant pulsars, or if you don't want to show the image links.

The other parameters you are most likely to use are Siblings = show and Plot = (radius in arcmins).

Parameter Example Usage
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
all hide set to hide to set the extra links to show individually. Default is 'show to show ids, bib, image, and bwimage (and any other options like that that may be added here in the future). Set to all=hide to add those individually
ids show set to show to add link to ids section of SIMBAD page. Shown anyway if all=show.
bib show set to show to add link to pre-expanded bibliography section. Shown anyway if all=show.
image show set to show to add link to aladin preview image, colour. Shown anyway if all=show.
bwimage show set to show to add link to aladin preview image, B&w. Shown anyway if all=show.

Note: siblings and plot are hidden by default, because many objects don't have siblings, and because the plot needs its radius set (otherwise plot may be too dense to read, or have nothing in it).

Techy note: uses Template:T

Examples

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

So, these are all possible:

  • {{CelestialRefExNoImages | M 31}}
  • {{CelestialRefExNoImages | Crab Pulsar}}
  • {{CelestialRefExNoImages | HD 189733b}}

etc.

Displayed as:

Siblings

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

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

yields

to plot stars within 5 arcmins of HD 189733b

Example:

  • {{ CelestialRefExNoImages | Alpha Centauri | plot = 50 | units = arcsec }}

yields

to plot stars within 50 arcsecs of Alpha Centauri

See also