View source for Template:PlanetMath reference/doc

{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->

This template is for adding a reference to an article in [[PlanetMath]], a free community encyclopedia of mathematics.

== Usage ==
Suppose you want to add a reference to PlanetMath's [http://planetmath.org/QuotientRing article on quotient rings]. The title of this article is "quotient ring".
Go to PlanetMath to figure out the required URL name, in this case `QuotientRing`, and use it as the `urlname` parameter value.

On the PlanetMath page, besides in the URL itself, you can find the required urlname value at the bottom of the page, under `Canonical name`.
If you know only an approximate title, you can also search for it on https://planetmath.org/msc.html .

The code

<nowiki>
* {{PlanetMath reference|urlname=QuotientRing|title=Quotient ring}}
</nowiki>

will produce the link
* {{PlanetMath reference|urlname=QuotientRing|title=Quotient ring}}

PlanetMath used to use so-called object ids, but as of 2021-12-24 does not support these any more.
For example, the object id of the "quotient ring" article used to be 470.
Below the article, a list of attributes still gives a "numerical id", 18 in the "quotient ring" example.
Apparently this numerical ID has no relationship to the old ID value.
If this is correct, the "numeric id" can not be used to get existing id-style references on Wikipedia working again.
This template still supports the id parameter, in the unchanged form that no longer works.

There are optional <code>author</code>, <code>version</code> and <code>accessdate</code> parameters 

<nowiki>
* {{PlanetMath reference|urlname=QuotientRing|title=Quotient ring|author= David Jao| version=13 | accessdate=14 April 2012}}
</nowiki>

will produce
* {{PlanetMath reference|urlname=QuotientRing|title=Quotient ring|author= David Jao| version=13 | accessdate=14 April 2012}}

==TemplateData==
{{TemplateDataHeader}}

<templatedata>
{
	"params": {
		"urlname": {
			"label": "Canonical name of PlanetMath page",
			"description": "Canonical name as given in table on bottom of targeted PlanetMath page",
			"example": "QuotientRing",
			"type": "string",
			"autovalue": "AsGivenNearBottomOfPlanetMathPage",
			"required": true
		},
		"id": {
			"description": "Deprecated. Former numerical PlanetMath page ID. Used to form the PlanetMath page URL.",
			"example": "5815",
			"type": "number",
			"deprecated": "Use `urlname` instead. Ignored if urlname was given.",
			"label": "old PlanetMath id"
		},
		"title": {
			"aliases": [
				"2"
			],
			"label": "Title",
			"description": "Human-readable title, the way it should appear in the Wikipedia article.",
			"example": "Quotient ring",
			"type": "string",
			"suggested": true
		},
		"version": {
			"label": "PlanetMath version",
			"description": "If given, added after link to PlanetMath. Used to refer to a PlanetMath revision. It was necessary to form a complete PlanetMath URL. However, at the user level, the revision concept does not seem to exist any more. In particular, the revision is no longer needed to form the URL.",
			"example": "13",
			"type": "number",
			"deprecated": "Ignored if urlname is given."
		},
		"author": {
			"label": "PlanetMath author",
			"description": "If given, shown before the content link. Main author of PlanetMath article, as given near bottom of PlanetMath page.",
			"example": "mathwiz",
			"type": "string"
		},
		"access-date": {
			"aliases": [
				"accessdate"
			],
			"label": "Access date",
			"description": "Date of last successful access to the PlanetMath page. If given, shown at end of entry.",
			"example": "2021-12-23",
			"type": "date",
			"autovalue": "YYYY-mm-DD"
		}
	},
	"description": "A reference to a PlanetMath page.",
	"format": "inline",
	"paramOrder": [
		"urlname",
		"id",
		"title",
		"version",
		"author",
		"access-date"
	]
}
</templatedata>

== See also ==
* {{tl|PlanetMath}}
* {{tl|PlanetMath attribution}}

<includeonly>{{Sandbox other||
<!-- Categories and interwikis go here: -->
[[Category:Mathematics source templates|PlanetMath]]

}}</includeonly>