Template:Infobox solar eclipse/doc: Difference between revisions

Content deleted Content added
Usage: +saros
Added documentation for new parameters (see template talk for more info)
 
(34 intermediate revisions by 21 users not shown)
Line 1:
{{Documentationdocumentation subpage}}
<!-- -PLEASE ADD CATEGORIESMETADATA ANDTO INTERWIKISTHE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE --->
{{Lua|Module:Solar eclipse}}
{{intricate}}
 
{{Infobox solar eclipse
=== Usage ===
|date = {{{date}}}
<pre style="font-size:95%; overflow:auto;">
|image = {{{image}}}
{{Infobox Solar Eclipse
|caption = {{{caption}}}
| date =
|map = {{{map}}}
| image =
|map_caption = {{{map_caption}}}
| caption =
|type_ref = {{{type_ref}}}
| map =
|nature = {{{nature}}}
| map_caption =
|gamma = {{{gamma}}}
| type_ref =
|magnitude = {{{magnitude}}}
| nature =
|saros = {{{saros}}}
| gamma =
|saros_sequence = {{{saros_sequence}}}
| magnitude =
|saros_total = {{{saros_total}}}
| saros =
|max_eclipse_ref = {{{max_eclipse_ref}}}
| saros_sequence =
|duration = {{{duration}}}
| saros_total =
|___location = {{{___location}}}
| max_eclipse_ref =
|coords = {{{coords}}}
| duration =
|max_width = {{{max_width}}}
| ___location =
|times_ref = {{{times_ref}}}
| coords =
|start_partial = {{{start_partial}}}
| max_width =
|start_total = {{{start_total}}}
| times_ref =
|start_central = {{{start_central}}}
| start_partial =
|greatest_eclipse = {{{greatest_eclipse}}}
| start_total =
|end_central = {{{end_central}}}
| start_central =
|end_total = {{{end_total}}}
| greatest_eclipse =
|end_partial = {{{end_partial}}}
| end_central =
|previous = {{{previous}}}
| end_total =
|next = {{{next}}}
| end_partial =
}}
==Basic usage ==
</pre>
This template uses information from the NASA Solar Eclipse Database when invoked using the following syntax
<syntaxhighlight lang="wikitext" style="font-size:95%; overflow:auto;">
{{Infobox solar eclipse|YYYYMonDD}}
</syntaxhighlight>
Here, <code>YYYY</code> is the year, <code>Mon</code> is the three letter abbreviation for the month, and <code>DD</code> is the two digit abbreviation for the day. For example, <code>2015Mar20</code> for March 20, 2015.
 
===Images etc.. ===
where nature should be "Total", "Annular", "Hybrid" or "Partial".
A given value of <code>YYYYMonDD</code> automatically displays information from a matching date in one of the data pages at [[Special:PrefixIndex/Module:Solar eclipse/db]]. [[Module:Solar eclipse/db/200]] is for 2001–2050. Other template parameters including <code>image</code> may be ignored with no way to override the data page.
 
== Advanced usage ==
<includeonly>
<syntaxhighlight lang="wikitext" style="font-size:95%; overflow:auto;">
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
{{Infobox solar eclipse|YYYYMonDD
[[Category:Solar System templates|{{PAGENAME}}]]
|date = <!-- {{Start date|YYYY|MM|DD}} -->
[[Category:Solar eclipses|*]]
|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 =
|previous =
|next =
}}
</syntaxhighlight>
 
''nature'' should be "Total", "Annular", "Hybrid" or "Partial" (without speechmarks).
 
== Microformat ==
{{UF-hcal-geo}}
 
</includeonly>{{basepage subpage|
[[Category:Astronomy infobox templates|Solar Eclipse]]
[[Category:Solar eclipse templates]]
[[Category:Solar System templates]]
[[Category:Templates based on the Infobox Lua module]]
}}</includeonly>