View source for Template:Infobox solar storm/doc

{{Documentation subpage}}
{{Lua|Module:InfoboxImage|Module:Parameter validation}}

This template may be used for articles on notable [[space weather]] events, including [[solar storm]]s and [[geomagnetic storm]]s.

This infobox adapts the style used in {{t|Infobox weather event}}.

== Usage ==
{{Parameter names example | _template={{PAGENAMETDOC}}
| title | image | alt | caption | noaa | rotation | lat | ar-first-obs | ar-last-obs | ar-area | spot-class | mag-class | ar-sxr-flares | ar-ha-flares
| cme-speed | cme-first-obs | cme-reached-earth | cme-travel-time | cme-angle
| r-scale | r-onset | r-ended | r-impacts | r-flare
| s-scale | s-onset | s-peak-onset | s-ended | p-flux-10 | p-flux-50 | p-flux-100 | gle | s-impacts
| g-scale | g-onset | g-peak-onset | g-ended | a-index | k-index | dst | g-impacts
| solar-cycle
}}

<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox solar storm
| title             =
| image             =
| alt               =
| caption           =
| noaa              =
| rotation          =
| lat               =
| ar-first-obs      =
| ar-last-obs       =
| ar-area           =
| spot-class        =
| mag-class         =
| ar-sxr-flares     =
| ar-ha-flares      =
| cme-speed         =
| cme-first-obs     =
| cme-reached-earth =
| cme-travel-time   =
| cme-angle         =
| r-scale           =
| r-onset           =
| r-ended           =
| r-flare           =
| r-impacts         =
| s-scale           =
| s-onset           =
| s-peak-onset      =
| s-ended           =
| p-flux-10         =
| p-flux-50         =
| p-flux-100        =
| gle               =
| s-impacts         =
| g-scale           =
| g-onset           =
| g-peak-onset      =
| g-ended           =
| k-index           =
| a-index           =
| dst               =
| g-impacts         =
| solar-cycle       =
}}</syntaxhighlight>

== Parameters ==
; title : title
; image : image
; alt : alt text for image
; caption : caption for image

=== Solar active region ===
; noaa : the assigned NOAA/SWPC active region number
; rotation : the Carrington rotation number for the active region
; lat : the heliographic latitude of the active region
; ar-first-obs : the date on which the active region was first observed
; ar-last-obs : the date on which the active region was last observed
; ar-area : the area of the active region
; spot-class : the McIntosh sunspot group class of the active region
; mag-class : the Mount Wilson magnetic classification of the active region
; ar-sxr-flares : a list of the largest soft-X-ray flares produced by the active region
; ar-ha-flares : a list of the largest H-alpha flares produced by the active region

=== Coronal mass ejection ===
; cme-speed : the recorded speed of the coronal mass ejection
; cme-first-obs : the time and date on which the coronal mass ejection was first observed
; cme-reached-earth : the time and date on which the coronal mass ejection was observed at Earth
; cme-travel-time : the time it took for the coronal mass ejection to reach Earth
; cme-angle : the angular width of the coronal mass ejection in coronagraph observations

=== Radio blackout ===
; r-scale : the peak R-scale of the radio blackout
; r-onset : the time and date on which the radio blackout started
; r-ended : the time and date on which the radio blackout ended
; r-flare : the soft-X-ray flare associated with the radio blackout
; r-impacts : impacts of the radio blackout

=== Radiation storm ===
; s-scale : the peak S-scale of the radiation storm
; s-onset : the time and date on which the radiation storm started
; s-peak-onset : the time and date on which the radiation storm reached its peak S-scale value
; s-ended : the time and date on which the radiation storm ended
; p-flux-10 : the peak flux of &geq; 10 MeV protons in pfu
; p-flux-50 : the peak flux of &geq; 50 MeV protons in pfu
; p-flux-100 : the peak flux of &geq; 100 MeV protons in pfu
; gle : whether or not a ground level enhancement was observed
; s-impacts : impacts of the radiation storm

=== Geomagnetic storm ===
; g-scale : the peak G-scale of the geomagnetic storm
; g-onset : the time and date on which the geomagnetic storm started
; g-peak-onset : the time and date on which the geomagnetic storm reached its peak G-scale value
; g-ended : the time and date on which the geomagnetic storm ended
; k-index : the peak value of the planetary ''K''-index
; a-index : the peak value of the planetary ''A''-index
; dst : the peak value of the disturbance time index
; g-impacts : impacts of the geomagnetic storm

== Examples ==
{{{{PAGENAMETDOC}}
| title             = May 2024 solar storm
| image             = Northern Lights From Over the North Pole (NESDIS 2024-05-15 nhem-aurora-labels).png
| alt               =
| caption           = Image of aurora
| noaa              = 13664
| rotation          =
| lat               =
| ar-first-obs      =
| ar-last-obs       =
| ar-area           =
| spot-class        =
| mag-class         =
| ar-sxr-flares     = X8.7
| ar-ha-flares      =
| g-scale           = 5
| g-onset           = 10 May 2024
| g-peak-onset      =
| g-ended           = 13 May 2024
| k-index           = 9
| a-index           = 271
| dst               = −412 nT
| g-impacts         =
| solar-cycle       = 25
}}
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox solar storm
| title             = May 2024 solar storm
| image             = Northern Lights From Over the North Pole (NESDIS 2024-05-15 nhem-aurora-labels).png
| alt               =
| caption           = Image of aurora
| noaa              = 13664
| rotation          =
| lat               =
| ar-first-obs      =
| ar-last-obs       =
| ar-area           =
| spot-class        =
| mag-class         =
| ar-sxr-flares     = X8.7
| ar-ha-flares      =
| g-scale           = 5
| g-onset           = 10 May 2024
| g-peak-onset      =
| g-ended           = 13 May 2024
| k-index           = 9
| a-index           = 271
| dst               = −412 nT
| g-impacts         =
| solar-cycle       = 25
}}
}}
</syntaxhighlight>
{{clear}}

{{{{PAGENAMETDOC}}
| title             = Carrington Event
| image             = Carrington Richard sunspots 1859.jpg
| alt               =
| caption           = Drawing of the Carrington Event sunspot group
| cme-speed         =
| cme-first-obs     =
| cme-reached-earth =
| cme-travel-time   = 17.5 hr ({{abbr|est.|estimate}})
| cme-angle         =
| g-scale           =
| g-onset           = 1 September 1859
| g-peak-onset      =
| g-ended           = 2 September 1859
| k-index           =
| a-index           =
| dst               = −1200 nT (est.)
| g-impacts         = Severe damage to telegraph stations
| solar-cycle       = 10
}}
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox solar storm
| title             = Carrington Event
| image             = Carrington Richard sunspots 1859.jpg
| alt               = Drawing of the Carrington Event sunspot group
| caption           =
| cme-speed         =
| cme-first-obs     =
| cme-reached-earth =
| cme-travel-time   = 17.5 hr ({{abbr|est.|estimate}})
| cme-angle         =
| g-scale           =
| g-onset           = 1 September 1859
| g-peak-onset      =
| g-ended           = 2 September 1859
| k-index           =
| a-index           =
| dst               = −1200 nT (est.)
| g-impacts         = Severe damage to telegraph stations
| solar-cycle       = 10
}}
</syntaxhighlight>
{{clear}}

<includeonly>{{Sandbox other||
<!-- Categories below this line -->

}}</includeonly>