Editing Module:Find sources/doc (section)

== Adding new links ==
New links are added to [[Module:Find sources/links]]. Link codes should be short but descriptive, and should be in lower case. For example, the link code for Google search is "google".

The link configuration page should look something like this:

<syntaxhighlight lang="lua">
return {
	url = '//www.google.com/search?as_eq=wikipedia&q=$1',
	display = 'Google',
    description = '[[Google]], the flagship search engine from Google Inc.',
}
</syntaxhighlight>

{| class="wikitable"
|+ Parameters
|-
! scope="col" | Parameter
! scope="col" | Description
|-
! scope="row" | url
| The url to perform the search. This field takes a parameter $1, which is the URL-encoded search text entered by the user. This field is required.
|-
! scope="row" | display
| If a display value is not specified in the template configuration, this value is used instead. This field is required.
|-
! scope="row" | separator
| This is used to separate the search terms entered by the user. This is optional, and defaults to "+" (a URL-encoded space).
|-
! scope="row" | description
| a brief description of what the search engine link does. This is used in the template documentation to generate the list of link descriptions, and also to make the descriptions in the [[#Link tables|table of link codes]] above. This is optional, but recommended.
|-
! scope="row" | notes
| notes about the search engine link. These are put in the [[#Link tables|table of link codes]] above, but they are not put in the template documentation for individual source-finding templates. This field is optional.
|}