Jump to content

Extension:PortableInfobox

From mediawiki.org
MediaWiki extensions manual
PortableInfobox
Release status: stable
Implementation Tag
Description Port of Fandom's PortableInfobox extension to the MediaWiki 1.37.0+
Author(s) Universal Omega,
Luqgreg,
Fandom (original version)
Latest version 0.8
Compatibility policy Master maintains backward compatibility.
MediaWiki >= 1.43.0
Database changes No
  • $wgPortableInfoboxCustomImageWidth
  • $wgPortableInfoboxUseFileDescriptionPage
  • $wgPortableInfoboxUseTidy
  • $wgPortableInfoboxResponsiblyOpenCollapsed
  • $wgPortableInfoboxUseHeadings
  • $wgAllInfoboxesExcludedSubpages
  • $wgPortableInfoboxCacheRenderers
‎<infobox>
Licence GNU General Public License 3.0 or later
Download
README

The PortableInfobox extension allows to create portable infoboxes, which can be rendered using clean semantic HTML markup on any skin or platform using easy to understand powerful XML-like markup. It is a port of Fandom's PortableInfobox extension to the newer MediaWiki versions.

Installation

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

Configuration parameters

$wgAllInfoboxesExcludedSubpages (array)
List of subpages in template namespace to omit by API allinfoboxes query. (default: [ "doc", "draft", "test" ])
$wgPortableInfoboxCacheRenderers (bool)
Whether to cache infobox renderers in the main cache. (default: false)
$wgPortableInfoboxCustomImageWidth (int)
Size of image thumbnails used in infoboxes. (default: 300)
$wgPortableInfoboxUseHeadings (bool)
Use heading tags for infobox titles and group headers, it may cause incompatibilites with other extensions. (default: true)
$wgPortableInfoboxUseTidy (bool)
Use RemexHtml for validating HTML in infoboxes. (default: true)
$wgPortableInfoboxResponsiblyOpenCollapsed (bool)
Whether to open collapsed sections when the screen is narrow. (default: true)
$wgPortableInfoboxUseFileDescriptionPage (bool)
Whether or not infobox images will link to file description pages instead of the files directly. (default: false)

Usage

See Help:Infoboxes/Tags on Fandom.

‎<media /> tag

In the 0.3 version, the ‎<media /> tag was introduced in favor of ‎<image />, which still works (see Aliases). It allows users to embed images, videos, and audio files in the infobox, in the same way as ‎<image /> tag does in the original version.

Attributes

  • source – name of the parameter
  • audio – If set to false, it ignores all audio files
  • image – If set to false, it ignores all images
  • video – If set to false, it ignores all videos

Child tags

  • ‎<default>
  • ‎<caption>

Aliases

  • ‎<audio /> – variation of ‎<media /> tag that allows only audio files
  • ‎<image /> – variation of ‎<media /> tag that allows only images and videos (for backward compatibility, can be disabled with video="false")
  • ‎<video /> – variation of ‎<media /> tag that allows only videos

User-facing differences from the original version

  • It's based on Wikia/app@b9fcbe5d6db928e318d64ad0568ec2d09a3f406e. There may be some features introduced in the original version at a later date which are absent here.
  • Europa theme was removed.
  • .pi-theme-default class is applied instead of .pi-theme-wikia to the infobox, when no theme is specified.
  • When a ‎<gallery> tag is passed to the infobox with images without captions, file name is used instead of not showing the image.
  • When embedding a video in the infobox additional class .pi-video is added to the ‎<figure> tag.
  • Videos use ‎<video> tags instead of showing video in a modal after clicking a thumbnail.
  • .pi-image class is no longer present in the ‎<figure> tag with a video, instead .pi-media class is applied to all media elements.
  • .pi-image-collection classes were changed to .pi-media-collection.
  • accent-color-* attributes allow more color formats.
  • More HTML tags are allowed in captions.
  • Mobile skin doesn't get separate styling.