Extension:Dashiki

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
Dashiki
Release status: stable
Implementation ContentHandler
Description Display and editing of dashboard configuration
Author(s) Milimetric (WMF)talk
Latest version 0.1 (2016-12-08)
MediaWiki 1.25+
PHP 5.4+
Database changes No
License GNU General Public License 2.0 or later
Download
Translate the Dashiki extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The Dashiki extension simply renders the JSON used to configure dashiki dashboards in a friendly html table. In the future, the Dashiki extension might be updated with better editors and schema validation, but for now it's simply here to render and provide a little context to Dashiki configurations on meta.wikimedia.org.

Features[edit]

  • Dashiki renders Config:Dashiki: pages in a nice format with contextual help.

Download[edit]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/Dashiki/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

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

Requirements[edit]

Dashiki requires Extension:JsonConfig to be installed to work.


Examples[edit]

Pages such us https://meta.wikimedia.org/wiki/Config:Dashiki:Sample/metrics-by-project are handled by this extension

Installation[edit]

  • Download and place the file(s) in a directory called Dashiki in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'Dashiki' );
    $wgJsonConfigs['JsonConfig.Dashiki'] = array(
      'pattern' => '/^Dashiki\:./',
      'isLocal' => true,
    );
    $wgJsonConfigModels['JsonConfig.Dashiki'] = array(
        'class' => null,
        'view'  => 'Dashiki\DashikiView',
    );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.29 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.29 and earlier), instead of wfLoadExtension( 'Dashiki' );, you need to use:

require_once "$IP/extensions/Dashiki/Dashiki.php";


Documentation[edit]

This extension enhances the jsonconfig extension abilities when it comes to configuration in a specific namespace, to test locally with vagrant create a document like: http://localhost:8080/wiki/Config:Dashiki:Annotations/Wikistats/totalPageViews

Document should contain data json-formatted similar to: https://meta.wikimedia.org/w/index.php?title=Config:Dashiki:Annotations/Wikistats/totalPageViews

To see usages off this files you can take a look at the below documentation: Full Docs for Dashiki and how to create and configure a dashboard

the extension just provides the capabilities of rendering the json configuration, nothing else.