mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
synced 2024-11-23 23:24:39 +00:00
61 lines
2.5 KiB
Markdown
61 lines
2.5 KiB
Markdown
# mediawiki/extensions/Popups
|
|
|
|
See https://www.mediawiki.org/wiki/Extension:Popups for more information about
|
|
what it does.
|
|
|
|
## Development
|
|
|
|
Popups uses an asset bundler so when developing for the extension you'll need
|
|
to run a script to assemble the frontend assets.
|
|
|
|
You can find the frontend source files in `src/`, the compiled sources in
|
|
`resources/dist/`, and other frontend assets managed by resource loader in
|
|
`resources/*`.
|
|
|
|
After an `npm install`:
|
|
|
|
* On one terminal, kickstart the bundler process:
|
|
* `npm start` Will run the bundler in watch mode, re-assembling the files on
|
|
file change.
|
|
* `npm run build` Will compile the assets just once, ready for deployment. You
|
|
*must* run this step before sending the patch or CI will fail (so that
|
|
sources and built assets are in sync).
|
|
* On another terminal, run tests and linting tools:
|
|
* `npm test` To run the linting tools and the tests.
|
|
* You can find the QUnit tests that depend on running MediaWiki under
|
|
`tests/qunit/`
|
|
* You can find the isolated QUnit tests under `tests/node-qunit/`, which you
|
|
can run with `npm run test:node`
|
|
* We recommend you install a file watcher like `nodemon` to watch sources and
|
|
auto run linting and tests.
|
|
* `npm install -g nodemon`
|
|
* Example running linting and node unit tests:
|
|
* `nodemon -w src/ --exec "grunt lint:all && npm run test:node"`
|
|
* Get code coverage report with `npm run coverage`
|
|
* Reports printed in the `coverage/` folder
|
|
|
|
Developers are likely to work with local MediaWiki instances that do not have
|
|
content to test with. To reduce this pain, you can create a single page with
|
|
a list of links that point to an existing and external wiki by using the
|
|
following config flag:
|
|
|
|
$wgPopupsGateway = 'restbaseHTML';
|
|
$wgPopupsRestGatewayEndpoint = 'https://en.wikipedia.org/api/rest_v1/page/summary/';
|
|
|
|
Popups works with a local copy of the [Mobile Content Service] too:
|
|
|
|
$wgPopupsGateway = 'restbaseHTML';
|
|
$wgPopupsRestGatewayEndpoint = 'http://localhost:6927/en.wikipedia.org/v1/page/summary/';
|
|
|
|
[Mobile Content Service]: https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/services/mobileapps/+/master
|
|
|
|
## Terminology
|
|
|
|
- Hovercard - Deprecated term for popup.
|
|
- Link preview - A similar user feature in the Android native app.
|
|
- Navpop / nav pop - A popup-like UI from the NavigationPopups gadget.
|
|
- Popup - Generic term for a dialog that appears to float above a link that is
|
|
being hovered over by a cursor.
|
|
- Page preview - A specific type of popup that shows a page summary.
|
|
- Preview - A synonym for popup.
|