Help:Entity issue panel

From semantic-mediawiki.org
Figure 1: A set of issues collected within the issue panel
Figure 2: Issue panel marked as containing an error because at least one issue was marked with the error severity
Figure 3: Issue panel marked as containing exclusively warning(s)

Semantic MediaWiki 3.1.0Released on 23 September 2019 and compatible with MW 1.31.0 - 1.33.x. introduced several12 integrity checks during its release and made those results visible to users with the help of the so-called page status indicator.

The problem of providing more checks (or examinations) and adding an individual status indicator for each new check would quickly diminish the objective of helping users to identify and understand issues with an entity (aka. wiki page) by being confronted with too many visual cues that need to be deciphered while viewing a page.

Semantic MediaWiki 3.2.0 adds the issue panel to provide an instrument to collect issues (see figure 1) that occurred as part of the integrity check process and bundles them coherently only to emit a single indicator that summarizes those issues leaving the user with one reliable visual indicator that hints at a problem or issue with the displayed entity (aka. wiki page).3

Semantic MediaWiki 4.1.0Released on 21 January 2023 and compatible with MW 1.35.0 - 1.37.x. adds a user preference option to hide the indicator and disable the issue panel.4

Usage[edit]

Entity-issue-panel-running-deferred.png indicates that checks are running in the background (deferred), and results are expected to be displayed after the page rendering has finished. If the icon disappears, it means no issues were found.

Entity-issue-panel-active.png indicates that the panel is active and contains issues that are either classified as a warning (yellow, see figure 3) or error (red).

In case of a mix of instant and deferred check(s), the deferred check(s) may require additional time to update the placeholder since those checks need an extra API call to fetch relevant information from the backend before the information can be presented.

See also[edit]


References

  1. ^  Semantic MediaWiki: GitHub pull request gh:smw:3968
  2. ^  Semantic MediaWiki: GitHub pull request gh:smw:3697
  3. ^  Semantic MediaWiki: GitHub pull request gh:smw:4554
  4. ^  Semantic MediaWiki: GitHub pull request gh:smw:5345