📖 Template documentation

Usage

This template creates a standard hyperlink to a source via its Digital Object Identifier (DOI).

Basic

{{Doi|10.1234/example}}

→ doi:10.1234/example

With custom label

{{Doi|10.1234/example|label=Smith et al. 2023}}

→ doi:Smith et al. 2023

Open access

{{Doi|10.1234/example|free=yes}}

→ doi:10.1234/example 🔓

Broken DOI

{{Doi|10.1234/example|broken=2025-01}}

→ ~~doi:10.1234/example~~ [broken 2025-01]

Named parameter

{{Doi|id=10.1234/example}}

Parameters

Parameter Description Required
1 or id The DOI identifier (everything after https://doi.org/) Yes
label Custom link text. Default: doi:<id> No
broken Date (e.g. 2024-06) the DOI was found to be inactive. Renders with strikethrough. No
free Set to yes to show a 🔓 icon indicating free/open-access full text. No

TemplateData

<templatedata> {

 "description": "Creates a hyperlink to a source using its Digital Object Identifier (DOI).",
 "params": {
   "1": {
     "label": "DOI",
     "description": "The DOI identifier, e.g. 10.1234/example",
     "type": "string",
     "required": true,
     "aliases": ["id"]
   },
   "label": {
     "label": "Display label",
     "description": "Custom link text. Defaults to the DOI itself.",
     "type": "string",
     "required": false
   },
   "broken": {
     "label": "Broken date",
     "description": "Date (YYYY-MM) the DOI was found inactive. Renders the link with strikethrough.",
     "type": "string",
     "required": false,
     "example": "2024-06"
   },
   "free": {
     "label": "Free access",
     "description": "Set to 'yes' if the full text is freely/openly accessible.",
     "type": "string",
     "required": false,
     "suggested values": ["yes"]
   }
 },
 "format": "inline"

} </templatedata>

The above documentation is transcluded from Template:Doi/doc. (edit