Difference between revisions of "Template:Outage"

(Add detail line.)
 
(6 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
   |services=''affected services''
 
   |services=''affected services''
 
   |summary=''summary of the problem''}}
 
   |summary=''summary of the problem''}}
 +
 +
There is a <code>type</code> parameter, which gives the type of outage.  It defaults to "Issue".
 +
 +
<nowiki>{{</nowiki>outage
 +
  |type=Planned outage
 +
  |time=''date and time outage will starte''
 +
  |services=''affected services''
 +
  |summary=''summary of the outage''<nowiki>}}</nowiki>
 +
 +
{{outage
 +
  |type=Planned outage
 +
  |time=''date and time outage will starte''
 +
  |services=''affected services''
 +
  |summary=''summary of the outage''}}
  
 
You can include an <code>update</code> parameter, which will replace the last line of the output:
 
You can include an <code>update</code> parameter, which will replace the last line of the output:
Line 25: Line 39:
 
   |update=As of ''date/time'', the problem has been resolved.}}
 
   |update=As of ''date/time'', the problem has been resolved.}}
  
−
You can also include a <code>details</code> parameter, with multiple lines:
+
You can also include a <code>details</code> parameter.  The details may span multiple lines, but you'll need to put a <code><nowiki><br/></nowiki></code> at the end of each line:
  
 
  <nowiki>{{</nowiki>outage
 
  <nowiki>{{</nowiki>outage
Line 31: Line 45:
 
   |services=''affected services''
 
   |services=''affected services''
 
   |summary=''summary of the problem''
 
   |summary=''summary of the problem''
−
   |details=''Extra Details 1''
+
   |details=''Extra Details 1''<nowiki><br/></nowiki>
−
 
 
  ''Extra Details 2''<nowiki>}}</nowiki>
 
  ''Extra Details 2''<nowiki>}}</nowiki>
  
Line 39: Line 52:
 
   |services=''affected services''
 
   |services=''affected services''
 
   |summary=''summary of the problem''
 
   |summary=''summary of the problem''
−
   |details=''Extra Details 1''
+
   |details=''Extra Details 1''<br/>
−
 
 
 
''Extra Details 2''}}
 
''Extra Details 2''}}
  
−
</noinclude><includeonly>==== Issue with {{{services}}} ====
+
</noinclude><includeonly>==== {{#if:{{{type|}}}|{{{type}}}|Issue}} with {{{services}}} ====
−
<span style="issue">'''WHEN''': {{{time}}}<br/>
+
<ul style="list-style-type: none; margin-left: 0">
−
'''WHAT''': {{{summary}}}{{#if:{{{details|}}}|<br/>
+
<li>'''WHEN''': {{{time}}}</li>
−
'''DETAILS''':
+
<li>'''WHAT''': {{{summary}}}</li>
−
{{{details}}}}}{{#if:{{{update|}}}|<br/>
+
{{#if:{{{update|}}}|<li><p>{{red|'''UPDATE''':}} {{{update}}}</p></li>}}
−
'''UPDATE''': {{{update}}}}}</span></includeonly>
+
{{#if:{{{details|}}}|<li><p>'''DETAILS''': {{{details}}}</p></li>}}
 +
</ul></includeonly>

Latest revision as of 14:02, 7 June 2024

This is a template for formalizing the structure of outage notifications on the Notices page.

At a minimum, use of this template should look like this: 

{{outage
  |time=date and time outage started
  |services=affected services
  |summary=summary of the problem}}

That will look like this:

Issue with affected services

  • WHEN: date and time outage started
  • WHAT: summary of the problem

There is a type parameter, which gives the type of outage. It defaults to "Issue". 

{{outage
  |type=Planned outage
  |time=date and time outage will starte
  |services=affected services
  |summary=summary of the outage}}

Planned outage with affected services

  • WHEN: date and time outage will starte
  • WHAT: summary of the outage

You can include an update parameter, which will replace the last line of the output:

{{outage … |update=As of date/time, the problem has been resolved.}} →

Issue with affected services

  • WHEN: date and time outage started
  • WHAT: summary of the problem

  • UPDATE: As of date/time, the problem has been resolved.

You can also include a details parameter. The details may span multiple lines, but you'll need to put a <br/> at the end of each line: 

{{outage
  |time=date and time outage started
  |services=affected services
  |summary=summary of the problem
  |details=Extra Details 1<br/>
Extra Details 2}}

Issue with affected services

  • WHEN: date and time outage started
  • WHAT: summary of the problem

  • DETAILS: Extra Details 1
    Extra Details 2