Template:Primary sources/doc
| This is a documentation subpage for Template:Primary sources. It may contain usage information, categories and other content that is not part of the original template page. |
__EXPECTED_UNCONNECTED_PAGE__
| This template is used on approximately 33,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
| Any breaking changes to this template, including moving it or nominating it for deletion, must be communicated in advance to Twinkle's users and maintainers at Wikipedia talk:Twinkle. The standard installation of Twinkle relies on this template. |
Use this template to tag information or analysis that you believe is improperly or unnecessarily supported by a primary source, so that other editors can see whether this use is appropriate or replace it with a citation to a secondary or tertiary source.
Usage
{{Primary sources|date=October 2026}}for entire articles{{Primary sources|section|date=October 2026}}for sections
Substitution of this template will automatically fill the date parameter.
{{subst:Primary sources}}
Optional find parameters are available, for modifying the operation of the {{find sources}} links displayed by the template:
{{Primary sources|find=double-quoted search keyword(s)|find2=unquoted keywords|date=October 2026}}
This template will categorize tagged articles into Category:Articles lacking reliable references.
There is currently no consensus on where in the article to place templates such as this.
When to use
The presence of primary sources in an article doesn't mean the article must be tagged. Primary sources may be used on Wikipedia, but they need to be handled with care.
Whether a source is independent is a different concept from whether it is a primary source. To tag an article as lacking sufficient independent sources, use instead the templates {{independent sources}} or, in the case those sources are published directly by the person/organization itself, {{self-published}}.
Some alternatives include:
- {{independent sources}} – When the source is written by or paid for by the subject (e.g., an op-ed written by the subject, an advertisement).
- {{self-published source}} – When the source is written by and published by the subject (e.g., a personal or business website).
- {{user-generated source}} – When the source is written by ordinary people on the internet (e.g., a wiki).
- {{primary sources}} (this template)) – When the source contains no analysis, comparison, evaluation, etc. of the subject (e.g., WP:PRIMARYNEWS).
Many sources fall into multiple categories. It's best to use the most specific or important one, instead of filling the page with similar tags.
Parameters
There are five parameters, one positional, and four named parameters. All parameters are optional.
|1=– scope of notification (e.g., 'paragraph', 'section', 'article', etc.) default: 'article'. see Details.|date=– month name and year; e.g. 'October 2026' (no default)|talk=– section or fullpage id of discussion|find=– search keywords for {{find sources}} param 1 (double-quoted search); default: page title. See details below.|find2=– search keywords for {{find sources}} param 2 (unquoted search). Alias:unquoted. See below.
Details
Positional parameter 1
- Positional parameter
|1=is the 'type' parameter, which may be set to paragraph or section or any string value.
Date parameter:
- The
|date=parameter is (generally[1]) used to indicate when the template was added to a page. An example of its usage is{{Primary sources|date=October 2026}}. Adding this parameter sorts the article into monthly subcategories of Category:Articles lacking sources, rather than adding it to the category itself, allowing the oldest problems to be identified and dealt with first. If the date parameter is omitted, a bot will add it later.
Find parameters:
- There are two 'find' parameters available to control the presentation and operation of the {{find sources}} links optionally displayed by the {{Primary sources}} template. By default, the template displays {{find sources}} with a quoted search query equivalent to the exact article title. Sometimes, especially if the article has a long, descriptive title, or if it includes parenthetical disambiguation terms, this may not give useful results. The find parameters can be used to provide the search keywords of your choice to the {{find sources}} links. Use:
|find=to specify keywords for an exact search (double-quoted query); this corresponds to {{find sources}} positional param|1.|find2=to specify keywords for an unquoted search; this corresponds to {{find sources}} param|2. The alias|unquoted=may be used instead. Note that booleans, exclusion terms (preceded by minus sign) and other search operators may be used in unquoted search (|find2=) if valid for the search domains:
{{Primary sources|find=John Adams|find2=president -Quincy}}⟶ (see Examples below)
- Param
|find=may take the special valuenonein order to suppress display of find sources links. (Note that specifying|find=noneand a nonempty value for|find2=is not a valid combination.)
Wrappers
To tag an individual section instead of the whole article, you can use {{Primary sources section}} template.
If you use template {{BLP primary sources}}, it indicates that the article is a biography of a living person, and also sorts the article into subcategories of Category:BLP articles lacking sources. This serves to indicate a problem with the policy on self-published sources in biographies of living persons.
Examples
{{primary sources|date=October 2026}}
Exclusion term in unquoted search:
{{Primary sources|find=John Adams|find2=president -Quincy}}⟶This article relies excessively on references to primary sources.
For Biographies of Living Persons:
{{BLP primary sources|date=October 2026}}
Redirects
Aliases include:
- {{Primary}}
- {{Primary source}}
- {{Primary Sources}}
- {{Primarysource}}
- {{Primarysources}}
- {{PrimarySources}}
Aliases
- {{BLP primary sources}} – this template with
|BLP=yes
See also
- Primary source templates:
- {{Primary sources section}}
- {{BLP primary sources}}
- {{Only primary sources}}
- {{Primary source inline}} – inline with text, to object to the inappropriate use of a primary source (regardless of whether the primary source is independent of the subject)
- Third-party source templates:
- {{Third-party}}
- {{Third-party inline}} – inline with text, to request an independent source
- Wikipedia:Identifying and using primary and secondary sources
- Wikipedia:Secondary does not mean independent
- Wikipedia:Template messages/Cleanup
- Wikipedia:Template messages/Sources of articles
Notes
- ↑ Because of the nature of the workflow using the current date makes sense, it is simpler to add, especially for the WP:bots it means that older dated categories do not have to be constantly created and deleted, and it enables some measure of progress. Moreover it is "good enough" to get the articles into the workflow and the intention is to ensure they are cleaned up eventually. Occasionally however it may be useful to bulk add items, to older categories, for example when the system was initially set up, when merging two schemes or when adding to the current month would swamp it disproportionately.
TemplateData
TemplateData for Primary sources
Use this template to tag information or analysis that you believe is improperly or unnecessarily supported by a primary source, so that other editors can see whether this use is appropriate and/or replace it with a citation to a stronger, secondary source. Primary sources may be used on Wikipedia, but they need to be handled with care.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Focus | 1 | Use if the focus is a particular section or paragraph
| String | optional |
| Month and year | date | Month and year when template was applied; if left blank, this will be filled by a bot
| String | suggested |
| Talk | talk | Section name or full page and section of discussion
| String | optional |
| Find | find | Search keywords for 'find sources' double-quoted (exact) search. May be one or more words. Leave empty to suppress 'find sources' output.
| String | optional |
| Find2 | find2 unquoted | Search keywords for 'find sources' unquoted search. | String | optional |
| Sourcing | |
| BLP-specific | |
| Topic-specific | |
| Dispute-related | |
| Citation improvements | |
| General advice |
- Template:Primary sources invokes Module:Navbox using Lua.
Usage
This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.
The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.
Syntax
{{navbox
|state = uncollapsed, collapsed, plain, autocollapse (default)
|name = mandatory - name of the template
|style = optional - style for the whole table
|title = mandatory - navbox header
|gtitleN = optional - title of N-th group of items
|styleN = optional - style for groupN; i.e. text-align
|groupN = mandatory - list of groups of items
|fstyle = optional - style for footer ; i.e. text-align
|footer = optional - navbox footer
}}
- Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
- Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
- Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
- Line breaks: Line-breaks (
<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN. - Bullets: Create unordered lists with lines beginning with *.
- Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! (
{{!}}).
States
- Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
- Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
- Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Plain: Removes the "show/hide" link.
Sub-groups
- For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
- To create sub-groups within
{{navbox}}, certain parameters are to be included:- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|gtype2 = Subgroup (mandatory)
|group2 =
{{navbox
|subgroup = yes (mandatory)
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Collapsible sub-groups
- For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
- To create collapsible sub-groups within
{{navbox}}, these parameters need to be included:- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state = uncollapsed
|name =
|gtype1 = Subgroup
|group1 =
{{navbox
|collapsible = yes
|state = collapsed
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Use of images
- The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
- Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.
Link and file share the same name
{{plink|Item}}
File name differs from the link
{{plink|Item|File}}
Link and file share the same name, but different text is desired to display
{{plink|Item|alt=Text}}
File name differs from the link and different text is desired to display
{{plink|Item|File|alt=Text}}
Categorising
Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.
There are 2 methods of categorising pages with navboxes:
The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.
Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.
Examples
To see the following navboxes in action, see Template:Navbox.
Single line navbox with centered list
{{navbox
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Navbox with standard footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|footer = Centered footer
}}
Navbox with styled footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|fstyle = text-align:right
|footer = Right-aligned footer
}}
Multiple line navbox
{{navbox
|name =
|title =
|gtitle1 = Group title 1
|group1 =
|gtitle2 = Group title 2
|group2 =
|gtitle3 = Group title 3
|group3 =
}}
Collapsed navbox
{{navbox
|state = collapsed
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox with Tnavbar
{{navbox
|state = plain
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox without Tnavbar
{{navbox
|state = plain
|title =
|style1 = text-align:center
|group1 =
}}
Complicated navbox
{{navbox
|state = uncollapsed
|name =
|title =
|gtitle1 = Level 1 Title 1
|group1 =
|gtitle2 = Level 1 Title 2
|group2 =
|gtitle3 = Level 1 Title 3
|group3 =
|gtitle4 = Level 1 Title 4
|group4 =
|gtitle5 = Level 1 Title 5
|gtype5 = Subgroup
|group5 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 2 Title 1
|group1 =
|gtitle2 = Level 2 Title 2
|group2 =
|gtitle3 = Level 2 Title 3
|gtype3 = Subgroup
|group3 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 3 Title 1
|group1 =
|gtitle2 = Level 3 Title 2
|group2 =
}}
|gtitle4 = Level 2 Title 4
|group4 =
}}
|gtitle6 = Level 1 Title 6
|group6 =
|gtitle7 = Level 1 Title 7
|group7 =
|fstyle =
|footer =
}}
Preventing unwanted documentation
The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).
Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.