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

From blackwiki
Jump to navigation Jump to search
imported>Fullstop
imported>Fullstop
m (m title)
Line 1: Line 1:
#REDIRECT [[Template:Citation/make link/doc]]
+
{{Documentation subpage}}
 +
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 +
 
 +
This template (<code><nowiki>{{Citation/make_link}}</nowiki></code>) is a "subroutine" of <code>{{tl|Citation/core}}</code>. It is used for conditionally making links for the <code>chapter=</code> and <code>title=</code> fields in a citation.
 +
 
 +
It is invoked as
 +
: <tt><nowiki>{{citation/link </nowiki> </tt>
 +
::  | <tt>1</tt> = ''<value of ''<tt>IncludedWorkURL=</tt>'' or ''<tt>URL=</tt>'' or ''<tt>PMC=</tt>'' parameters>''
 +
::  | <tt>2</tt> = ''<value of ''<tt>IncludedWorkTitle=</tt>'' or ''<tt>Title=</tt>'' parameters>''
 +
: <tt><nowiki>}}</nowiki></tt>
 +
 
 +
Depending on the value of the first parameter, it then returns one of the following:
 +
: 1. if parameter #1 is empty or "none", it returns the second parameter as plain text
 +
: 2. if parameter #1 is an external url, it returns an external link-ified form of parameter #2
 +
: 3. default: treats parameter #1 as the name of an existing article, and so returns an internal link form of parameter #2
 +
 
 +
This "subroutine" is not suitable for general use. It makes certain assumptions that are probably only valid as used by <nowiki>{{citation/core}}</nowiki>.
 +
 
 +
 
 +
<includeonly>
 +
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 +
</includeonly>

Revision as of 18:54, 25 July 2009

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

It is invoked as

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

Depending on the value of the first parameter, it then returns one of the following:

1. if parameter #1 is empty or "none", it returns the second parameter as plain text
2. if parameter #1 is an external url, it returns an external link-ified form of parameter #2
3. default: treats parameter #1 as the name of an existing article, and so returns an internal link form of parameter #2

This "subroutine" is not suitable for general use. It makes certain assumptions that are probably only valid as used by {{citation/core}}.