Extension:PersonalDashboard

MediaWiki extensions manual

PersonalDashboard Release status: experimental
Author(s)	Jason Sherman, WMF Growth Team
MediaWiki	1.45+
Virtual domain	virtual-dashboard
Parameters $wgPersonalDashboardDeveloperSetup $wgPersonalDashboardReviewChangesMinimumEditCount $wgPersonalDashboardSurveyLink $wgPersonalDashboardMinimumEdits $wgPersonalDashboardUserMenu $wgPersonalDashboardActiveDiscussionsPages $wgPersonalDashboardMaximumEdits $wgPersonalDashboardBlueDot $wgPersonalDashboardReviewChangesMlModel
Hooks used GetPreferences ResourceLoaderRegisterModules SkinTemplateNavigation::Universal
Licence	GNU General Public License 3.0 or later
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball README
Help	Help:Extension:PersonalDashboard
Translate the PersonalDashboard extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The PersonalDashboard extension houses code for the Moderator Tools team's experiments in building a dashboard for moderators. Read more about the project at Moderator Tools/Dashboard.

Installation

• Download and move the extracted PersonalDashboard folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PersonalDashboard
  

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'PersonalDashboard' );
  

• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

$wgPersonalDashboardDeveloperSetup

Catch fewer errors for easier troubleshooting

$wgPersonalDashboardReviewChangesMinimumEditCount

Minimum edit count required to view the review changes module

$wgPersonalDashboardSurveyLink

External link to the Personal Dashboard feedback survey.

$wgPersonalDashboardMinimumEdits

The minimum number of edits required to show the menu link. This has no effect if `$wgPersonalDashboardUserMenu = false`.

$wgPersonalDashboardUserMenu

Show a link to the Personal Dashboard in the user menu.

$wgPersonalDashboardActiveDiscussionsPages

The pages were active discussions will be extracted from

$wgPersonalDashboardMaximumEdits

The maximum number of edits required to show the menu link. This has no effect if `$wgPersonalDashboardUserMenu = false`

$wgPersonalDashboardBlueDot

Show a blue dot inviting users to try out the dashboard. This has no effect if `$wgPersonalDashboardUserMenu = false` or a user does not meet the `$wgPersonalDashboardMinimum/MaximumEdits` threshold.

$wgPersonalDashboardReviewChangesMlModel

ML model used to filter edits

Development

• Authoring a Personal Dashboard module

Glossary

Card

UX/designer term for the box(es) shown within a module.

Dialog view

A dialog representation of a module, as seen when a user clicks on a card. Compare with focused view.

Focused view

When a module is rendered as the entire page. This occurs when browsing to the module as a subpath (i.e. Special:PersonalDashboard/ReviewChanges). Compare with a dialog view, which occurs when clicking on a card.

Island module (or Vue island)

Modules that leave the body empty and let a Vue component fill it client-side. See Islands Architecture on patters.dev for more information on the concept.

Module (or PD module)

A discrete unit of content on Special:PersonalDashboard. These are either of islands, server-rendered, or progressively-enhanced. Not to be confused with ResourceLoader modules – though PD modules often have a corresponding ResourceLoader module.

Module group

A group of modules that overtake the page and provide an overall experience.

Progressively enhanced module

A module that is rendered statically by the server and enhanced by client-side scripting.

Server-static module

A module that has its body fully rendered by the server (such as with Codex PHP).

Links

• Logstash dashboard

See also

• Extension:GrowthExperiments