Difference between revisions of "Template:Citation/make link/doc"

From blackwiki
Jump to navigation Jump to search
imported>Eubulides
(Revamp so that it's a bit easier to follow. Add examples.)
imported>Eubulides
(Document the more-conservative behavior.)
Line 11: Line 11:
  
 
It uses the following algorithm:
 
It uses the following algorithm:
# If the first parameter is empty or "<code>none</code>", it returns the second parameter as plain text.
+
# If the first parameter is empty, it returns the second parameter as plain text.
 
# If the first parameter is a URL, it returns the second parameter wrapped inside an external link to the first.
 
# If the first parameter is a URL, it returns the second parameter wrapped inside an external link to the first.
# Otherwise, it assumes the first parameter is an article name, and returns the second parameter wrapped inside a wikilink to the first.
 
  
This "subroutine" is designed for {{tl|Citation/core}} and makes assumptions that are probably not valid elsewhere.
+
This "subroutine" is designed for {{tl|Citation/core}} and makes assumptions that may not be valid elsewhere.
  
 
Examples:
 
Examples:
 
* "<code><nowiki>{{Citation/make link||BBC News front page}}</nowiki></code>" produces "{{Citation/make link||BBC News front page}}".
 
* "<code><nowiki>{{Citation/make link||BBC News front page}}</nowiki></code>" produces "{{Citation/make link||BBC News front page}}".
* "<code><nowiki>{{Citation/make link|none|BBC News front page}}</nowiki></code>" produces "{{Citation/make link|none|BBC News front page}}".
 
 
* "<code><nowiki>{{Citation/make link|http://news.bbc.co.uk/|BBC News front page}}</nowiki></code>" produces "{{Citation/make link|http://news.bbc.co.uk/|BBC News front page}}".
 
* "<code><nowiki>{{Citation/make link|http://news.bbc.co.uk/|BBC News front page}}</nowiki></code>" produces "{{Citation/make link|http://news.bbc.co.uk/|BBC News front page}}".
* "<code><nowiki>{{Citation/make link|BBC News Online|BBC News front page}}</nowiki></code>" produces "{{Citation/make link|BBC News Online|BBC News front page}}".
 
  
 
<includeonly>
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
</includeonly>
 
</includeonly>

Revision as of 03:35, 10 August 2009

This template is a "subroutine" of {{Citation/core}} used for conditionally making links for the chapter= and title= fields in a citation.

It is invoked as:

{{Citation/make link
| 1 = <value of IncludedWorkURL= or URL= or PMC= parameters>
| 2 = <value of IncludedWorkTitle= or Title= parameters>
}}

It uses the following algorithm:

  1. If the first parameter is empty, it returns the second parameter as plain text.
  2. If the first parameter is a URL, it returns the second parameter wrapped inside an external link to the first.

This "subroutine" is designed for {{Citation/core}} and makes assumptions that may not be valid elsewhere.

Examples:

  • "{{Citation/make link||BBC News front page}}" produces "BBC News front page".
  • "{{Citation/make link|http://news.bbc.co.uk/|BBC News front page}}" produces "BBC News front page".