Template:PDFlink

From Wikipedia, the free encyclopedia
Jump to: navigation, search

PDFlink must be run with an argument{{{1}}} PDF ({{{2}}})

Documentation icon Template documentation[view] [edit] [history] [purge]

{{PDFlink}} 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 KB}} 
{{PDFlink|[http://www.example.org/fileserver/239349 Link]|1.4 MB}}

yield:

Link PDF
Link PDF (32 KB)
Link PDF (1.4 MB)

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.[clarification needed]

Units: Per WP:Manual of Style (dates and numbers), use KB and MB (kilobytes and megabytes), not KiB and MiB (kibibytes and mibibytes), as very few readers have ever even heard of the latter units.

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 added 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. */
#content span.PDFlink a,
#mw_content span.PDFlink a {
    background: url("http://upload.wikimedia.org/wikipedia/commons/2/23/Icons-mini-file_acrobat.gif") center right no-repeat;
    padding-right: 18px;
}

Limitations and easy workarounds

The problematic "=" character

When this template is used with unnamed parameters, links containing the "=" (equals sign) character will cause the link to not display at all. Workarounds available are:

  • Use explicitly numbered parameters, |1= and |2=, for the URL and the file size, respectively

or

  • Use {{=}} as a replacement for =

or


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


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