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

From blackwiki
Jump to navigation Jump to search
imported>PhilipTerryGraham
(→‎Syntax: Added spaces on "cat_year" and "cat_no" parameters)
imported>PhilipTerryGraham
(→‎Parameters: Clarified new use for the "date" parameter, where only date of greatest eclipse matters)
Line 51: Line 51:
 
|-
 
|-
 
| <code>date</code>
 
| <code>date</code>
| This parameter is used to display the date of the eclipse in [[Coordinated Universal Time]] (UTC), formatted in day-month-year. If the eclipse's penumbral stages occur across two dates in UTC, input both dates with an en dash. For example, the [[May 2004 lunar eclipse]] can be displayed as 4–5 May 2004.
+
| This parameter is used to display the date of the eclipse in [[Coordinated Universal Time]] (UTC), formatted in day-month-year. If the eclipse's penumbral stages occur across two dates in UTC, input only the date in which greatest eclipse occurs. For example, the [[July 2019 lunar eclipse]] occurs over 16–17 July 2019, though greatest eclipse occurs on 21:30:45 UTC on 16 July. Therefore, "{{xtd|16 July 2019}}" should be the input for the date.
 
|-
 
|-
 
| <code>gamma</code>
 
| <code>gamma</code>

Revision as of 10:39, 7 August 2018

{{Infobox lunar eclipse}} is an {{Infobox}}-based template that acts as a summary of information for an article on a specific lunar eclipse. This infobox is designed with a subheading parameter, two image parameters, one caption parameter, sixteen cell parameters and two succession link parameters. It makes use of a collapsible list, an {{#if:}} parser function for a fixed caption, and a hCalendar microformat.

Syntax

Template:Parameter names example

{{Infobox lunar eclipse
| type       = 
| image      = 
| caption    = 
| image2     = 
| date       = 
| gamma      = 
| magnitude  = 
| saros      = 
| cat_year   = 
| cat_no     = 
| totality   = 
| partiality = 
| penumbral  = 
| p1         = 
| u1         = 
| u2         = 
| greatest   = 
| u3         = 
| u4         = 
| p4         = 
| previous   = 
| next       = 
}}

Parameters

Parameter(s) Description
type Specifies in the infobox headline what type of eclipse the event was. This parameter has three defined inputs, all of which correspond to a subheader style. The input total can be used for a total eclipse, partial for a partial eclipse, and penumbral for penumbral eclipses.
image This first image parameter displays an image thumbnail at the size of the user's preferences as specified in their settings. This parameter is intended to be used to display a photograph of the lunar eclipse, preferably in a tight square crop filled with a full disc view of the moon. This image would be an example of the kind intended to be displayed in this parameter. Omit the File: prefix when in use.
caption This image caption parameter is intended to describe the photograph used in the image parameter above it, formatted as follows: the point during the eclipse it was taken, the location on Earth it was taken from, and the time it was taken in UTC. For example, "Totality from Wollongong, New South Wales, 09:48 UTC"
image2 This second image parameter also displays a thumbnail image at the size of the user's preference. This parameter is intended to be used to display an infographic of the eclipse. This image would be an example of the kind intended to be displayed in this parameter. Omit the File: prefix when in use. When image2 is active, a caption will also be active, using the {{#if:}} parser function. It reads "Chart of the eclipse; ecliptic north is up".
date This parameter is used to display the date of the eclipse in Coordinated Universal Time (UTC), formatted in day-month-year. If the eclipse's penumbral stages occur across two dates in UTC, input only the date in which greatest eclipse occurs. For example, the July 2019 lunar eclipse occurs over 16–17 July 2019, though greatest eclipse occurs on 21:30:45 UTC on 16 July. Therefore, "16 July 2019" should be the input for the date.
gamma
magnitude
saros
cat_year, cat_no These two parameters are used to complete parts of a external link to an official chart by the Goddard Space Flight Center, with detailed information and background, for a particular eclipse. The entire string is as follows: https://eclipse.gsfc.nasa.gov/LEplot/LEplot{{{cat_year}}}/{{{cat_no}}}}.pdf. The parameter cat_year accepts an input of either 1951, for eclipses between 1951 and 2000, and 2001 for eclipses between 2001 and 2050. The parameter cat_no accepts an input of a catalog code that follows this format: LEyyyymmddn. The LE prefix is constant, and should not be changed. yyyymmdd is a date in year-month-day formatting, where the full year is written out, along with the first three letters of a month's name, and the day in two decimals. The last N variable denotes the type of eclipse. T is for a total lunar eclipse, P for a partial eclipse, and N for a penumbral eclipse. For example, the code for the July 2018 lunar eclipse would be LE2018Jul27T, linking to this page.
totality, partiality, penumbral These parameters are used to display the amount of time each phase of the eclipse lasted, intended to be formatted in worded minutes and seconds. For example, 102 minutes, 50 seconds. totality is used to display how long the totality phase of the eclipse lasted, partiality for the partiality phase, and penumbral for the penumbral phase. Omit the totality parameter completely if it is only a partial eclipse, and omit both totality and partiality if it is a penumbral eclipse.
p1, u1, u2, greatest, u3, u4, p4 These parameters that form part of the collapsed "Contacts" section of the infobox are used to detail the exact times, in Coordinated Universal Time (UTC), the various contact points of the eclipse. For example, u1 and u2 correspond to the points where the moon first enters the umbra (U1 contact) and is completely enveloped by it (U2). The greatest parameter corresponds to the point at which the moon is at its greatest eclipse.
previous, next These parameters activate succession wikilinks that help readers navigate to the previous and next lunar eclipses chronologically, regardless of eclipse type. The parameters themselves are encased in wikilinks that are completed by inputting a month and year. For example, setting either parameter to January 2018 will set the wikilink to January 2018 lunar eclipse.

Microformat

Template:UF-hcal-geo