Manual:Extension/StatusBadges: Difference between revisions

No edit summary
m (username removed) (log details removed)
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
A status badge is specially formatted text that indicates the status of a piece of information.
{{DISPLAYTITLE:Status Badges}}
{{BSVersion|bsvFrom=6|bsvFeature=StatusBadges}}
 
A status badge is specially formatted colored text that indicates the status of an information unit.


== Adding a status badge ==
== Adding a status badge ==
Status badges are available as a Content Droplet.  
Status badges are available as a [[Manual:Extension/ContentDroplets|Content Droplet]].  
 
'''To add a status badge:'''


# Place your cursor where you want the status badge to appear.
# Place your cursor where you want the status badge to appear.
# Open the Content Droplets menu [[File:VE-ContentDroplets.png|alt=Content Droplet menu item of Visual Editor|frameless|30x30px]].
# Open the Content Droplets menu<span class="inline-img">[[File:VE-ContentDroplets.png|alt=Content Droplet menu item of Visual Editor|30x30px|link=none]]</span>.
# Search for "Status badge."
# Search for "Status Badge".
# Insert the Content Droplet.[[File:Content Droplet StatusBadge.png|alt=Inspector for the Content Droplet|center|thumb|650x650px|Content Droplet "Status badge"]]
# Add your status message.
# Add your status message.
# Select a color.  
# Select a color.  
# Select "light badge" if you want to show a badge with a light background color (optional).
# Select "light badge" if you want to show a badge with a light background color (optional).
To quickly add another status badge, you can select the inserted status badge, copy it (Ctrl+c) and paste it somewhere else on the page. Select the duplicated badge and then  edit its text and color.
== Customizing ==
If you want to use a larger font-size in your wiki for badges, you can add the following rule to the page MediaWiki:Common.css (admin rights required):<syntaxhighlight lang="css">
/*status badge */
.status-badge {
    font-size:0.9em; /*default-size:0.75em */
}
</syntaxhighlight>
== Accessibility ==
* '''Use of color:''' Make sure to use label text for a status badge that clearly indicates the status. Do not rely on the color alone for conveying the meaning.  For example, negative numbers should have a qualifier (<code>-</code>) instead of just being formatted with a red background.  {{WCAGref|use-of-color}}
* '''Screenreaders''' will read the badge as  a combination of badge type ("Status"), color (e.g. "green") and label text via an <code>aria-label</code>: "Status: green,  complete". {{WCAGref|text-alternatives}}

Latest revision as of 09:50, 20 November 2026

PDF exclude - start
PDF exclude - end
StatusBadges is available from BlueSpice 6.


A status badge is specially formatted colored text that indicates the status of an information unit.

Adding a status badge

Status badges are available as a Content Droplet.

  1. Place your cursor where you want the status badge to appear.
  2. Open the Content Droplets menuContent Droplet menu item of Visual Editor.
  3. Search for "Status Badge".
  4. Insert the Content Droplet.
    Inspector for the Content Droplet
    Content Droplet "Status badge"
  5. Add your status message.
  6. Select a color.
  7. Select "light badge" if you want to show a badge with a light background color (optional).

To quickly add another status badge, you can select the inserted status badge, copy it (Ctrl+c) and paste it somewhere else on the page. Select the duplicated badge and then edit its text and color.

Customizing

If you want to use a larger font-size in your wiki for badges, you can add the following rule to the page MediaWiki:Common.css (admin rights required):

/*status badge */
.status-badge {
    font-size:0.9em; /*default-size:0.75em */
}

Accessibility

  • Use of color: Make sure to use label text for a status badge that clearly indicates the status. Do not rely on the color alone for conveying the meaning. For example, negative numbers should have a qualifier (-) instead of just being formatted with a red background. WCAG #use-of-color
  • Screenreaders will read the badge as a combination of badge type ("Status"), color (e.g. "green") and label text via an aria-label: "Status: green, complete". WCAG #text-alternatives



PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end