wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-23 23:24:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups
1545 commits 280 branches 0 tags 66 MiB
JavaScript 84.7%
PHP 9.9%
Less 5%
Shell 0.4%
Go to file
Piotr Miazga 915a9708fb PopupsContext::areDependenciesMet should respect PopupsGateway config 
On all wikis Popups use Restbase as default gateway. In that case we
do not require the TextExtracts nor PageImages extensions. Code should
reflect that.

Bug: T190818
Change-Id: If4ce8f709b2ca1bb3cc381afa5e80e978adf2498
2018-03-28 16:31:15 -07:00
doc Merge "Doc: ADR for replacing Mustache with ES6 strings" 2018-03-23 15:57:33 +00:00
i18n Merge "Doc: update some of the popups / preview terminology" 2018-03-23 10:24:39 +00:00
images BetaFeatures logo: Merge logo and title path 2017-11-28 10:30:37 -08:00
includes PopupsContext::areDependenciesMet should respect PopupsGateway config 2018-03-28 16:31:15 -07:00
resources Standardise disambiguation icon 2018-03-23 13:54:31 -07:00
src Hygiene: Update comment of application initialization 2018-03-23 09:32:52 -05:00
tests PopupsContext::areDependenciesMet should respect PopupsGateway config 2018-03-28 16:31:15 -07:00
.babelrc Hygiene: enable Babel transpilation 2018-03-20 07:59:14 -05:00
.eslintrc.es5.json Hygiene: favor string templates over concatenation 2018-03-21 08:05:55 -05:00
.eslintrc.json Hygiene: restrict use of $.each and fix offenders 2018-03-21 14:24:22 -05:00
.gitattributes Hide package lock file from git diff 2018-03-14 19:06:51 +00:00
.gitignore Generate docs inside doc folder 2017-05-30 10:16:57 -04:00
.gitreview Merge remote-tracking branch 'gerrit/mpga' 2017-02-14 11:20:17 -08:00
.istanbul.yml Hygiene: Tidy up QUnit references 2017-05-04 15:53:44 +01:00
.phpcs.xml build: Updating mediawiki/mediawiki-codesniffer to 15.0.0 2017-12-30 02:19:18 +00:00
.stylelintrc.json build: Update linters 2018-02-04 22:09:45 +00:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 2017-06-07 15:30:07 +04:30
composer.json build: Updating jakub-onderka/php-parallel-lint to 1.0.0 2018-03-10 02:25:40 +00:00
COPYING Add COPYING file 2014-02-06 15:38:46 +05:30
extension.json Standardise disambiguation icon 2018-03-23 13:54:31 -07:00
Gruntfile.js Hygiene: forbid lint warnings 2018-03-21 10:44:52 +00:00
jsdoc.json Generate docs inside doc folder 2017-05-30 10:16:57 -04:00
package-lock.json Fix: JSDoc Node.js file copy bug 2018-03-20 09:24:06 -05:00
package.json Hygiene: remove unused resources 2018-03-21 17:07:18 -05:00
Popups.php Hygiene: Update required MediaWiki version 2017-07-24 16:12:03 +02:00
README.md Doc: update some of the popups / preview terminology 2018-03-23 11:18:26 +01:00
webpack.config.js Hygiene: remove unused resources 2018-03-21 17:07:18 -05:00

README.md

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/';

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.