View source for Template:Find sources multi/doc

{{Documentation subpage}}
{{template shortcut|fsmulti}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

This is a meta-template for "find sources" templates. It is usually called from another template, but can be used on its own as well. It produces a series of links to various search interfaces to help find additional sources for articles. Using this meta-template has the advantage that if a search engine changes its parameters, it is only necessary to fix this one template rather than individual fixes to all the different source-finding templates. The syntax is also very flexible, allowing for a wide range of styles of daughter template, and it is possible to create new subtemplates to add additional search engines without altering the main template code.

This template, and other templates that are based on it, should not usually be used in articles themselves - see [[Wikipedia:EL#Links normally to be avoided]].

== Usage ==

=== Search values ===

No matter what invocation is used, the searching works in the same way. The first parameter is main search term, which will be treated as a [[literal string]] if multi-part (e.g. <code>Albert Einstein</code> will be searched as the single string "Albert Einstein" not "Albert" and "Einstein" separately).

Optional subsequent parameters (up to 4) are additional search terms. They can be enclosed in double quotation marks, preceded by an unspaced <code>-</code> (hyphen) to exclude them from the search results, or both (e.g. <code>-"Marilyn Monroe"</code> to exclude matches containing the phrase "Marilyn Monroe", but not either name by itself, from the search results).  You do ''not'' need to add <code>-wikipedia</code>, as the template automatically does this for you. Also, there is usually no need to add words in plural form unless irregular, as most search interfaces will match (for example) ''billiards'' as well given a search term of ''billiard''.

If no parameters are given, the name of the article is passed as the search string. Note that this may or may not be desirable with disambiguated article names (if the Wikipedia disambiguator is sensible, however, it may actually help refine the search results).

=== Search engine links ===

Search engine links are provided by the parameters <code>link1</code>, <code>link2</code>, <code>link3</code> ... <code>link20</code>. These parameters may take the values <code>g</code>, <code>gbooks</code>, <code>gscholar</code>, <code>jstor</code>, <code>gfreeimages</code>, <code>archive</code>, <code>bing</code>, <code>gnewsrecent</code>, <code>nyt</code>, <code>wrs</code>, or <code>ddg</code>. The code <code>gnews</code> is also available, but it is [//en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_%28miscellaneous%29&oldid=586050946#Google_news_archive_search.3F not working] as of December 2013. See [[#Link codes]] for the full list.

=== Simple usage ===

<pre>{{find sources multi|<!-- search term -->|link1=<!-- search engine code 1 -->|link2=<!-- search engine code 2 -->}}</pre>

For example, the code:

{{tlx|1=find sources multi|2=Example|3=link1=g|4=link2=gbooks}}

Will produce:

{{find sources multi|Example|link1=g|link2=gbooks}}

=== Usage in templates ===

<pre>{{find sources multi<noinclude>/template</noinclude>
|class          = <!-- sets the span class -->
|style          = <!-- custom css style -->
|inarticle      = <!-- set to "yes" if the template is to be used in articles -->

|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}

|introtext      = <!-- unlinked text that appears at the start of the template output -->
|introlink      = <!-- search engine link code for a link after the intro text but before the other links -->
|introdisplay   = <!-- text displayed for the intro link; the default value is the term searched for -->
|introseparator = <!-- unlinked text that appears after the intro link and before the other links -->

<!-- |separator =      custom separator value; if this is not used, the whole parameter should be removed -->

|link1          = <!-- search engine code for the first link -->
|display1       = <!-- display value for the first link -->
|link2          = <!-- search engine code for the second link -->
|display2       = <!-- display value for the second link -->
<!-- ... -->
|link20         = 
|display20      = 

|free           = {{{free|}}}

|endseparator   = <!-- unlinked text that appears after the last link but before the closing span tag -->

<noinclude>
|doc            = <!-- set to "yes" to use the automatically generated documentation -->
</noinclude>
}}</pre>

To create a template based on find sources multi, copy the code above and experiment with the parameters until it looks how you want it to. Make sure that you keep the top line as it is - the code on the top line allows the template to use {{tl|find sources multi/template}} on the template page, but {{tl|find sources multi}} everywhere else.

{{tl|Find sources multi/template}} has a few special features that distinguish it from the main {{tl|find sources multi}} template. First, it sets the search text in any links used to "Example", rather than the default of the current subpage. Second, it allows automatic checking of the link codes used in the template. If any of the codes do not exist, the template will generate an error message. Third, it can generate documentation for the template automatically. If you want to use the automatic documentation, set {{para|doc|yes}} - the documentation itself is generated by {{tl|find sources multi/doc/template}}.

If you want to add a shortcut to your template, you can specify it at {{tl|find sources multi/doc/template}}, and any additional categories or instructions can be added to the /doc subpage as normal. If further customisation is desired, the template can be substituted - [[Template:Find sources multi/doc/template#Substitution|see here]] for instructions.

== Parameters ==

{| class="wikitable"
|-
! Parameter name !! Example values !! Required !! Description
|-
| <code>class</code> || <code>smallcaps</code> || no || Custom class values. The template already uses the "plainlinks" class by default; any other classes will be used in addition to this.
|-
| <code>style</code> || <code>font-variant: small-caps;</code> || no || Custom CSS styles. The template doesn't use any default styles. 
|-
| unnamed parameter 1 || <code><nowiki>{{{1|}}}</nowiki></code> || no || The first search term. This will be placed inside quotation marks in the search. If this parameter is left out, the name of the current subpage is used instead.
|-
| unnamed parameters 2-5 || <code><nowiki>{{{2|}}}</nowiki></code>, <code><nowiki>{{{3|}}}</nowiki></code>, etc. || no || The other search terms. These will included in the search without quotation marks.
|-
| <code>introtext</code> || <code><nowiki>''Find sources:''&amp;nbsp;</nowiki></code> || no || Unlinked text that appears at the start of the template output. If a space is desired at the end of this text it must be specified with &amp;nbsp; - other whitespace will be trimmed off.
|-
| <code>introlink</code> || <code>gbooks</code> || no || The search engine link code for the intro link. This link comes after the intro text but before the other links.
|-
| <code>introdisplay</code> || <code>Google</code> || no || The text displayed for the intro link. The default value is the term searched for.
|-
| <code>introseparator</code> || <code>&amp;nbsp;-&amp;nbsp;</code> || no || Unlinked text displayed between the intro link and the first link. If spaces are desired they must be specified with <code>&amp;nbsp;</code> - other whitespace will be trimmed off.
|-
| <code>link1</code> || <code>gbooks</code> || '''yes''' || The search engine link code for the first link.
|-
| <code>link2</code>, <code>link3</code> ... <code>link20</code> || <code>gscholar</code> || no || The search engine link codes for the other links. Up to 20 links (plus the intro link) are allowed.
|-
| <code>display1</code>, <code>display3</code> ... <code>display20</code> || <code>Books</code> || no || The text displayed for the links. These default to descriptive values such as "Google Books", "Archive.org", etc. The default display values are set by the individual subtemplates - see [[#Link codes]] for the full list.
|-
| <code>free</code> || <code><nowiki>{{{free|}}}</nowiki></code> || no || If {{para|free|yes}} then only free (as in beer) results are returned for Google News. If your template uses a Google News search then you should probably pass this parameter through so that end users can set it as desired. If your template doesn't use Google News then you can leave this parameter out. {{red|1=Note: Google News search [//en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_%28miscellaneous%29&oldid=586050946#Google_news_archive_search.3F does not work] as of December 2013.}}
|-
| <code>separator</code> || <code>,&amp;nbsp;</code> || no || This specifies a custom search link separator. It is unlinked text that goes between the links generated by the <code>linkX</code> parameters. If whitespace is desired it must be specified with <code>&amp;nbsp;</code> - other whitespace will be trimmed off. The default value is <code><nowiki>{{int:dot-separator}}</nowiki></code> (displays as {{int:dot-separator}}). If this parameter is not used, the parameter name must be completely removed from the template, otherwise an error message is generated. (This is due to limitations in MediaWiki's whitespace handling for templates.)
|-
| <code>endseparator</code> || <code>.</code> || no || Unlinked text displayed after the last search link. If spaces are desired they must be specified with <code>&amp;nbsp;</code> - other whitespace will be trimmed off.
|-
| <code>inarticle</code> || <code>yes</code> || no || If the template is designed to be used in articles, set this to "yes". If this parameter is not set and the template is used in the main namespace, it will generate an error message.
|-
| <code>doc</code> || <code>yes</code> || no || This is used only on template pages themselves, through {{tl|find sources multi/template}}. If {{para|doc|yes}}, the template will generate documentation for your template automatically.
|-
| <code>demo</code> || <code>yes</code> || no || This suppresses [[:Category:Source-finding templates]] for examples that use {{tl|find sources multi/template}}.
|}

=== Link codes ===

Here is a list of currently supported values for the link parameters (up to 20 may be specified):
{{find sources multi/doc/linktable}}

== Examples ==

=== Without documentation or self-checks ===

;Code

{{cot|Template code}}
<pre>{{find sources multi
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&amp;nbsp;
|introlink      = g
|introseparator = &amp;nbsp;-&amp;nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = JSTOR
|link4         = gfreeimages
|display4       = free images
|free           = {{{free|}}}
}}</pre>
{{cob}}

;Output

{{find sources multi
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&nbsp;
|introlink      = g
|introseparator = &nbsp;-&nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = JSTOR
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
}}

=== With self-checks but no documentation ===

;Code

{{cot|Template code}}
<pre>{{find sources multi<noinclude>/template</noinclude>
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&amp;nbsp;
|introlink      = g
|introseparator = &amp;nbsp;-&amp;nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = JSTOR
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
}}</pre>
{{cob}}

;Output

{{find sources multi/template
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&nbsp;
|introlink      = g
|introseparator = &nbsp;-&nbsp;
|link1           = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = JSTOR
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
|demo           = yes
}}

=== With self-checks and documentation ===

(You need to visit the [[Template:Find sources multi/doc#With self-checks and documentation|/doc subpage]] to see this working properly.)

;Code

{{cot|Template code}}
<pre>{{find sources multi<noinclude>/template</noinclude>
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&amp;nbsp;
|introlink      = g
|introseparator = &amp;nbsp;-&amp;nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = JSTOR
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
<noinclude>
|doc            = yes
</noinclude>
}}</pre>
{{cob}}

;Output

{{find sources multi<noinclude>/template</noinclude>
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&nbsp;
|introlink      = g
|introseparator = &nbsp;-&nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = JSTOR
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
<noinclude>
|doc            = yes
|demo           = yes
</noinclude>
}}

=== Smallcaps style ===

;Code

{{cot|Template code}}
<pre>{{find sources multi
|class          = smallcaps
|style          = font-variant: small-caps;
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&amp;nbsp;
|introlink      = g
|introseparator = &amp;nbsp;-&amp;nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = jstor
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
}}</pre>
{{cob}}

;Output

{{find sources multi
|class          = smallcaps
|style          = font-variant: small-caps;
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&nbsp;
|introlink      = g
|introseparator = &nbsp;-&nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = jstor
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
}}

=== Custom separator ===

;Code

{{cot|Template code}}
<pre>{{find sources multi
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&amp;nbsp;
|introlink      = g
|introseparator = &amp;nbsp;-&amp;nbsp;
|separator      = ,&amp;nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = jstor
|link4          = gfreeimages
|display4      = free images
|free           = {{{free|}}}
}}</pre>
{{cob}}

;Output

{{find sources multi
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources:&nbsp;
|introlink      = g
|introseparator = &nbsp;-&nbsp;
|separator      = ,&nbsp;
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = jstor
|link4          = gfreeimages
|display4       = free images
|free           = {{{free|}}}
}}

=== Bulleted list ===

;Code

{{cot|Template code}}
<pre>{{find sources multi
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources for&amp;nbsp;
|introlink      = g
|introseparator = :<ul><li>
|separator      = </li><li>
|link1         = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = jstor
|link4          = gfreeimages
|display4       = free images
|endseparator   = </li></ul>
|free           = {{{free|}}}
}}</pre>
{{cob}}

{{find sources multi
|1              = {{{1|}}}
|2              = {{{2|}}}
|3              = {{{3|}}}
|4              = {{{4|}}}
|5              = {{{5|}}}
|introtext      = Find sources for&nbsp;
|introlink      = g
|introseparator = :<ul><li>
|separator      = </li><li>
|link1          = gbooks
|display1       = books
|link2          = gscholar
|display2       = scholar
|link3          = jstor
|display3       = jstor
|link4          = gfreeimages
|display4       = free images
|endseparator   = </li></ul>
|free           = {{{free|}}}
}}

== Adding new search subtemplates ==

To add a new search subtemplate, please follow these steps:
# Create the subtemplate.
#* Subtemplate names should be kept short.
#* The subtemplate should have five unnamed parameters and one {{para|display}} parameter.
#* You can use {{tl|find sources multi/g}} as a base for your code.
#* The documentation should be transcluded from [[Template:Find sources multi/doc/links]].
# Add the data about your subtemplate to {{tl|find sources multi/linkinfo}}.
# Create redirects for any aliases you specified in {{tl|find sources multi/linkinfo}}. The pages of the form <code>Template:Find sources multi/''aliasname''</code> must redirect to your subtemplate.
# Create any template shortcuts that you specified in {{tl|find sources multi/linkinfo}}.
You can now use your new subtemplate directly from {{tl|find sources multi}}.

== See also ==
* [[:Category:Source-finding templates]]
* [[:Category:Find sources multi transclusions with errors]]
* [[Help:Find sources]]
* [[Wikipedia:Template messages/Cleanup/Verifiability and sources]]
* [[Wikipedia:WikiProject User scripts/Scripts/Search links]]

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Find sources multi subtemplates]]
[[Category:Source-finding templates]]
[[Category:Wikipedia metatemplates]]
}}</includeonly>