Difference between revisions of "Template:Cfb link/doc"

From blackwiki
Jump to navigation Jump to search
imported>Colonies Chris
imported>Brainulator9
m (removing note about interwiki links; leftover from pre-Wikidata ILL days)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
 
{{expensive}}
 
{{expensive}}
  
Line 15: Line 15:
 
==Use of this template==
 
==Use of this template==
  
Due to restrictions on use of #ifexist, it is important to not use this template if it isn't needed.  In other words, if the link already exists, just link to it.  [[:Category:Excessive uses of cfb link]] contains a list of occasions where this template is used and doesn't need to be.
+
Due to restrictions on use of #ifexist, it is important to not use this template if it isn't needed.  In other words, if the link already exists, just link to it.  [[:Category:Excessive uses of cfb link]] contains a list of occasions where this template is used and doesn't need to be. [[User:AnomieBOT|A bot]] will soon replace this template with the specific link on articles in that category.
  
 
Please do not use this template on disambiguation pages (dab pages) due to [[Mos:dab#Individual entries|requirements for links on dab pages]].
 
Please do not use this template on disambiguation pages (dab pages) due to [[Mos:dab#Individual entries|requirements for links on dab pages]].
Line 62: Line 62:
 
| {{cfb link|year=2008|team=Utah Utes}}
 
| {{cfb link|year=2008|team=Utah Utes}}
 
|}
 
|}
 +
 +
==TemplateData==
 +
{{TemplateData header}}
 +
<templatedata>
 +
{
 +
"params": {
 +
"year": {
 +
"label": "Year",
 +
"description": "Can be used to attempt a link to the yearly page of a team",
 +
"example": "2035",
 +
"type": "number"
 +
},
 +
"team": {
 +
"label": "Team",
 +
"description": "The athletics program article for this school",
 +
"example": "Virginia Tech Hokies",
 +
"type": "wiki-page-name",
 +
"required": true
 +
},
 +
"title": {
 +
"label": "Title",
 +
"description": "The display name for this link. Usually, this will be the common name for the school (without \"university\")",
 +
"example": "Virginia Tech",
 +
"type": "string"
 +
},
 +
"school": {
 +
"label": "School",
 +
"description": "The main article for this school",
 +
"example": "Virginia Polytechnic Institute and State University",
 +
"type": "wiki-page-name",
 +
"required": true
 +
}
 +
},
 +
"description": "This template allows linking to a college football team page that may not yet exist. It will display the best available link. Please do not use this template unless absolutely necessary, due to restrictions on use of #ifexist. In other words, if the link already exists, just link to it.",
 +
"paramOrder": [
 +
"year",
 +
"team",
 +
"school",
 +
"title"
 +
],
 +
"format": "inline"
 +
}
 +
</templatedata>
  
 
==See also==
 
==See also==
Line 68: Line 111:
 
* {{tl|CBSB link}}
 
* {{tl|CBSB link}}
  
<includeonly>
+
<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
<!-- CATEGORIES HERE, THANKS -->
 
[[Category:Internal link templates]]
 
[[Category:Internal link templates]]
 
[[Category:American college football templates]]
 
[[Category:American college football templates]]
</includeonly>
+
}}</includeonly>

Latest revision as of 18:33, 24 November 2020

{{Cfb link}} allows linking to a college football team page that may not yet exist. It will display the best available link.

For example, if I want to link to the article about the 2020 Richmond Spiders football team that may or may not exist, I would make this call:

{{cfb link|year=2020|team=Richmond Spiders|school=University of Richmond|title=Richmond}}

This would yield: Richmond

Important - whitespace cannot be included or it will be added to the wiki link and it will not function properly.

Use of this template

Due to restrictions on use of #ifexist, it is important to not use this template if it isn't needed. In other words, if the link already exists, just link to it. Category:Excessive uses of cfb link contains a list of occasions where this template is used and doesn't need to be. A bot will soon replace this template with the specific link on articles in that category.

Please do not use this template on disambiguation pages (dab pages) due to requirements for links on dab pages.

Naming conventions

In order for this template to work, articles MUST be named correctly. The football naming convention is:

Parameters

parameter meaning
year (optional) Supply a year if you want to link to the yearly page, e.g., 2007 Virginia Tech Hokies football team
team The athletics program article for this school, e.g., Virginia Tech Hokies, Wake Forest Demon Deacons, Miami Hurricanes
school The main article for this school, e.g., Florida State University, University of Virginia
title (optional) The display name for this link. Usually, this will be the common name for the school (without "university"), like Duke, Florida State, Virginia Tech, etc. If left blank, the link will be non-piped, i.e., it will display the name of the article linked to.

Examples

{{cfb link|year=2099|team=Virginia Tech Hokies|school=Virginia Polytechnic Institute and State University|title=Virginia Tech}} Virginia Tech
{{cfb link|year=2006|team=Virginia Tech Hokies|school=Virginia Polytechnic Institute and State University|title=Virginia Tech}} Virginia Tech
{{cfb link|team=Florida State Seminoles|school=Florida State University|title=FSU}} FSU
{{cfb link|year=2008|team=Utah Utes}} [[{{{school}}}]]

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Cfb link

This template allows linking to a college football team page that may not yet exist. It will display the best available link. Please do not use this template unless absolutely necessary, due to restrictions on use of #ifexist. In other words, if the link already exists, just link to it.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Yearyear

Can be used to attempt a link to the yearly page of a team

Example
2035
Numberoptional
Teamteam

The athletics program article for this school

Example
Virginia Tech Hokies
Pagerequired
Schoolschool

The main article for this school

Example
Virginia Polytechnic Institute and State University
Pagerequired
Titletitle

The display name for this link. Usually, this will be the common name for the school (without "university")

Example
Virginia Tech
Stringoptional

See also