mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/ParserFunctions
synced 2024-11-15 11:59:54 +00:00
65e9e69202
[[Template:Convert]] on enwiki is a behemoth of a construction that just about manages to do this sort of conversion, taking {{convert|5|mi|km}} and outputting "5 miles (8 km)", etc. To port this to another wiki requires copying over three and a half thousand subtemplates. The additional load produced by including numerous copies of this template is measurable on large pages on enwiki, and it eats voraciously into the template limits.
This revision introduces {{#convert: 5 mi | km }}, outputting "8 km" or thereabouts. See http://www.mediawiki.org/wiki/User:Happy-melon/Convert for more details, or look at the examples in the parser tests.
In a very rough profile, comparing 50 calls to {{convert}} verses the same 50 calls to the wrapper template shown at the link above, the parser function implementation reduces page load time by 72%, preprocessor node count by 83%, post-expand include size by 86% and template argument size by 97%. More detailed profiling would probably reveal places where extra caching could improve performance further.
The primary reason for putting it in ParserFunctions instead of its own extension is availability: PFs are already available across the cluster, and it's accepted as an essential extension for any wiki wishing to emulate or mirror WMF content. One less separate extension installed on the cluster is one less extension which has to be matched by reusers.
It's still missing a lot of units, which I ran out of patience to copy from {{convert}}; I thought I'd get some feedback on the infrastructure first.
|
||
|---|---|---|
| Convert.php | ||
| convertTests.txt | ||
| COPYING | ||
| Expr.php | ||
| exprTests.txt | ||
| funcsParserTests.txt | ||
| ParserFunctions.i18n.magic.php | ||
| ParserFunctions.i18n.php | ||
| ParserFunctions.php | ||
| ParserFunctions_body.php | ||
| README | ||
| stringFunctionTests.txt | ||
| testExpr.php | ||
ParserFunctions v1.4.0
1. Licensing
2. How to install
3. Tests
1. Licensing
Licensed under GNU GPL. See COPYING for more license information.
2. How to install
a. Download this tarbell and extract the contents to $IP/extensions/ParserFunctions/
where $IP is your root wiki install
b. Add 'require_once( "$IP/extensions/ParserFunctions/ParserFunctions.php");' to the
end of your LocalSettings (without the single quotes)
c. Enjoy
3. Tests
ParserFunctions ships with two tests
- Parser tests. These get added to the main parser tests, see there for docs
- Expression tests. These are designed to test the math-related functions
See testExpr.php