Extension:Dashiki
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) |
Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
MediaWiki | 1.25+ |
PHP | 5.4+ |
Database changes | No |
License | GNU General Public License 2.0 or later |
Download | |
Quarterly downloads | 5 (Ranked 126th) |
Translate the Dashiki extension if it is available at translatewiki.net | |
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.
Requirements
editDashiki requires Extension:JsonConfig to be installed first.
Installation
edit- Download and move the extracted
Dashiki
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Dashiki - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'Dashiki' ); $wgJsonConfigs['JsonConfig.Dashiki'] = [ 'pattern' => '/^Dashiki\:./', 'isLocal' => true, ]; $wgJsonConfigModels['JsonConfig.Dashiki'] = [ 'class' => null, 'view' => 'Dashiki\DashikiView', ];
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Examples
editPages such us https://meta.wikimedia.org/wiki/Config:Dashiki:Sample/metrics-by-project are handled by this extension
Documentation
editThis 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 documentation for Dashiki and how to create and configure a dashboard on wikitech
the extension just provides the capabilities of rendering the json configuration, nothing else.
This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |