Skin:WikimediaApiPortal

From mediawiki.org
Jump to navigation Jump to search
MediaWiki skins manual - category
Crystal Clear device blockdevice.png
WikimediaApiPortal
Release status: beta
Description Skin for the Wikimedia API Portal
MediaWiki 1.36+
License GNU General Public License 3.0 only
Download
Translate the WikimediaApiPortal skin if it is available at translatewiki.net
Check usage and version matrix;
Issues : Open tasks · Report a bug

WikimediaApiPortal is a skin for MediaWiki created by the Wikimedia Foundation Platform Engineering Team in 2020 as part of the API Gateway initiative. The skin is designed to mimic the look and feel of conventional developer portals by incorporating header and sidebar navigation elements and following the Wikimedia Design Style Guide. The skin uses the Bootstrap CSS framework, OOUI library, and Mustache templates. The skin was created for use with the Wikimedia API Portal, so some elements of the design such as the site logo and footer are specific to Wikimedia.

Installation[edit]

WikimediaApiPortal requires MediaWiki 1.36 or later.

  • Download and place the file(s) in a directory called WikimediaApiPortal in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadSkin( 'WikimediaApiPortal' );
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Configuration[edit]

Variable name Required? Default Type Description
$wgWMAPIPExtraUserMenuSpecialPages Optional [] Array Names of special pages to add as localized links to the user menu. Do not need to start with Special:. For example, the Wikimedia API Portal includes the ['AppManagement'] special page (provided by Extension:WikimediaApiPortalOAuth) in the user menu.
$wgWMAPIPSidebarSpecialPages Optional [] Array Names of special pages that form a dedicated navigation sidebar. If one of those pages is being rendered, the navigation sidebar will be shown, and the given page will be highlighted. This provides an easy way to navigate between a small set of frequently used special pages on the site. Do not need to start with Special:. For example, the Wikimedia API Portal uses a sidebar that includes the ['AppManagement', 'Notifications', 'Preferences'] special pages.

Sidebar configuration[edit]

WikimediaApiPortal requires subpages enabled in any namespaces that should support sidebar navigation. Add the $wgNamespacesWithSubpages configuration setting to your LocalSettings.php to enable subpages. For example, to enable subpages in the main namespace:

$wgNamespacesWithSubpages[NS_MAIN] = true;

Usage[edit]

Sidebars[edit]

Sidebars allow you to navigate easily between related pages. Subpages are automatically added to the sidebar of the parent page. To order elements in a sidebar, add {{DEFAULTSORT:1}} where the number represents the order in the sidebar.

Site footer[edit]

To add content to the footer, edit MediaWiki:FooterLinks using sidebar syntax.