Shawndouglas: Updated text.

2013-05-31T19:44:50Z

Updated text.

← Older revision		Revision as of 19:44, 31 May 2013
Line 2:		Line 2:
	<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->		<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

	{{tl\|{{PAGENAME}}}} highlights 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]]).		{{tl\|{{PAGENAME}}}} 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 ==		== Usage ==
Line 21:		Line 21:
	:{{PDFlink\|[http://www.example.org/fileserver/239349 Link]\|1.4 MB}}		:{{PDFlink\|[http://www.example.org/fileserver/239349 Link]\|1.4 MB}}

	'''Note:''' It was previously possible to add the icon with <code><nowiki>{{PDFlink}}</nowiki></code> 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.{{clarify\|reason=What version(s), on what platform(s)?}} See [[#Use in citation templates]], below, for how to do this now without boogering IE.		'''Note:''' It was previously possible to add the icon with <code><nowiki>{{PDFlink}}</nowiki></code> 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.{{clarify\|reason=What version(s), on what platform(s)?}} See [[#Use in citation templates]], below, for how to do this now without boogering IE.

	'''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.		'''Units''': 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 [[WP:Bot policy\|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 ==		== Icon ==
Line 49:		Line 44:
	*Use <code><nowiki>{{=}}</nowiki></code> as a replacement for <code>=</code>		*Use <code><nowiki>{{=}}</nowiki></code> as a replacement for <code>=</code>
	or		or
	*Replace the <code>=</code> character with its ~~[[Numeric character reference\|~~numeric character entity reference]], <code>&#61;</code>		*Replace the <code>=</code> character with its numeric character entity reference, <code>&#61;</code>


Line 115:		Line 110:
	<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->		<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
	[[Category:External link file type templates\|{{PAGENAME}}]]		[[Category:External link file type templates\|{{PAGENAME}}]]

	~~[[ar:قالب:وصلة بي دي إف]]~~
	~~[[da:Skabelon:PDFlink]]~~
	~~[[eo:Ŝablono:PDFligilo]]~~
	~~[[es:Plantilla:Enlace PDF]]~~
	~~[[fa:الگو:پی‌دی‌اف]]~~
	~~[[fr:Modèle:pdf]]~~
	~~[[he:תבנית:PDF]]~~
	~~[[hu:Sablon:PDFlink]]~~
	~~[[id:Templat:PDFlink]]~~
	~~[[it:Template:Pdf]]~~
	~~[[ms:Templat:PDFlink]]~~
	~~[[ja:Template:PDFlink]]~~
	~~[[ko:틀:PDF 링크]]~~
	~~[[pt:Predefinição:PDFlink]]~~
	~~[[simple:Template:PDFlink]]~~
	~~[[sl:Predloga:PDF-povezava]]~~
	~~[[th:แม่แบบ:PDFlink]]~~
	~~[[tr:Şablon:PDFlink]]~~
	</includeonly>		</includeonly>

LIMSinstitute: 1 revision

2011-08-03T15:30:54Z

1 revision

New page

{{Documentation subpage}}


{{tl|{{PAGENAME}}}} highlights 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.org/Link.pdf Link]}}</nowiki>
<nowiki>{{PDFlink|[http://www.example.org/Link.pdf Link]|32&nbsp;KB}}</nowiki> 

<nowiki>{{PDFlink|[http://www.example.org/fileserver/239349 Link]|1.4 MB}}</nowiki>

yield:

:{{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}}

'''Note:''' It was previously possible to add the icon with <code><nowiki>{{PDFlink}}</nowiki></code> 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.{{clarify|reason=What version(s), on what platform(s)?}} See [[#Use in citation templates]], below, for how to do this now without boogering IE.

'''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 [[WP:Bot policy|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:
<source lang="css">
/* 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;
}
</source>

== Limitations and easy workarounds ==
===The problematic "=" character===
When this template is used with [[m:Help:Templates#Restrictions on parameter values|unnamed parameters]], links containing the "<code>=</code>" (equals sign) character will cause the link to not display at all. Workarounds available are:
*Use explicitly numbered parameters, {{para|1}} and {{para|2}}, for the URL and the file size, respectively
or
*Use <code><nowiki>{{=}}</nowiki></code> as a replacement for <code>=</code>
or
*Replace the <code>=</code> character with its [[Numeric character reference|numeric character entity reference]], <code>&#61;</code>

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

;Good examples:
<nowiki>{{PDFlink|[http://example.org/bla?a</nowiki>'''&#61;'''xy'''&#124;'''Link.pdf Link to a PDF]|32&nbsp;KB}}
:{{PDFlink|[http://example.org/bla?a=xy|Link.pdf Link to a PDF]|32 KB}}

<nowiki>{{PDFlink|</nowiki>'''1='''<nowiki>[http://example.org/bla?a=xy</nowiki>'''<nowiki>{{!}}</nowiki>'''Link.pdf Link to a PDF]|'''2='''32&nbsp;KB}}
:{{PDFlink|1=[http://example.org/bla?a=xy{{!}}Link.pdf Link to a PDF]|2=32 KB}}

===Use in citation templates===
This template is not instantly compatible with citation templates such as {{tl|cite book}} and {{tl|cite web}}, which put URLs in their own parameter, without markup. Two kinds of usage need two different workarounds, both using the invisible but existent "no-width space" numeric character entity reference, <code>&#8203;</code>.

;URLs ending in ".pdf" or ".PDF":

The workaround is to not use an actual URL (and no [square brackets]) in the {{tl|PDFlink}} first parameter, but just the <code>&#8203;</code> entity:

<nowiki> |title=Some Article
|url=http://www.example.org/fileserver/Link.pdf
|format={{PDFlink|&#8203;|1.4 MB}}</nowiki>

renders as something like:

:[http://www.example.org/fileserver/Link.pdf Some Article] ({{PDFlink||1.4 MB}})

in the spaces that the parameters fill. (Exact spacing, punctuation, etc., depends on the specific citation template used). This prevents the appearance of a PDF icon auto-generated by MediaWiki being followed by one generated by {{tl|PDFlink}}.

Doing this, however:
<nowiki> |title=Some Article
|url=http://www.example.org/fileserver/Link.pdf
|format={{PDFlink|[http://www.example.org/fileserver/Link.pdf &#8203;]|1.4 MB}}</nowiki>

would result in:

:[http://www.example.org/fileserver/Link.pdf Some Article] ({{PDFlink|[http://www.example.org/fileserver/Link.pdf ]|1.4 MB}})

This trick needs to be done with the character entity, because leaving the first parameter blank will simply get the page categorized in a cleanup category for pages that misuse this template, and a bot will "fix" the page's use of the template (i.e., it will cause problems).

;URLs not ending in ".pdf" or ".PDF":

The workaround is to repeat the URL used in {{para|url}} in {{tnull|PDFlink}} inside {{para|format}} as a square-backeted link, and use <code>&#8203;</code> as the link text (note that numbered parameters are often required because of "<code>=<code>" characters in such URLs):

<nowiki> |title=Some Article
|url=http://www.example.org/fileserver&file=2234234
|format={{PDFlink|1=[http://www.example.org/fileserver&file=2234234 &#8203;]|2=1.4 MB}}</nowiki>

yields:

:[http://www.example.org/fileserver&file=2234234 Some Article] ({{PDFlink|1=[http://www.example.org/fileserver&file=2234234 ]|2=1.4 MB}})

I.e., it produces a PDF icon that links to the same target as the URL given in the citation template's {{para|url}} parameter, without creating new link text, and meanwhile MediaWiki did not know this was a PDF file and so did not autogenerate a duplicative icon.



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

[[ar:قالب:وصلة بي دي إف]]
[[da:Skabelon:PDFlink]]
[[eo:Ŝablono:PDFligilo]]
[[es:Plantilla:Enlace PDF]]
[[fa:الگو:پی‌دی‌اف]]
[[fr:Modèle:pdf]]
[[he:תבנית:PDF]]
[[hu:Sablon:PDFlink]]
[[id:Templat:PDFlink]]
[[it:Template:Pdf]]
[[ms:Templat:PDFlink]]
[[ja:Template:PDFlink]]
[[ko:틀:PDF 링크]]
[[pt:Predefinição:PDFlink]]
[[simple:Template:PDFlink]]
[[sl:Predloga:PDF-povezava]]
[[th:แม่แบบ:PDFlink]]
[[tr:Şablon:PDFlink]]
</includeonly>

Template:PDFlink/doc - Revision history

Shawndouglas: Updated text.

LIMSinstitute: 1 revision