Extension:WikiLambda
WikiLambda Release status: experimental |
|
---|---|
Implementation | Parser function , ContentHandler |
Description | Providing Wikimedia wikis with a wikitext parser function to call evaluation of functions written, managed, and evaluated on a central wiki. |
Author(s) | Wikimedia Foundation |
Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
MediaWiki | >= 1.43 |
Database changes | Yes |
License | MIT License |
Download | |
|
|
|
|
Quarterly downloads | 10 (Ranked 127th) |
Translate the WikiLambda extension if it is available at translatewiki.net | |
Issues | Open tasks · Report a bug |
The WikiLambda extension provides for a wiki to host functions written, managed, and evaluated by users, which is used to power wikifunctions.org. It forms the core of the "Wikifunctions" software stack, as part of the work towards Abstract Wikipedia. The system is currently in active development, with the front-end written in Vue.js and using the new Codex interface library. Wikifunctions via WikiLambda will later provide Wikimedia wikis with a wikitext parser function to make evaluations from Wikifunctions on their local wiki.
Introduction
Wikifunctions is a MediaWiki installation on which function content, but not output, is stored. This content takes the form of programmatic descriptions of each available function ("Functions"), actual user-written code for these functions ("Implementations"), test suites for these functions ("Testers"), and human-facing documentation about these functions, alongside the usual wiki community management content like village pumps, discussion areas, and policy pages.
Requests for function calls can come in directly via a Web request, or via MediaWiki (probably through a parser function like {{#wikifunction:…}}
, but this is not yet decided). The function orchestrator determines the specifics of the request, checks the cache to see if the output value has been recently provided, and either returns that or proceeds to trigger an evaluation. To do that, it fetches all relevant content from the cluster, be that published function content (or mid-edit as-yet-unpublished function content being "previewed") from Wikifunctions, or structured content on which functions can operate from Wikidata and Wikimedia Commons. The complete bundle of code to execute and inputs on which to execute are then passed to the appropriate function executor, which then securely tries to execute the input and returns the output (or a failure error). The orchestrator then writes the successful result to the cache and transmits it to the consumer.
The WikiLambda extension is responsible for content management of the content on the Wikifunctions wiki (like the Wikibase Repository extension), providing editing interfaces, restricting users from or warning about certain actions, and providing a reading and test execution interface, and the integration of content requests on all Wikimedia wikis (like the Wikibase Client extension). User-written code is never executed in the context of the production environment, and thus never has access to sensitive content, but is only run in isolated, disposable instances.
Getting started
Install
- Download and move the extracted
WikiLambda
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone --recurse-submodules https://gerrit.wikimedia.org/r/mediawiki/extensions/WikiLambda - Only when installing from Git, run Composer to install PHP dependencies, by issuing
composer install --no-dev
in the extension directory. (See task T173141 for potential complications.) - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'WikiLambda' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Installing the back-end services
If you wish you install the back-end services to use the WikiLambda software, you must do so and configure them. Instructions are subject to change, and so only provided within the repo.
Testing locally
(TODO)
Code stewardship
- Maintained by Abstract Wikipedia team.
- Live chat (IRC): #wikipedia-abstract-tech connect
- Issue tracker: Phabricator wikilambda (Report an issue)
See also
- MediaWiki-Docker/Extension/WikiLambda
- Code documentation:
- For PHP
- For JS
- Code coverage (PHP)
- function-evaluator service
- function-orchestrator service
- functon-schemata shared library
- Abstract Wikipedia Architecture
- Abstract Wikipedia developer cheatsheet
Subpages
- API
- Approving Implementations and Testers
- Approving Implementations and Testers/de
- Approving Implementations and Testers/en
- Approving Implementations and Testers/ru
- Approving Implementations and Testers/uk
- CLI
- Coding Conventions
- Core objects
- Creating Objects
- Development environment
- Discovery needs
- Frontend Architecture
- Granular Edit Authorization
- Jupyter kernel proposal
- Metrics
- Metrics Implementation
- User stories
- de
- en
- examples/multiply.json
- pl
- uk
- wikilambda zlanguages table
- wikilambda zobject function join table
- wikilambda zobject join table
- wikilambda zobject label conflicts table
- wikilambda zobject labels table
- wikilambda ztester results table
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. |