Module:Find sources/doc - Revision history

imported>Danski454: /* Adding new links */ tooltip not supported by link definition, only on template definition

2024-10-16T17:11:21Z

Adding new links: tooltip not supported by link definition, only on template definition

← Older revision		Revision as of 17:11, 16 October 2024
Line 140:		Line 140:
	! scope="row" \| notes		! 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.		\| 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.
	\|-
	~~! scope="row" \| tooltip~~
	~~\| a tooltip to display when link is hovered over. There are accessibility issues with using this to provide information, see [[MOS:NOHOVER]]. This field is optional.~~
	\|}		\|}

imported>Danski454: /* Adding new links */ document tooltip parameter

2024-10-16T12:42:33Z

Adding new links: document tooltip parameter

← Older revision		Revision as of 12:42, 16 October 2024
Line 140:		Line 140:
	! scope="row" \| notes		! 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.		\| 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.
	~~tooltip~~
	\|-		\|-
	! scope="row" \| tooltip		! scope="row" \| tooltip
	\|		\| a tooltip to display when link is hovered over. There are accessibility issues with using this to provide information, see [[MOS:NOHOVER]]. This field is optional.
	\|}		\|}

imported>Nickps: Added the page to :Category:Module documentation pages

2024-08-29T21:22:16Z

Added the page to Category:Module documentation pages

← Older revision		Revision as of 21:22, 29 August 2024
Line 178:		Line 178:
	[[Category:Wikipedia modules]]		[[Category:Wikipedia modules]]

	}}</includeonly>		}}</includeonly><noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

imported>Paine Ellsworth: High-use template

2024-02-03T16:56:29Z

High-use template

← Older revision		Revision as of 16:56, 3 February 2024
Line 1:		Line 1:
	{{High-use~~\|410000~~}}		{{High-use}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
	This module produces a list of links to search engines to help editors find sources about a given subject. It implements {{tl\|find sources}} and other similar templates. It is highly extensible; new templates and new link types can be added easily and by any user.		This module produces a list of links to search engines to help editors find sources about a given subject. It implements {{tl\|find sources}} and other similar templates. It is highly extensible; new templates and new link types can be added easily and by any user.
Line 177:		Line 177:
	<!-- Categories go here and interwikis go in Wikidata. -->		<!-- Categories go here and interwikis go in Wikidata. -->
	[[Category:Wikipedia modules]]		[[Category:Wikipedia modules]]

	}}</includeonly>		}}</includeonly>

imported>Mathglot: /* Link tables */ Add link to Module:Find sources/links.

2022-07-25T06:20:55Z

Link tables: Add link to Module:Find sources/links.

← Older revision		Revision as of 06:20, 25 July 2022
Line 84:		Line 84:
	==== Link tables ====		==== Link tables ====

	Link tables are used in the "introLink" and "links" fields of the template configuration. They can contain three fields, "code", "display", and "tooltip". The "code" field is required, and must be one of the link codes listed in the table below. The "display" field is optional, and specifies a custom display value for that link to be used by the template. If the display field is not set, a default value is set by the module. The "tooltip" field is also optional, and specifies a custom tooltip for the link. HTML reserved characters are escaped by the module. If the field is absent, no tooltip is displayed. For the "introLink" field, the default value is the search text entered by the user; for the "links" field, the default value is defined in the link configuration modules.		[[Module:Find sources/links\|Link tables]] are used in the "introLink" and "links" fields of the template configuration. They can contain three fields, "code", "display", and "tooltip". The "code" field is required, and must be one of the link codes listed in the table below. The "display" field is optional, and specifies a custom display value for that link to be used by the template. If the display field is not set, a default value is set by the module. The "tooltip" field is also optional, and specifies a custom tooltip for the link. HTML reserved characters are escaped by the module. If the field is absent, no tooltip is displayed. For the "introLink" field, the default value is the search text entered by the user; for the "links" field, the default value is defined in the link configuration modules.

	The following table contains all the available link codes, with descriptions and examples.		The following table contains all the available link codes, with descriptions and examples.

imported>Gonnym: /* Link documentation configuration page */ not needed anymore

2021-12-06T10:06:16Z

Link documentation configuration page: not needed anymore

@@ Line 169: / Line 169: @@
 * '''description''' - a brief description of what the template does. This is displayed on this documentation page in the [[#Available templates|table of available templates]].
 * '''docIntro''' - text to be used instead of the first sentence of the template documentation for individual source-finding templates. This is optional, and the default value is "''This template produces a series of links to various search interfaces to help find additional reference material for articles.''"
 == Configuration ==

imported>Gonnym: /* Adding new links */ update

2021-12-06T10:06:04Z

Adding new links: update

← Older revision		Revision as of 10:06, 6 December 2021
Line 108:		Line 108:

	== Adding new links ==		== 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".
	~~To make a new link code available~~ to ~~use from source-finding templates, you need to make a link configuration module for it. The page name for this module should start with "~~Module:Find sources/links~~/" and end with the link code~~. Link codes should be short but descriptive, and should be in lower case. For example, the link code for Google search is "google"~~, and the configuration page is at [[Module:Find sources/links/google]]~~.

	The link configuration page should look something like this:		The link configuration page should look something like this:
Line 115:		Line 114:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	return {		return {
	url = '//www.google.com/search?q=$1',		url = '//www.google.com/search?as_eq=wikipedia&q=$1',
	display = 'Google',		display = 'Google',
	~~separator~~ = ','		description = '[[Google]], the flagship search engine from Google Inc.',
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	* '''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.		{\| class="wikitable"
	* '''display~~''' -~~ If a display value is not specified in the template configuration, this value is used instead. This field is required.		\|+ Parameters
	* '''separator~~''' -~~ This is used to separate the search terms entered by the user. This is optional, and defaults to "+" (a URL-encoded space).		\|-
			! scope="col" \| Parameter
	~~Once you have created your~~ link ~~configuration page, you need~~ to ~~add~~ the link to [[~~Module:Find sources/links~~]] ~~in order for it to show up~~ in the table of ~~links on this~~ documentation ~~page~~.		! 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.
			tooltip
			\|-
			! scope="row" \| tooltip
			\|
			\|}

	== Automatic documentation ==		== Automatic documentation ==

imported>Gonnym at 09:58, 6 December 2021

2021-12-06T09:58:22Z

← Older revision		Revision as of 09:58, 6 December 2021
Line 171:		Line 171:
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	<!-- Categories go here and interwikis go in Wikidata. -->		<!-- Categories go here and interwikis go in Wikidata. -->
			[[Category:Wikipedia modules]]
	}}</includeonly>		}}</includeonly>

imported>EthanGaming7640: /* Usage */ missing comma

2021-12-05T01:17:59Z

Usage: missing comma

← Older revision		Revision as of 01:17, 5 December 2021
Line 33:		Line 33:

	* <var>template</var> is the template name, as outlined in the [[#From wikitext]] section above. This parameter is required.		* <var>template</var> is the template name, as outlined in the [[#From wikitext]] section above. This parameter is required.
	* <var>searchTerms</var> 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. Alternatively an empty table with the <code>title</code> key set will automatically generate a query as described above. This parameter is optional.		* <var>searchTerms</var> 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. Alternatively, an empty table with the <code>title</code> key set will automatically generate a query as described above. This parameter is optional.

	Example syntax:		Example syntax:

imported>Danski454: /* Link tables */ clarify

2021-10-04T20:15:22Z

Link tables: clarify

← Older revision		Revision as of 20:15, 4 October 2021
Line 84:		Line 84:
	==== Link tables ====		==== Link tables ====

	Link tables are used in the "introLink" and "links" fields of the template configuration. They can contain three fields, "code", "display", and "tooltip". The "code" field is required, and must be one of the link codes listed in the table below. The "display" field is optional, and specifies a custom display value for that link to be used by the template. If the display field is not set, a default value is set by the module. The "tooltip" field is also optional, and specifies a custom tooltip for the link. HTML reserved characters are escaped. If the field is absent, no tooltip is displayed. For the "introLink" field, the default value is the search text entered by the user; for the "links" field, the default value is defined in the link configuration modules.		Link tables are used in the "introLink" and "links" fields of the template configuration. They can contain three fields, "code", "display", and "tooltip". The "code" field is required, and must be one of the link codes listed in the table below. The "display" field is optional, and specifies a custom display value for that link to be used by the template. If the display field is not set, a default value is set by the module. The "tooltip" field is also optional, and specifies a custom tooltip for the link. HTML reserved characters are escaped by the module. If the field is absent, no tooltip is displayed. For the "introLink" field, the default value is the search text entered by the user; for the "links" field, the default value is defined in the link configuration modules.

	The following table contains all the available link codes, with descriptions and examples.		The following table contains all the available link codes, with descriptions and examples.