Extension:Attachments

Category:MIT licensed extensions
MediaWiki extensions manual
Attachments
Release status: stableCategory:Stable extensions
Implementation Parser function Category:Parser function extensions, Variable Category:Variable extensions, Page action Category:Page action extensions, Hook Category:Hook extensions
Description Attach subpages, files and external links to pages.
Author(s)
Latest version 1.0.1
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.Category:Extensions with release branches compatibility policy
MediaWiki 1.39+Category:Extensions with manual MediaWiki version
License MIT License
Download Category:Extensions in GitHub version control
Example https://vowi.fsinf.at/
  • $wgAttachmentsNamespaces
  • $wgAttachmentsChunkListByLetter
  • $wgAttachmentsShowSubpageForm
  • $wgAttachmentsShowLinkForm
  • $wgAttachmentsShowInNamespaces
  • $wgAttachmentsShowInViews
  • $wgAttachmentsShowEmptySection
Category:All extensions

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 list 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

  • #attach can also be used to attach a regular page to another regular 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.

Relatively linking an attached file

The Attachments extension provides the {{FILEPREFIX}} parser function to faciliate linking/embedding attached files.

If you attach an image Example.jpg to Somepage then you can embed the image:

  • from Somepage with [[File:{{FILEPREFIX}}Example.jpg]]
  • from Somepage/Subpage with [[File:{{FILEPREFIX:..}}Example.jpg]]
  • from Somepage/Subpage/Subsubpage with [[File:{{FILEPREFIX:../..}}Example.jpg]]

Note that the same also works with [[Media:...]] links.

Installation

  • Enable Uploads.
  • Developers can clone the extension into your MediaWiki extensions directory:
    cd extensions/
    git clone https://github.com/vuhuy/Swiki
    

Note that you should also enable subpages for these namespaces.

Optional configuration parameters

$wgAttachmentsChunkListByLetter Boolean Whether or not the attachment list should be chunked by the first letter of list items. Defaults to true.
$wgAttachmentsShowSubpageForm Boolean Whether or not the subpage form should be shown. Defaults to true.
$wgAttachmentsShowLinkForm Boolean Whether or not the external link form should be shown. Defaults to true.
$wgAttachmentsShowInNamespaces Boolean Whether or not a link to the attachments should be shown in the namespaces (page, discussion). Defaults to false.
$wgAttachmentsShowInViews Boolean Whether or not an 'add attachments' link should be shown in the views (read, edit source, view history). Defaults to false.
$wgAttachmentsShowEmptySection Boolean Whether or not to show certain elements when there are no attachments for a page. Defaults to false.

Tips

Credits

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

Originally developed and maintained by Gittenburg.

See also

Category:Attachment extensions
Category:All extensions Category:Attachment extensions Category:BeforePageDisplay extensions Category:ChangeTagsListActive extensions Category:Extensions in GitHub version control Category:Extensions with manual MediaWiki version Category:Extensions with release branches compatibility policy Category:Hook extensions Category:ListDefinedTags extensions Category:MIT licensed extensions Category:MagicWordwgVariableIDs extensions Category:Page action extensions Category:ParserFirstCallInit extensions Category:ParserGetVariableValueSwitch extensions Category:Parser function extensions Category:SkinTemplateNavigation::Universal extensions Category:Stable extensions Category:Variable extensions