Help:Entity issue panel

From semantic-mediawiki.org
(Redirected from Help:Entity issue panel)
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 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 to provide more checks (or examinations) and add 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. wikipage) by being confronted with too many visual cues that need to be deciphered while viewing a page.

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

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 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