Difference between revisions of "Template:Infobox solar eclipse/doc"

From blackwiki
Jump to navigation Jump to search
Line 3: Line 3:
 
{{Lua|Module:Solar eclipse}}
 
{{Lua|Module:Solar eclipse}}
  
{{Infobox solar eclipse
+
{{Parameter names example
|date             = {{{date}}}
+
|date |image |caption |map |map_caption
|image           = {{{image}}}
+
|type_ref |nature |gamma |magnitude
|caption         = {{{caption}}}
+
|saros |saros_sequence |saros_total
|map             = {{{map}}}
+
|max_eclipse_ref |duration |location |coords |max_width
|map_caption     = {{{map_caption}}}
+
|times_ref |start_partial |start_total |start_central |greatest_eclipse |end_central |end_total |end_partial
|type_ref         = {{{type_ref}}}
 
|nature           = {{{nature}}}
 
|gamma           = {{{gamma}}}
 
|magnitude       = {{{magnitude}}}
 
|saros           = {{{saros}}}
 
|saros_sequence   = {{{saros_sequence}}}
 
|saros_total     = {{{saros_total}}}
 
|max_eclipse_ref = {{{max_eclipse_ref}}}
 
|duration         = {{{duration}}}
 
|location         = {{{location}}}
 
|coords           = {{{coords}}}
 
|max_width       = {{{max_width}}}
 
|times_ref       = {{{times_ref}}}
 
|start_partial   = {{{start_partial}}}
 
|start_total     = {{{start_total}}}
 
|start_central   = {{{start_central}}}
 
|greatest_eclipse = {{{greatest_eclipse}}}
 
|end_central     = {{{end_central}}}
 
|end_total       = {{{end_total}}}
 
|end_partial     = {{{end_partial}}}
 
 
}}
 
}}
 
==Basic usage ==
 
==Basic usage ==

Revision as of 08:59, 14 March 2016

Template:Parameter names example

Basic usage

This template uses information from the NASA Solar Eclipse Database when invoked using the following syntax

{{Infobox solar eclipse|YYYYMonDD}}

Here, YYYY is the year, Mon is the three letter abbreviation for the month, and DD is the two digit abbreviation for the day. For example, 2015Mar20 for March 20, 2015.

Advanced usage

{{Infobox solar eclipse|YYYYMonDD
|date             = <!-- {{Start date|YYYY|MM|DD}} -->
|image            = 
|caption          = 
|map              = 
|map_caption      = 
|type_ref         = 
|nature           = 
|gamma            = 
|magnitude        = 
|saros            = 
|saros_sequence   = 
|saros_total      = 
|max_eclipse_ref  = 
|duration         = 
|location         = 
|coords           = <!-- {{Coord|NNNNN|NNNNN|type:landmark|display=inline,title}} -->
|max_width        = <!-- {{Convert|NNNNN|km|abbr=on}} -->
|times_ref        = 
|start_partial    = 
|start_total      = 
|start_central    = 
|greatest_eclipse = 
|end_central      = 
|end_total        = 
|end_partial      = 
}}

nature should be "Total", "Annular", "Hybrid" or "Partial" (without speechmarks).

Microformat

Template:UF-hcal-geo