CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>575ea96f08433d43492b68c552b047c3347920c0 - mediawiki/extensions/NearbyPages - Gitiles</title><link rel="stylesheet" type="text/css" href="/r/plugins/gitiles/+static/base.css"><link rel="stylesheet" type="text/css" href="/r/plugins/gitiles/+static/doc.css"><link rel="stylesheet" type="text/css" href="/r/plugins/gitiles/+static/prettify/prettify.css"></head><body class="Site"><header class="Site-header"><div class="Header"><div class="Header-title">Gitiles</div><div class="Header-menu"> <a class="Header-menuItem" href="https://gerrit.wikimedia.org/r/">Code Review</a> <a class="Header-menuItem" href="https://gerrit.wikimedia.org/r/login/plugins%2Fgitiles%2Fmediawiki%2Fextensions%2FNearbyPages%2F%2B%2F575ea96f08433d43492b68c552b047c3347920c0">Sign In</a> </div></div></header><div class="Site-content"><div class="Container "><div class="Breadcrumbs"><a class="Breadcrumbs-crumb" href="/r/plugins/gitiles/?format=HTML">gerrit.wikimedia.org</a> / <a class="Breadcrumbs-crumb" href="/r/plugins/gitiles/mediawiki/">mediawiki</a> / <a class="Breadcrumbs-crumb" href="/r/plugins/gitiles/mediawiki/extensions/">extensions</a> / <a class="Breadcrumbs-crumb" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/">NearbyPages</a> / <span class="Breadcrumbs-crumb">575ea96f08433d43492b68c552b047c3347920c0</span></div><div class="u-monospace Metadata"><table><tr><th class="Metadata-title">commit</th><td>575ea96f08433d43492b68c552b047c3347920c0</td><td><span>[<a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+log/575ea96f08433d43492b68c552b047c3347920c0">log</a>]</span> <span>[<a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+archive/575ea96f08433d43492b68c552b047c3347920c0.tar.gz">tgz</a>]</span></td></tr><tr><th class="Metadata-title">author</th><td>libraryupgrader <tools.libraryupgrader@tools.wmflabs.org></td><td>Fri Nov 15 02:08:32 2024 +0000</td></tr><tr><th class="Metadata-title">committer</th><td>libraryupgrader <tools.libraryupgrader@tools.wmflabs.org></td><td>Fri Nov 15 06:13:35 2024 +0000</td></tr><tr><th class="Metadata-title">tree</th><td><a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/">6946d95e836582ee0f06da8ff8cdb98439467133</a></td></tr><tr><th class="Metadata-title">parent</th><td><a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0%5E">38ad3c4921c9c43d0ad0d5906c62432a2518187f</a> <span>[<a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0%5E%21/">diff</a>]</span></td></tr></table></div><pre class="u-pre u-monospace MetadataMessage">build: Updating @wikimedia/codex to 1.16.0 Change-Id: <a href="https://gerrit.wikimedia.org/r/#/q/I4f232c3d0deaa0cf82c66ab7fdd974df2cc1fa3f">I4f232c3d0deaa0cf82c66ab7fdd974df2cc1fa3f</a> </pre><ul class="DiffTree"><li><a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/package-lock.json">package-lock.json</a><span class="DiffTree-action DiffTree-action--modify">[<a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0%5E%21/#F0">diff</a>]</span></li><li><a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/package.json">package.json</a><span class="DiffTree-action DiffTree-action--modify">[<a href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0%5E%21/#F1">diff</a>]</span></li></ul><div class="DiffSummary">2 files changed</div><div class="TreeDetail"><div class="u-sha1 u-monospace TreeDetail-sha1">tree: 6946d95e836582ee0f06da8ff8cdb98439467133</div><ol class="FileList"><li class="FileList-item FileList-item--gitTree" title="Tree - .phan/"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.phan/">.phan/</a></li><li class="FileList-item FileList-item--gitTree" title="Tree - dev/"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/dev/">dev/</a></li><li class="FileList-item FileList-item--gitTree" title="Tree - i18n/"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/i18n/">i18n/</a></li><li class="FileList-item FileList-item--gitTree" title="Tree - includes/"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/includes/">includes/</a></li><li class="FileList-item FileList-item--gitTree" title="Tree - resources/"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/resources/">resources/</a></li><li class="FileList-item FileList-item--gitTree" title="Tree - tests/"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/tests/">tests/</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .eslintignore"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.eslintignore">.eslintignore</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .eslintrc.json"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.eslintrc.json">.eslintrc.json</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .gitignore"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.gitignore">.gitignore</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .gitreview"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.gitreview">.gitreview</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .nvmrc"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.nvmrc">.nvmrc</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .phpcs.xml"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.phpcs.xml">.phpcs.xml</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .stylelintignore"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.stylelintignore">.stylelintignore</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .stylelintrc.json"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.stylelintrc.json">.stylelintrc.json</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - .svgo.config.js"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/.svgo.config.js">.svgo.config.js</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - _redirects"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/_redirects">_redirects</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - composer.json"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/composer.json">composer.json</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - COPYING"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/COPYING">COPYING</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - extension.json"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/extension.json">extension.json</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - jest.config.js"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/jest.config.js">jest.config.js</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - jest.setup.js"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/jest.setup.js">jest.setup.js</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - jsdoc.json"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/jsdoc.json">jsdoc.json</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - NearbyPages.alias.php"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/NearbyPages.alias.php">NearbyPages.alias.php</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - package-lock.json"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/package-lock.json">package-lock.json</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - package.json"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/package.json">package.json</a></li><li class="FileList-item FileList-item--regularFile" title="Regular file - README.md"><a class="FileList-itemLink" href="/r/plugins/gitiles/mediawiki/extensions/NearbyPages/+/575ea96f08433d43492b68c552b047c3347920c0/README.md">README.md</a></li></ol><div class="InlineReadme"><div class="InlineReadme-path">README.md</div><div class="doc"><h1><a class="h" name="Installation" href="#Installation"><span></span></a><a class="h" name="installation" href="#installation"><span></span></a>Installation</h1><pre class="code">wfLoadExtension( 'NearbyPages' ); </pre><h2><a class="h" name="Sourcing-content" href="#Sourcing-content"><span></span></a><a class="h" name="sourcing-content" href="#sourcing-content"><span></span></a>Sourcing content</h2><p>To get NearbyPages showing articles from your favorite mediawiki instance you'll need to first config the $wgNearbyPagesUrl config variable.</p><pre class="code">$wgNearbyPagesUrl = "https://en.wikipedia.org/w/api.php"; </pre><p>For wikidata wikis a little more configuration is required like so:</p><pre class="code">$wgNearbyPagesNamespaces = [ 640, 146, 0 ]; $wgNearbyPagesWikidataCompatibility = true; $wgNearbyPagesUrl = "https://www.wikidata.org/w/api.php"; </pre><h2><a class="h" name="Note-for-wikis-running-MobileFrontend" href="#Note-for-wikis-running-MobileFrontend"><span></span></a><a class="h" name="note-for-wikis-running-mobilefrontend" href="#note-for-wikis-running-mobilefrontend"><span></span></a>Note for wikis running MobileFrontend</h2><p>To avoid compatibility issues, ensure that MobileFrontend version 2.3.0 is running.</p><h2><a class="h" name="Development" href="#Development"><span></span></a><a class="h" name="development" href="#development"><span></span></a>Development</h2><p>You can begin development on Special:NearbyPages with 2 simple commands:</p><pre class="code">npm install npm start </pre><p>To develop on Wikidata using this mode, edit resources/ext.nearby.scripts/config.json before running the command substituting the following values:</p><pre class="code">NearbyPagesNamespaces: [ 640, 146, 0 ], NearbyPagesUrl: 'https://www.wikidata.org/w/api.php', NearbyPagesWikidataCompatibility: true </pre></div></div></div></div> </div> <footer class="Site-footer"><div class="Footer"><span class="Footer-poweredBy">Powered by <a href="https://gerrit.googlesource.com/gitiles/">Gitiles</a></span><span class="Footer-formats"><a class="u-monospace Footer-formatsItem" href="?format=TEXT">txt</a> <a class="u-monospace Footer-formatsItem" href="?format=JSON">json</a></span></div></footer></body></html>