Template:PDFCite/doc: Difference between revisions

From Toolkit.Socialnetwork.Health
No edit summary
No edit summary
Line 31: Line 31:
"type": "unbalanced-wikitext",
"type": "unbalanced-wikitext",
"default": "PDF",
"default": "PDF",
"required": true,
"required": false,
"description": "It will become a clickable text or html element. If you want to display the citation text on the wiki page, type 'quote' here (without quotes)."
"description": "It will become a clickable text or html element. If you want to display the citation text on the wiki page, type 'quote' here (without quotes)."
},
},

Revision as of 20:52, 7 May 2024

Inserts a link to the PDF file and ensures the highlighting of the provided citation on the given page.

Template parameters

ParameterDescriptionTypeStatus
URL to the PDF filefile

A fully qualified URL to the PDF file.

Example
https://domain.tld/filename.pdf
URLrequired
Text of citationcitation

The cited passage in plain text.

Stringrequired
Page numberpage

A number of page in the PDF file that contains the cited passage.

Numberrequired
Highlight colorcolor

The hex color code without a leading hash.

Example
FFEEDD
Stringoptional
Link texttext

It will become a clickable text or html element. If you want to display the citation text on the wiki page, type 'quote' here (without quotes).

Default
PDF
Unbalanced wikitextoptional
Tooltip texttooltip

Text shown on hovering over the link. If not provided, the URL of the PDF file will be shown.

Stringoptional
Code
{{PDFCite
|file=
|citation=
|page=
|text=
|color=
}}
Example
{{PDFCite
|file=https://wikivisor.com/w/images/3/34/Peer_adult_network_structure_and_suicide_attempts_in_38_high_schools.pdf
|citation=(b) Mean number of friends named, and (c) Mean coreness. Table 1 describes school-level variables and each school’s network structure relative to all others (e.g., percent isolates ranged 0–6.45% across the 38 schools)
|page=3
|color=33eeff
}}
Result

PDF

Quote mode

(b) Mean number of friends named, and (c) Mean coreness. Table 1 describes school-level variables and each school’s network structure relative to all others (e.g., percent isolates ranged 0–6.45% across the 38 schools)

Inline usage

Table 1 describes school-level percent isolates ranged 0–6.45% across the 38 schools.

Local PDF (fake example)

If the URL belongs to the current wiki domain, the external icon will not be printed: PDF