Template:Download PDF

Template documentation

[view] [edit] [history] [purge]

Use this template to make a button that, when clicked, will prompt the user to print or download a PDF with a specified set of pages.

This template is a template gadget that requires the DownloadPDF gadget to work. Follow the installation instructions to get it working in your wiki.

Usage

Markup	Renders as
{{Download PDF | pages = Help:Images, Help:Tables, Help:Templates | text = Download help pages }}	Download help pages

Installation

To install this template in your wiki:

1. Create a template with any name and the following markup (you can adjust the parameter names and defaults to suit your wiki):

   <span data-pages="{{{pages|{{FULLPAGENAME}}}}}" data-separator="{{{separator|,}}}" class="DownloadPDF cdx-button cdx-button--fake-button cdx-button--fake-button--enabled">{{{text|Download PDF}}}</span>[[Category:DownloadPDF.js]]
   

2. Create MediaWiki:Gadget-DownloadPDF.js with the following code:

   /**
    * DownloadPDF enables printing or downloading a specified set of pages
    * Documentation: https://www.mediawiki.org/wiki/DownloadPDF
    * Source code: https://www.mediawiki.org/wiki/MediaWiki:Gadget-Global-DownloadPDF.js
    */
   mw.loader.load( '//www.mediawiki.org/w/load.php?modules=ext.gadget.Global-DownloadPDF' );
   

3. Add the following gadget to MediaWiki:Gadgets-definition:

   * DownloadPDF[ResourceLoader|hidden|default|categories=DownloadPDF.js]|DownloadPDF.js
   

Done! Add your template to any page to verify that the installation was successful.

Template data

Use this template to make a button that, when clicked, will prompt the user to print or download a PDF with a specified set of pages.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Pages	pages	Comma-separated list of pages to print or download Default The current page Example Help:Images, Help:Tables, Help:Templates	String	optional
Separator	separator	Separator in the list of pages Default , Example ;	String	optional
Text	text	Text of the button Default Download PDF Example Download instructions	String	optional

See also

• v:Template:Download PDF - Localization of this template for the English Wikiversity

The above documentation is transcluded from Template:Download PDF/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.