MediaWiki

https://github.com/wikimedia/mediawiki
Admin
MediaWiki is a free, open-source, and feature-rich wiki software package written in PHP, powering...
Tokens:227,950
Snippets:1,555
Trust Score:8.3
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Run Vuex examples with npm install and npm run dev

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/vuex/README.md

Commands to set up dependencies and start the development server that serves the example applications at localhost:8080.

```bash
$ npm install
$ npm run dev # serve examples at localhost:8080
```

--------------------------------

### Install whatwg-fetch via npm

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/fetch-polyfill/README.md

Install the whatwg-fetch package using npm. This is the primary installation method.

```bash
npm install whatwg-fetch --save
```

--------------------------------

### npm install oojs

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/oojs/README.md

Installs the OOjs package via npm. This is the quick start command for adding the library to a project.

```bash
npm install oojs
```

--------------------------------

### Install dependencies and run tests

Source: https://github.com/wikimedia/mediawiki/blob/master/includes/libs/ParamValidator/README.md

Commands to install dependencies and run the test suite for the library.

```bash
composer install --prefer-dist
composer test
```

--------------------------------

### Clone and install dependencies

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/CLDRPluralRuleParser/README.md

Clone the repository and install npm dependencies.

```bash
git clone https://github.com/santhoshtr/CLDRPluralRuleParser.git
npm install
```

--------------------------------

### Install MediaWiki

Source: https://github.com/wikimedia/mediawiki/blob/master/DEVELOPERS.md

Runs the installation script inside the mediawiki container. Windows users must run this in PowerShell, not Bash.

```sh
docker compose exec mediawiki /bin/bash /docker/install.sh
```

--------------------------------

### Install as Node module

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/CLDRPluralRuleParser/README.md

Install the package as a Node module.

```bash
npm install cldrpluralruleparser
```

--------------------------------

### Install dependencies with npm

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/jquery.i18n/README.md

Installs dependencies for the project.

```shell
npm install
```

--------------------------------

### Start local web server for OOUI tests

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/ooui/README.md

Start a local PHP web server to run the OOUI test suite in your browser.

```bash
php -S localhost:80
```

--------------------------------

### Install OOUI dev dependencies

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/ooui/README.md

Install the development dependencies required for building and testing OOUI.

```bash
$ npm install
```

--------------------------------

### Install PHP dependencies with Composer

Source: https://github.com/wikimedia/mediawiki/blob/master/DEVELOPERS.md

Runs composer update inside the mediawiki container to install PHP dependencies.

```sh
docker compose exec mediawiki composer update
```

--------------------------------

### Start Docker containers

Source: https://github.com/wikimedia/mediawiki/blob/master/DEVELOPERS.md

Starts the PHP and webserver containers. Safe to run at any time; does nothing if already running. The -d flag runs services in the background; omit it to follow logs.

```sh
docker compose up -d
```

--------------------------------

### Run demo with local server

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/jquery.i18n/README.md

Starts a local server to run the demo. For Python 3, use 'python -m http.server'; for Python 2, use 'python -m SimpleHTTPServer'.

```bash
python -m http.server
# If you're using python2, use this command instead
# python -m SimpleHTTPServer  
```

--------------------------------

### Run OOUI demos

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/ooui/README.md

Start a local demo server to view the OOUI demos.

```bash
$ npm run-script demos
```

--------------------------------

### Include OOUI scripts and styles

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/ooui/README.md

Include the required jQuery, OOJS, and OOUI JavaScript files and the WikimediaUI theme stylesheet in your HTML to get started.

```html
<script src="node_modules/jquery/dist/jquery.min.js"></script>
<script src="node_modules/oojs/dist/oojs.min.js"></script>

<script src="node_modules/oojs-ui/dist/oojs-ui.min.js"></script>
<script src="node_modules/oojs-ui/dist/oojs-ui-wikimediaui.min.js"></script>
<link rel="stylesheet" href="node_modules/oojs-ui/dist/oojs-ui-wikimediaui.min.css">
```

--------------------------------

### Vue component using LanguageSelector with single selection

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/src/mediawiki.languageselector/README.md

A complete Vue single-file component example using the LanguageSelector component. It demonstrates the template with the language-selector element and the script setup that provides the required props: selected, searchApiUrl, and selectableLanguages. The is-multiple prop is set to false for single selection.

```vue
<template>
	<language-selector
		v-model:selected="selected"
		:is-multiple="false"
		:search-api-url="searchApiUrl"
		:selectable-languages="selectableLanguages"
		placeholder="Select a language"
	></language-selector>
</template>

<script>
const { ref } = require( 'vue' );
const { LanguageSelector } = require( 'mediawiki.languageselector.lookup' );

module.exports = {
	components: { LanguageSelector },
	setup() {
		return {
			selected: ref( null ),
			searchApiUrl: mw.util.wikiScript( 'api' ),
			selectableLanguages: { en: 'English', fr: 'français', de: 'Deutsch' }
		};
	}
};
</script>
```

--------------------------------

### Install and enable EventLogging extension

Source: https://github.com/wikimedia/mediawiki/blob/master/DEVELOPERS.md

Clone the extension repository or mount it as a volume in docker-compose.override.yml, then enable it in LocalSettings.php.

```sh
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/EventLogging
```

```yaml
services:
  mediawiki:
    volumes:
      - ~/Code/EventLogging:/var/www/html/w/extensions/EventLogging:cached
  mediawiki-jobrunner:
    volumes:
      - ~/Code/EventLogging:/var/www/html/w/extensions/EventLogging:cached
```

```yaml
services:
  mediawiki-web:
    volumes:
      - ~/Code/EventLogging:/var/www/html/w/extensions/EventLogging:cached
```

```php
wfLoadExtension( 'EventLogging' );
```

--------------------------------

### Message documentation example (qqq.json)

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/jquery.i18n/README.md

Shows the structure of a qqq.json file used for documenting message keys. It includes metadata about authors and descriptions for each message key.

```json
{
	"@metadata": {
		"authors": [
			"Developer Name"
		]
	},
	"appname-title": "Application name. Transliteration is recommended",
	"appname-sub-title": "Brief explanation of the application",
	"appname-header-introduction": "Text for the introduction header",
	"appname-about": "About this application text",
	"appname-footer": "Footer text"
}
```

--------------------------------

### Install IntersectionObserver polyfill via npm

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/intersection-observer/README.md

Install the polyfill using npm. This is the recommended installation method.

```sh
npm install intersection-observer
```

--------------------------------

### Install and enable Vector skin

Source: https://github.com/wikimedia/mediawiki/blob/master/DEVELOPERS.md

Clone the Vector skin repository into the skins directory and enable it in LocalSettings.php.

```sh
cd skins/
git clone https://gerrit.wikimedia.org/r/mediawiki/skins/Vector
```

```php
wfLoadSkin( 'Vector' );
```

--------------------------------

### Publish to npm

Source: https://github.com/wikimedia/mediawiki/blob/master/tests/selenium/wdio-mediawiki/CONTRIBUTING.md

Run from tests/selenium/wdio-mediawiki/ to log in and publish the package to npm.

```bash
# From tests/selenium/wdio-mediawiki/
npm login
npm publish
```

--------------------------------

### npm install pako

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/pako/README.md

Install the pako package via npm.

```shell
npm install pako
```

--------------------------------

### Install Chosen with npm

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/jquery.chosen/README.md

Install Chosen via npm. The package name is 'chosen-js'.

```bash
npm install chosen-js
```

--------------------------------

### Run Selenium tests with Fresh

Source: https://github.com/wikimedia/mediawiki/blob/master/DEVELOPERS.md

Commands to initialize the Fresh environment and execute Selenium tests.

```sh
fresh-node -env -net
npm ci
npm run selenium-test
```

--------------------------------

### Install Chosen with Bower

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/jquery.chosen/README.md

Install Chosen via Bower. The package name is 'chosen'.

```bash
bower install chosen
```

--------------------------------

### PHP usage example for creating and formatting messages

Source: https://github.com/wikimedia/mediawiki/blob/master/includes/libs/Message/README.md

Shows how to create a message using both the constructor and fluent interfaces, and how to format it using a formatter obtained from a service container. Includes imports for MessageValue, MessageParam, and ParamType. The example uses a German text formatter ('de') and demonstrates passing a plain string parameter, a nested MessageValue, and a numeric parameter.

```php
use Wikimedia\Message\MessageValue;
use Wikimedia\Message\MessageParam;
use Wikimedia\Message\ParamType;

// Constructor interface
$message = new MessageValue( 'message-key', [
    'parameter',
    new MessageValue( 'another-message' ),
    new MessageParam( ParamType::NUM, 12345 ),
] );

// Fluent interface
$message = MessageValue::new( 'message-key' )
    ->params( 'parameter', new MessageValue( 'another-message' ) )
    ->numParams( 12345 );

// Formatting
$messageFormatter = $serviceContainer->get( 'MessageFormatterFactory' )->getTextFormatter( 'de' );
$output = $messageFormatter->format( $message );
```

--------------------------------

### Install OOUI via npm

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/ooui/README.md

Install the oojs-ui package from npm to use the library in your project.

```bash
$ npm install oojs-ui
```

--------------------------------

### Command-line usage example

Source: https://github.com/wikimedia/mediawiki/blob/master/resources/lib/CLDRPluralRuleParser/README.md

Run the command-line utility with a rule and a number. The output is 'false' for the given input.

```bash
$ cldrpluralruleparser 'n is 1' 0
false
```

--------------------------------

### Start memcached daemon manually with loopback interface

Source: https://github.com/wikimedia/mediawiki/blob/master/docs/memcached.md

Starts memcached in daemon mode, bound to the loopback interface on port 11211, using up to 64 MiB of memory. This is used when the daemon is not started automatically via /etc/init.d/memcached.

```shell
memcached -d -l 127.0.0.1 -p 11211 -m 64
```
Tokens:
Raw