mirror of
https://github.com/Universal-Omega/PortableInfobox.git
synced 2024-11-24 00:06:25 +00:00
60 lines
4 KiB
Markdown
60 lines
4 KiB
Markdown
# PortableInfobox
|
|
Port of FANDOM's https://github.com/Wikia/app/tree/dev/extensions/wikia/PortableInfobox extension to MediaWiki 1.39.0+ (1.36-1.38 are available in release branches)
|
|
|
|
## Installation
|
|
Grab the latest release from [GitHub](https://github.com/Universal-Omega/PortableInfobox) and unpack it into `extensions\PortableInfobox` directory in your MediaWiki installation or clone this repository, by using these commands:
|
|
```bash
|
|
cd extensions
|
|
git clone https://github.com/Universal-Omega/PortableInfobox.git --depth=1
|
|
```
|
|
|
|
and add the following code at the bottom of [LocalSettings.php](https://www.mediawiki.org/wiki/Manual:LocalSettings.php):
|
|
```php
|
|
wfLoadExtension( 'PortableInfobox' );
|
|
```
|
|
|
|
## Configuration
|
|
You can use several variables to modify extension's behaviour:
|
|
- `$wgAllInfoboxesSubpagesBlacklist` (array) - list of subpages in template namespace to omit by AllInfoboxes query. (default: [ "doc", "draft", "test" ])
|
|
- `$wgPortableInfoboxCacheRenderers` (bool) - cache internal infobox renderers. (default: true)
|
|
- `$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 incompatibilities with other extensions. (default: true)
|
|
- `$wgPortableInfoboxUseTidy` (bool) - use [RemexHtml](https://www.mediawiki.org/wiki/RemexHtml) for validating HTML in infoboxes (default: true)
|
|
- `$wgPortableInfoboxResponsiblyOpenCollapsed` (bool) - open collapsed groups when the screen is narrow. (default: true)
|
|
- `$wgPortableInfoboxUseFileDescriptionPage` (bool) - control whether or not embedded images in the infobox will link to their file description page instead of directly to the file. (default: false)
|
|
|
|
## Usage
|
|
See: https://community.fandom.com/wiki/Help:Infoboxes
|
|
|
|
### `<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 backwards compatibilty, 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](https://github.com/Wikia/app/tree/b9fcbe5d6db928e318d64ad0568ec2d09a3f406e/extensions/wikia/PortableInfobox) and there might be some features, that were introduced in the original version at a later date, but they're 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 except floating and collapsing group features are disabled by default. Set `$wgPortableInfoboxResponsiblyOpenCollapsed` to `false` if you need collapsing group on mobile.
|
|
- It may be *a little* more buggy :)
|