Extension:Attachments

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
Attachments
Release status: stable
px
Implementation Parser function , Variable , Page action , Hook
Description Attach subpages, files and external links to pages.
Author(s) (Gittenburgtalk)
Latest version 0.1.0 (2019-06-11)
Compatibility policy master
MediaWiki 1.31+
License MIT License
Download
Example https://vowi.fsinf.at/
$wgAttachmentsNamespaces
Translate the Attachments extension if it is available at translatewiki.net
Check usage and version matrix.

The Attachments extension lets users attach subpages, files and external links to pages in enabled namespaces.

  • Attachments can easily be added through the user interface.
  • Attachments of an article are displayed in an automatically generated section at its end.
  • This extension integrates with the Vector and Minerva skins.

So how does it work?

  • subpages automatically count as attached to their parent page
  • When you upload a file through the Attach page action, a parser function {{#attach: Title}} is added to the descripiton.
  • When you add a link, the extension creates a subpage containing the {{#exturl: URL}} parser function.
  • Both parser functions set page properties, which are queried for the autogenerated sections.

Advanced features[edit]

  • #attach can also be used to attach a regular page to another regular page.
  • You can link files added through the Attach page action relatively with [[File:{{FILEPREFIX}}filename.jpg]] (or {{FILEPREFIX:..}} for the parent page).
  • You can exclude subpages starting with a specific prefix from the autoindex with {{#attachments ignore subpages: prefix}} on the parent page.
  • You can access attachments before they are sorted with the BeforeSortAttachments(&$links) hook, where links is an associative array mapping string keys to HTML links. Return false to take over the sorting.

Installation[edit]

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

Configuration parameters[edit]

$wgAttachmentsNamespaces
Associative array, set a namespace id to true to enable the extension in the namespace.
For example: $wgAttachmentsNamespaces[NS_MAIN] = true;
Note that you should also enable subpages for these namespaces.

Tips[edit]

Credits[edit]

This extension is essentially a complete rewrite of PerPageResources by Mathias Ertl, which consists of Extension:Resources, Extension:AddResource and Extension:ExternalRedirects. This extension replaces all three, notable differences are:

  • attachments are stored in page_props instead of pagelinks
  • no open redirects, just links
  • attachments are shown at the end of pages, as opposed to on a special page

See also[edit]