Lua scripting

Wikimedia Foundation projects Lua scripting Support for Lua as a scripting language for MediaWiki end-users Group: Platform Start: 2011-08 Lead: Tim Starling

We're working to support Lua as a scripting language for MediaWiki end users, including Wikipedia editors. You can try out the prototype now at http://scribunto.wmflabs.org/ , and we don't yet have a schedule for enabling it on any wikis other than mediawiki.org and test2.wikipedia.org. It will be early 2013 by the time of rollout to most WMF sites.

We plan to let Lua incubate on mediawiki.org while we test the performance characteristics with key templates, and work out a deployment plan for larger wikis that includes community involvement. The Scribunto extension has been deployed to test2.wikipedia.org and www.mediawiki.org, and several editors are porting existing templates such as Cite over to Lua (see recent changes in the "Module:" namespace and the tutorial).

Status

• Template:Wikimedia project status line

Rationale

Templates and ParserFunctions were introduced to allow end users of MediaWiki to replicate content easily and build tools using basic logic, effectively turning wikitext into a limited programming language.

However, complex templates have caused performance issues and bottlenecks.

This project aims to make it possible for MediaWiki end-users to use a proper scripting language that will be more powerful and efficient than ad-hoc ParserFunctions-based logic.

See also Scripting, Extension:Scribunto.

The example of Lua's use in World of Warcraft is promising; even novices with no programming experience were able to make large changes to their graphical experiences by quickly learning some Lua.

<marktraceur> hashar, sumanah, also Minetest (http://minetest.net) has recently implemented a similar system, though it mods the server more than the client, from what I've seen it's driving people to learn Lua so they can add in their ideas, something not possible with C++

<hashar> sumanah: the secret of WoW is that they managed to expose an API which is very easy to understand

<YuviPanda> hashar: heard of Celestia? It's a planaterium software of sorts. Uses Lua for scripting. When I was in 9th grade, me and (also!) everyone around were able to learn and use it without much of a problem at all.

Roadmap

There is no timetable, at present, for deployment of Scribunto to specific wikis. From the Platform Engineering part of the Roadmap and the site performance part of the yearly goals, here are upcoming milestones:

Milestones by quarter

July-September 2012	Experimental, limited deployment of Lua to the production cluster.
October-December 2012	Ramping up Lua to play gradually larger role on site, supporting common templates with poor performance characteristics Page rendering performance tools to help assess impact of Lua
January-March 2013	Full deployment of Lua to the production cluster (contingent upon October assessment)

Documents

• Extension:Scribunto - MediaWiki extension page for this tool
• Extension:Scribunto/Lua reference manual - Documentation for Lua as available in MediaWiki.
• User requirements: notes
• Status updates
• Tutorial on using Lua for MediaWiki templates
• Planning documents:
  • /Meeting_2012-01-25
  • Extension:Scribunto/Brainstorming
  • Extension:Scribunto/Deployment priorities
• Software design document: Explanation of why Tim's preferred language is Lua
• /Benchmarking
• Release management plan: Lua scripting/Release management
• Extension:Scribunto/We_use_Lua a reciprocation page between Lua developers.

LUA modules on this wiki

• List of all modules on this wiki testing mw:Lua scripting

Communications

• Agreement on Lua
• Patrick Reilly spoke about the Lua scripting work in a presentation on 3 May 2012 (scroll to about 22:00 or 27:00 to see it)
• Tutorial session, Berlin, June 2012