Module:Find sources/doc
This is the documentation page for Module:Find sources
This module produces a list of links to search engines to help editors find sources about a given subject. It implements {{find sources}} and other similar templates. It is highly extensible; new templates and new link types can be added easily and by any user.
Contents
Usage
From wikitext
Usually, from wikitext this module should be used via a template, e.g. {{find sources}}. However, it is also possible to use it directly from #invoke, like this:
{{#invoke:Find sources|template|search term 1|search term 2|...}}
- template is the name of the template that should be called. It must be the full page name of the template, without the namespace, and with the correct capitalisation. So, for Template:Find sources, the template name should be "Find sources"; "find sources" with a lower-case "f" would cause an error. This parameter is required.
- search term 1, search term 2, etc., are the terms to be searched for in each of the search engine links. The first search term will appear in quotation marks, and subsequent search terms will be added without quotation marks. Each term will be separated by spaces. These parameters are all optional. If no parameters are given, the current page name will be used as a search term.
From Lua
Load the module with the following code:
local mFindSources = require('Module:Find sources')
You can then produce the list of search links like this:
mFindSources._main(template, searchTerms)
- template is the template name, as outlined in the #From wikitext section above. This parameter is required.
- searchTerms is an array of search terms. Each item in the array corresponds to a numbered search term as outlined in the #From wikitext section above. This parameter is optional.
Example syntax:
mFindSources._main('Find sources', {'Albert Einstein', '-"Marilyn Monroe"', 'relativity', 'science'})
Available templates
The following templates are available for use:
| Template | Description | Example | Configuration |
|---|---|---|---|
| Find sources | The most widely used source-finding template. Until September 2014 it was transcluded on all AfD discussion pages. | Find sources: Google (books⧼Dot-separator⧽news⧼Dot-separator⧽newspapers⧼Dot-separator⧽scholar⧼Dot-separator⧽free images⧼Dot-separator⧽WP refs)⧼Dot-separator⧽FENS⧼Dot-separator⧽JSTOR⧼Dot-separator⧽NYT⧼Dot-separator⧽TWL | main, documentation |
| Find sources mainspace | A source-finding template for use in mainspace. Used in Template:Notability. | Find sources: "Example" – news⧼Dot-separator⧽newspapers⧼Dot-separator⧽books⧼Dot-separator⧽scholar⧼Dot-separator⧽JSTOR | main, documentation |
| Find sources video games | The source-finding template transcluded on AfD pages for video games and related topics. | Find video game sources: "Example" – news⧼Dot-separator⧽newspapers⧼Dot-separator⧽books⧼Dot-separator⧽scholar⧼Dot-separator⧽JSTOR⧼Dot-separator⧽free images⧼Dot-separator⧽free news sources⧼Dot-separator⧽The Wikipedia Library⧼Dot-separator⧽NYT⧼Dot-separator⧽WP reference⧼Dot-separator⧽VG/RS⧼Dot-separator⧽VG/RL⧼Dot-separator⧽WPVG/Talk | main, documentation |
Link codes
The following table contains all available codes for search engine links, with descriptions and examples.
| Code | Description | Example | Configuration | Notes |
|---|---|---|---|---|
| archive.org | The Internet Archive, a digital library of public websites. | Archive.org | main, documentation | |
| bing | Bing, Microsoft's flagship search engine. | Bing | main, documentation | |
| ccsearch | the official search engine of Creative Commons | CC search | main, documentation | |
| duckduckgo | DuckDuckGo, a search engine that emphasizes protecting searchers' privacy and avoiding the "filter bubble" of personalized search results. | DuckDuckGo | main, documentation | |
| Google, the flagship search engine from Google Inc. | main, documentation | |||
| google books | Google Books, Google's search engine for books. | Google Books | main, documentation | |
| google free images | Google Images, Google's search engine for images. Only images compatible with Wikipedia's licensing are included. | Free Google Images | main, documentation | |
| google news | Google News, Google's search engine for news sites. | Google News | main, documentation | In the past this link searched news archives, but this functionality has been removed by Google. Currently, only recent news articles are searched. |
| google newspapers | Google Newspapers, a search of Google's digital archive of print newspapers. | Google Newspapers | main, documentation | |
| google scholar | Google Scholar, Google's search engine for academic papers and other scholarly research. | Google Scholar | main, documentation | |
| jstor | JSTOR, an online library containing digitised versions of academic journals. Requires a subscription. | JSTOR | main, documentation | |
| new york times | The website of The New York Times, a highly respected newspaper. | New York Times | main, documentation | |
| vgrl | Wikipedia:WikiProject Video games/Reference library internal archive search. | VGRL | main, documentation | |
| vgrs | Thibbs' Google RS, a custom Google search engine that limits the search to sites listed in Wikipedia:WikiProject Video games/Sources. | VGRS | main, documentation | |
| vgtalk | A search in the WikiProject Video games talk page and its archives under Wikipedia talk:WikiProject Video games. | WPVG Talk | main, documentation | |
| wikipedia library | A link to Wikipedia:The Wikipedia Library. This isn't actually a search link, but a portal page for various resources available only to Wikipedians. | Wikipedia Library | main, documentation | |
| wikipedia reference search | Wikipedia Reference Search, a Google search that only searches sites vetted by Wikipedians. | Wikipedia Reference Search | main, documentation | |
| yahoo | No description available | Yahoo! | main, documentation |
Documentation
The documentation for individual templates is generated by Module:Find sources/autodoc.