Template:Link/Desc/Doc - Revision history

Brett Wuth at 16:01, 14 July 2017

2017-07-14T16:01:17Z

←Older revision		Revision as of 16:01, 14 July 2017
Line 15:		Line 15:
	}}		}}

		+	It is also commonly used to provide links to file descriptor pages.
		+	See [[Help:Linking to files]].
		+	{{demo table\|
		+	{{demo row\|<nowiki>{{link\|Image:Demo Sunflower.png}}</nowiki>\|<!--
		+	-->{{link\|Image:Demo Sunflower.png}} }}
		+	}}
		+
		+
	<code>{{((}}link{{))}}</code>		<code>{{((}}link{{))}}</code>
	is an alternative shortened name for		is an alternative shortened name for

Brett Wuth at 17:37, 7 April 2016

2016-04-07T17:37:35Z

←Older revision		Revision as of 17:37, 7 April 2016
Line 1:		Line 1:
	{{Template:Link/Doc/Related}}		{{Template:Link/Doc/Related}}
		+	This template creates a link to another wiki page.
		+	== Common usage ==
		+	Most commonly this template is called as
		+	<code>{{((}}link\|Page{{))}}</code>.
		+	In the form
		+	<code>{{((}}link\|Page\|Text{{))}}</code>
		+	it creates a link to Page but displays the link as Text.
		+
		+	{{demo table\|
		+	{{demo row\|<nowiki>{{link\|Main Page}}</nowiki>\|<!--
		+	-->{{link\|Main Page}} }}
		+	{{demo row\|<nowiki>{{link\|Main Page\|see this page}}</nowiki>\|<!--
		+	-->{{link\|Main Page\|see this page}} }}
		+	}}
		+
		+	<code>{{((}}link{{))}}</code>
		+	is an alternative shortened name for
		+	<code>{{((}}Link/Desc{{))}}</code>.
		+	Either can be used.
		+
		+	== Features ==
		+	This template is similar to creating a link with double square brackets:
		+	<code><nowiki>[[Page]]</nowiki></code>.
		+
		+	Double square brackets requires extra decoration with a leading colon when the page
		+	is an <code>Image:</code>, <code>File:</code> or <code>Category:</code>.
		+	This template handles those types of pages without any extra work; no leading colon is necessary.
		+
		+	If no Text is provided, the link is shown as the Page name.
		+	For subpages (e.g. <code>Main Topic/subtopic</code>)
		+	the link text is just the subtopic.
		+
		+	The page can have a description and that description will be displayed as the text of the link.
		+	The description is taken from the [[Property:Page description]]
		+	which can be set using [[Template:desc]], etc.
		+
		+	The link can lead to a previous version of a wiki page, using the parameter RevisionID.
		+
		+	For multipage PDF's the link can lead to a specific page, using the parameter PageNum.
		+
		+	As [[Template:Link/Create]] or [[Template:Link/Create+Desc]], links to pages that don't exist yet can specify default text for their creation.
		+
		+	== Parameters ==
	{{Template doc\|<nowiki>Page\|RevisionID=id\|PageNum=number\|Text\|Desc=description</nowiki>}}		{{Template doc\|<nowiki>Page\|RevisionID=id\|PageNum=number\|Text\|Desc=description</nowiki>}}
-	~~is used to create a link to a page.~~	+	uses the following parameters:

	; Page : the page to link to		; Page : the page to link to
Line 8:		Line 51:
	; Text : (optional) the text to display as the link		; Text : (optional) the text to display as the link
	; Desc : (optional) the text to display as the link if the page does not have a description and ''Text'' is not supplied. There is no point to specifying both ''Text'' and ''Desc''.		; Desc : (optional) the text to display as the link if the page does not have a description and ''Text'' is not supplied. There is no point to specifying both ''Text'' and ''Desc''.
-		+	== Examples ==
-	~~This template's purpose is very similar to creating links with double square brackets.~~	+
-	~~The benefit of using <code>{{((}}Link/Desc\|</code>~~	+
-	~~is that, the page itself may specify a description using [[Template:desc]], etc.~~	+
-	~~(Using the [[Property:Page description]].)~~	+
-	~~That description can be displayed as the link text.~~	+
-	~~Just like with double square brackets, if you have preferred text for the link, you can provide it.~~	+
-	~~While ''Text'' is higher priority than the page's own description,~~	+
-	~~''Desc'' is lower priority.~~	+
-		+
	For illustration purpose, the following demonstration pages have been set up:		For illustration purpose, the following demonstration pages have been set up:
	* "[[Demo/Page with description]]" uses [[Template:desc]] to define a description.		* "[[Demo/Page with description]]" uses [[Template:desc]] to define a description.

Brett Wuth: /* Implementation */

2015-09-18T06:06:21Z

Implementation

←Older revision		Revision as of 06:06, 18 September 2015
Line 78:		Line 78:
	* [[Template:Link/Desc/CoreText]]		* [[Template:Link/Desc/CoreText]]
	Icons:		Icons:
-	* {{link\|~~File~~:Calendar-miniscule-icon.png}}	+	* {{link\|Image:Calendar-miniscule-icon.png}}

Brett Wuth at 05:58, 18 September 2015

2015-09-18T05:58:15Z

←Older revision		Revision as of 05:58, 18 September 2015
Line 1:		Line 1:
	{{Template:Link/Doc/Related}}		{{Template:Link/Doc/Related}}
-	{{Template ~~Doc~~\|<nowiki>Page\|Text\|Desc=description</nowiki>}}	+	{{Template doc\|<nowiki>Page\|RevisionID=id\|PageNum=number\|Text\|Desc=description</nowiki>}}
	is used to create a link to a page.		is used to create a link to a page.

	; Page : the page to link to		; Page : the page to link to
		+	; RevisionID : (optional) The revision to link to. This is used to link to an old version of an existing page. Revision ID's can be found on the "history" tab of the page in question, as "oldid". Revision ID's are unique across all pages, so the Revision ID also specifies the Page. If the Revision ID is provided, the Page does not need to be specified unless it is to provide the link text.
		+	; PageNum : (optional) if Page is a file that supports multiple internal pages, this parameter will link to the specified internal page
	; Text : (optional) the text to display as the link		; Text : (optional) the text to display as the link
-	; Desc : (optional) the text to display as the link if the page does not description and ''Text'' is not supplied. There is no point to specifying both ''Text'' and ''Desc''.	+	; Desc : (optional) the text to display as the link if the page does not have a description and ''Text'' is not supplied. There is no point to specifying both ''Text'' and ''Desc''.

	This template's purpose is very similar to creating links with double square brackets.		This template's purpose is very similar to creating links with double square brackets.
-	The benefit of using <code>{{((}}~~link~~\|</code>	+	The benefit of using <code>{{((}}Link/Desc\|</code>
	is that, the page itself may specify a description using [[Template:desc]], etc.		is that, the page itself may specify a description using [[Template:desc]], etc.
		+	(Using the [[Property:Page description]].)
	That description can be displayed as the link text.		That description can be displayed as the link text.
	Just like with double square brackets, if you have preferred text for the link, you can provide it.		Just like with double square brackets, if you have preferred text for the link, you can provide it.
Line 41:		Line 44:


-	Using ''Desc:''	+	Using <code>Desc</code>:
	{{demo table\|		{{demo table\|
	{{demo row\|<nowiki>{{Link/Desc\|Demo/Page with description\|Desc=this page}}</nowiki>\|<!--		{{demo row\|<nowiki>{{Link/Desc\|Demo/Page with description\|Desc=this page}}</nowiki>\|<!--
Line 51:		Line 54:
	{{demo row\|<nowiki>{{Link/Desc\|Demo/Page without description\|That Page\|Desc=this page}}</nowiki>\|<!--		{{demo row\|<nowiki>{{Link/Desc\|Demo/Page without description\|That Page\|Desc=this page}}</nowiki>\|<!--
	-->{{Link/Desc\|Demo/Page without description\|That Page\|Desc=this page}} }}		-->{{Link/Desc\|Demo/Page without description\|That Page\|Desc=this page}} }}
		+	}}
		+
		+	Using <code>RevisionID</code>:
		+	{{demo table\|
		+	{{demo row\|<nowiki>{{Link/Desc\|RevisionID=1}}</nowiki>\|<!--
		+	-->{{Link/Desc\|RevisionID=1}} }}
		+	{{demo row\|<nowiki>{{Link/Desc\|Main Page\|RevisionID=1}}</nowiki>\|<!--
		+	-->{{Link/Desc\|Main Page\|RevisionID=1}} }}
		+	{{demo row\|<nowiki>{{Link/Desc\|Main Page\|main\|RevisionID=1}}</nowiki>\|<!--
		+	-->{{Link/Desc\|Main Page\|main\|RevisionID=1}} }}
		+	}}
		+
		+	Using <code>PageNum</code>:
		+	{{demo table\|
		+	{{demo row\|<nowiki>{{Link/Desc\|Main Page\|PageNum=2}}</nowiki>\|<!--
		+	-->{{Link/Desc\|Main Page\|PageNum=2}} }}
	}}		}}

Line 56:		Line 75:
	Helper templates:		Helper templates:
	* [[Template:Link/Desc/Text]]		* [[Template:Link/Desc/Text]]
		+	* [[Template:Link/Desc/Core]]
		+	* [[Template:Link/Desc/CoreText]]
		+	Icons:
		+	* {{link\|File:Calendar-miniscule-icon.png}}

Brett Wuth: New page: {{Template:Link/Doc/Related}} {{Template Doc|Page|Text|Desc=description}} is used to create a link to a page. ; Page : the page to link to ; Text : (optional) the text to...

2012-07-18T06:24:33Z

New page: {{Template:Link/Doc/Related}} {{Template Doc|<nowiki>Page|Text|Desc=description</nowiki>}} is used to create a link to a page. ; Page : the page to link to ; Text : (optional) the text to...

New page

{{Template:Link/Doc/Related}}
{{Template Doc|<nowiki>Page|Text|Desc=description</nowiki>}}
is used to create a link to a page.

; Page : the page to link to
; Text : (optional) the text to display as the link
; Desc : (optional) the text to display as the link if the page does not description and ''Text'' is not supplied. There is no point to specifying both ''Text'' and ''Desc''.

This template's purpose is very similar to creating links with double square brackets.
The benefit of using <code>{{((}}link|</code>
is that, the page itself may specify a description using [[Template:desc]], etc.
That description can be displayed as the link text.
Just like with double square brackets, if you have preferred text for the link, you can provide it.
While ''Text'' is higher priority than the page's own description,
''Desc'' is lower priority.

For illustration purpose, the following demonstration pages have been set up:
* "[[Demo/Page with description]]" uses [[Template:desc]] to define a description.
* "[[Demo/Page without description]]" doesn't use [[Template:desc]] and doesn't have a description.

{{demo table|
{{demo row|<nowiki>{{Link/Desc|Demo/Page with description}}</nowiki>|{{Link/Desc|Demo/Page with description}} }}
{{demo row|<nowiki>{{Link/Desc|Demo/Page without description}}</nowiki>|{{Link/Desc|Demo/Page without description}} }}
{{demo row|<nowiki>{{Link/Desc|Demo/Page with description|this page}}</nowiki>|{{Link/Desc|Demo/Page with description|this page}} }}
{{demo row|<nowiki>{{Link/Desc|Demo/Page without description|this page}}</nowiki>|{{Link/Desc|Demo/Page without description|this page}} }}
}}

Here's how it would work if you had used square brackets instead.
(The difference between this table and the previous one is only in the first case.)
{{demo table|
{{demo row|[[Demo/Page with description]]}}
{{demo row|[[Demo/Page without description]]}}
{{demo row|[[Demo/Page with description|this page]]}}
{{demo row|[[Demo/Page without description|this page]]}}
}}

Using ''Desc:''
{{demo table|
{{demo row|<nowiki>{{Link/Desc|Demo/Page with description|Desc=this page}}</nowiki>|{{Link/Desc|Demo/Page with description|Desc=this page}} }}
{{demo row|<nowiki>{{Link/Desc|Demo/Page without description|Desc=this page}}</nowiki>|{{Link/Desc|Demo/Page without description|Desc=this page}} }}
{{demo row|<nowiki>{{Link/Desc|Demo/Page with description|That Page|Desc=this page}}</nowiki>|{{Link/Desc|Demo/Page with description|That Page|Desc=this page}} }}
{{demo row|<nowiki>{{Link/Desc|Demo/Page without description|That Page|Desc=this page}}</nowiki>|{{Link/Desc|Demo/Page without description|That Page|Desc=this page}} }}
}}

== Implementation ==
Helper templates:
* [[Template:Link/Desc/Text]]