Centiare at 16:52, 7 December 2006

2006-12-07T16:52:46Z

New page

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>


==Purpose==

Highlighting that a link points to a [[Portable Document Format|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:


<nowiki>{{PDFlink|[http://www.example.com/Link.pdf Link]}}</nowiki>
<nowiki>{{PDFlink|[http://www.example.com/Link.pdf Link]|32&nbsp;[[KiB]]}}</nowiki>

yield:


:{{PDFlink|[http://www.example.com/Link.pdf Link]}}
:{{PDFlink|[http://www.example.com/Link.pdf Link]|32 [[KiB]]}}

'''Note:''' It was previously possible to add the icon with <code><nowiki>{{PDFlink}}</nowiki></code> by itself, but the functionality has been changed and this no longer works in Internet Explorer. You must surround it with the template as shown above.

== Limitations ==
As the template uses [[m:Help:Templates#Restrictions_on_parameter_values|unnamed parameters]], links containing <tt>=</tt> or <tt>|</tt> will cause the link to not display at all. The two workarounds to this limitation are to replace the entity with an indirect [[Numeric character reference|character reference]] as <code>&#61;</code> and <code>&#124;</code>, respectively, or to use the numbered parameter (<code>1=</code> and <code>2=</code>) for each parameter.

Examples:
* <tt><nowiki>{{PDFlink|[http://www.com/bla?a=xy|Link.pdf Link to a PDF]|32KB}}</nowiki></tt>
** {{PDFlink|[http://www.com/bla?a=xy/Link.pdf Link to a PDF]|32KB}}
* <tt><nowiki>{{PDFlink|[http://www.com/bla?a</nowiki>'''&#61;'''xy'''&#124;'''Link.pdf Link to a PDF]|32KB}}</tt>
** {{PDFlink|[http://www.com/bla?a=xy|Link.pdf Link to a PDF]|32KB}}
* <tt><nowiki>{{PDFlink|</nowiki>'''1='''<nowiki>[http://www.com/bla?a=xy</nowiki>'''&#124;'''Link.pdf Link to a PDF]|'''2='''32KB}}</tt>
** {{PDFlink|1=[http://www.com/bla?a=xy|Link.pdf Link to a PDF]|2=32KB}}

== See also ==

* [[Template:DOClink]]
* [[Template:RTFlink]]
* [[Template:videolink]]
* [[Template:audiolink]]

<includeonly>

[[Category:External link file type templates|{{PAGENAME}}]]



</includeonly>

Template:PDFlink/doc - Revision history

Centiare at 16:52, 7 December 2006