Difference between revisions of "Template:Find sources multi/linkinfo"

From blackwiki
Jump to navigation Jump to search
imported>Mr. Stradivarius
(Change to remove default values - this will make the template less likely to fail when updated)
imported>Mr. Stradivarius
(Add comment about link number 21)
Line 1: Line 1:
{{<includeonly>safesubst:</includeonly>#switch: {{{1}}}
+
<noinclude><!--
 +
===========================================================================================
 +
This template provides information about the link subtemplates of {{find sources multi}}.
 +
Please stick to the example format shown below when updating the links. Also, if you are
 +
adding link number 21, please contact [[User:Mr. Stradivarius]] (or if he's not around,
 +
someone who knows advanced template coding) as some changes will need to be made to the
 +
template's back-end before your new data can be used.
 +
===========================================================================================
 +
--></noinclude>{{<includeonly>safesubst:</includeonly>#switch: {{{1}}}
  
 
  | <!-- linkn --> | <!-- ln --> | <!-- code --> = {{<includeonly>safesubst:</includeonly>#switch: {{{2}}}
 
  | <!-- linkn --> | <!-- ln --> | <!-- code --> = {{<includeonly>safesubst:</includeonly>#switch: {{{2}}}
Line 259: Line 267:
 
== Adding new entries ==
 
== Adding new entries ==
  
Adding new entries should be fairly self-explanatory - just keep the format the same as previous entries.
+
Adding new entries should be fairly self-explanatory - just keep the format the same as previous entries. However, if you are adding link number 21, please contact [[User:Mr. Stradivarius]] (or if he's not around, someone who knows advanced template coding) as some changes will need to be made to the template's back-end before your new data can be used.
  
 
}}
 
}}

Revision as of 10:07, 15 March 2013

Template documentation

This template stores data about the various search link subtemplates of {{find sources multi}}.

Usage

The template takes two positional parameters.

  • The first positional parameter specifies the subtemplate for which data is requested. It may take the value of the subpage name of the link template (e.g. gnews), a value of linkn (link1, link2, etc.), or its alias ln (l1, l2, etc.).
  • The second positional parameter specifies what type of data is requested. It can take the following values:
    • code - The main link code. This is the same as the subpage name of the link template.
    • alias1 - An alias for the main link code. The subpage of Template:Find sources multi with this value is a redirect to the link template.
    • alias2 - Another alias for the main link code.
    • alias3 - A third alias for the main link code.
    • alias4 - A fourth alias for the main link code.
    • t_description - A short description of the template.
    • se_description - A short description of the search engine that the template uses.
    • shortcut1 - A template shortcut for the link template.
    • shortcut2 - A second template shortcut for the link template.
    • shortcut3 - A third template shortcut for the link template.
    • notes - Notes about of the link template.

The template will only output data if the following three conditions are all true:

  1. The first positional parameter has a valid value.
  2. The second positional parameter has a valid value.
  3. The data field specified by the first and second positional parameters is not empty.

Otherwise, the template will return a null value.

Examples

Example 1
{{find sources multi/linkinfo|link1}}
produces:
Example 2
{{find sources multi/linkinfo|link1|code}}
produces:
g
Example 3
{{find sources multi/linkinfo|ddg|code}}
produces:
ddg
Example 4
{{find sources multi/linkinfo|link1|t_description}}
produces:
This template provides a search link to Google to help find sources for articles.
Example 5
{{find sources multi/linkinfo|ddg|se_description}}
produces:
DuckDuckGo, a search engine that uses information from crowd-sourced websites (such as Wikipedia) to provide its results.
Example 6
{{find sources multi/linkinfo|link1|nonexistentvalue}}
produces:
Example 7
{{find sources multi/linkinfo|nonexistentvalue|code}}
produces:

Adding new entries

Adding new entries should be fairly self-explanatory - just keep the format the same as previous entries. However, if you are adding link number 21, please contact User:Mr. Stradivarius (or if he's not around, someone who knows advanced template coding) as some changes will need to be made to the template's back-end before your new data can be used.