Template:PDFLink/doc

This is a documentation subpage for Template:PDFLink.
It may contain usage information, categories and other content that is not part of the original template page.

{{PDFLink/doc}} highlights that a link points to a PDF document (on some systems PDF files may take time to download and display within the browser, and their use on many websites is not compliant with the Web Content Accessibility Guidelines).

Usage

The following lines:

{{PDFlink|[http://www.example.org/Link.pdf Link]}}
{{PDFlink|[http://www.example.org/Link.pdf Link]|32&nbsp;KB}}
{{PDFlink|[http://www.example.org/Link.pdf Link]|32&nbsp;[[Kibibyte|KiB]]}}

yield:

LinkPDF

LinkPDF (32 KB)

LinkPDF (32 KiB)

Note: It was previously possible to add the icon with {{PDFlink}} by itself, but the functionality has changed, making this no longer work in Internet Explorer. You must surround it with the template as shown above to work correctly in Internet Explorer.

PDFbot

An unassisted bot (User:PDFbot) has been created to add and keep file size information current. In addition, it will fix many mistakes and the limitation as described in the section below.

Note: the bot will replace the contents of the second parameter when updating the file size.

Icon

The icon is add using CSS and is found in MediaWiki:Common.css, the relevant portion that applies the icon is:

/* Change the external link icon to an Adobe icon anywhere the PDFlink class */
/* is used (notably Template:PDFlink). This works in IE, unlike the above. */
span.PDFlink a {
    background: url(http://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Icons-mini-file_acrobat.gif/15px-Icons-mini-file_acrobat.gif) center right no-repeat !important;
    padding-right: 17px !important;
}

Limitations

As this template uses unnamed parameters, links containing = or | will cause the link to not display at all. The workaround is to either replace the entity with an indirect character reference as = and |, respectively, or to use the numbered parameter (1= and 2=) for each parameter to take care of =, or to use {{!}} to take care of |.

Examples:

{{PDFlink|[http://example.org/bla?a=xy|Link.pdf Link to a PDF]|32KB}}
- 32KBPDF

{{PDFlink|[http://example.org/bla?a=xy|Link.pdf Link to a PDF]|32KB}}
- Link to a PDFPDF (32KB)

{{PDFlink|1=[http://example.org/bla?a=xy{{!}}Link.pdf Link to a PDF]|2=32KB}}
- Link to a PDFPDF (32KB)