View source for Template:EB1911/doc

{{Documentation subpage}}
{{High-use}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. -->
{{Lua|Module:template wrapper}}

==Usage==
This template indicates that an article incorporates text from the [[Encyclopædia Britannica Eleventh Edition|Eleventh Edition of the ''Encyclopædia Britannica'']], which is now in the [[public domain]].

===Error message===
This template ''requires'' a title parameter: <kbd>title=</kbd> or <kbd>wstitle=</kbd> to associate the source of the text being used with a specific part of the massive encyclopedia from which it is copied or paraphrased. More information on these and other parameters are set out below.  In the absence of a title parameter being supplied, the template will display the error message <sup><span style="color:red">article name needed</span></sup> and set a category flagging that no article name has been given.<ref group=nb>It is not much use to the reader to inform them that a Wikipedia article contains some text copied from somewhere in the 29 volumes of the Eleventh Edition of the Encyclopædia Britannica!</ref>

===Quick explanation (''aide-mémoire'')===
The template can be placed in different locations and depending on the use, the parameters can be mixed and matched:

{|class=wikitable
|-
!Location||Parameters||Example||Note
|-
|==References==
|<nowiki>{{EB1911|wstitle=</nowiki>''EB name''<nowiki>}}</nowiki>
|{{EB1911|wstitle=Alfred the Great}}
|Use '''wstitle=''EB name''''' if the article exists on [[Wikisource]] if not use '''title=''EB name'' '''
|-
|==References==
|<nowiki>{{EB1911|title=|url=|first=|last=|volume=|pages=}}</nowiki>
|{{EB1911|title=Alfred the Great|first=Charles|last=Plummer|url=https://archive.org/stream/encyclopaediabri01chisrich#page/582/mode/1up|volume=1|pages=582–584}}
|some additional information: '''title''' instead of ''wstitle'', '''url''' to the external page instead of link to wikisource; the '''first''' and '''last''' names of the author of the article, the '''volume''' and '''page [number]s'''.
|-
|[[WP:CITE#Inline citations|inline citation]]
|<nowiki>{{EB1911|inline=1|wstitle=</nowiki>''EB name''<nowiki>}}</nowiki>
|{{EB1911|inline=1|wstitle=Alfred the Great}}
|'''inline=1'''. Alters the prescript from "This article..." to "One or more...". Suitable for noting that a paragraph is copied from EB.
|-
|inline citation
|<nowiki>{{EB1911|noprescript=1|title=</nowiki>''EB name''<nowiki>}}</nowiki>
|{{EB1911|title=Alfred the Great|noprescript=1}}
|'''noprescript=1'''.  Removes the prescript suitable for a citation where a paragraph is a summary of a paragraph from an EB article and not a copy. '''title=''' for no copy on Wikisource.
|-
|==Further reading==
|<nowiki>{{EB1911|noprescript=1|url=http://...|title=</nowiki>''EB name''<nowiki>}}</nowiki>
|{{EB1911|noprescript=1|title=Alfred the Great|url=https://archive.org/stream/encyclopaediabri01chisrich#page/582/mode/1up}}
|'''noprescript=1.'''  Removes the prescript '''title=''' for the article name not yet on Wikisource. '''url=''' for where the text can be found online.
|-
|==External links==
|<nowiki>{{EB1911|noprescript=1|wstitle=</nowiki>''EB name''<nowiki>}}</nowiki>
|{{EB1911|noprescript=1|wstitle=Alfred the Great}}
|'''noprescript=1.''' Removes the prescript as the source is not used in the article.
|}

===Detailed notes===
This template is a wrapper around {{Template link|Cite EB1911}} which in turn is a wrapper around {{Template link|Cite encyclopedia}}. In its default mode it attributes text to an article from Eleventh Edition of the Encyclopædia Britannica. If attribution is not required (because the article is used as an information source, but not directly copied, or closely paraphrased) then use {{Template link|Cite EB1911}} instead of this template.

This template automatically sets some of the parameters passed into {{Template link|cite encyclopedia}} for example "publisher = Cambridge University Press". Over and above the standard parameter passed into {{Template link|cite encyclopedia}} there are some additional parameters and those are listed below in a separate table from the table of parameters passed into {{Template link|cite encyclopedia}}.

Minimum is:'''<nowiki>{{EB1911|title=</nowiki>''EB article name''<nowiki>}}</nowiki>''' or '''<nowiki>{{EB1911|wstitle=</nowiki>''EB article name''<nowiki>}}</nowiki>'''

Full set is:'''<nowiki>{{EB1911|wstitle= |title= |display= |noprescript= |noicon |inline= |author= |last= |first= |author-link= |chapter= |url= |access-date= |volume= |page= |pages= |ref= |mode=}}</nowiki>'''

{|class=wikitable
|+Additional parameters
!Parameter ||Note
|-
|author=''author name''||Assigned to ''last'' ignored if ''last'' is set. This is a standard parameter.
|-
|wstitle=''name of the article on wikisource'' ||If set, set link to EB article on wikisource, and unsets ''title'' and ''url'' if they are also set.
|-
|display=''label for Wikisource link''||If set, this text is used as the display label when linking to EB article on Wikisource. It is useful for hiding disambiguation extensions, and should show the actual title in the printed EB.
|-
|inline=1 or footnote=1 ||Changes the default prescript from "This article" to "One or more of the preceding sentences". Useful for inline citations (see inline examples in the [[#Quick explanation (aide-mémoire)|previous section]]). Footnote is deprecated and will be removed in later versions
|-
|noicon=1 ||Suppresses the lead icon (useful with {{Template link|Wikisource-inline}}).
|-
|noprescript=1 ||Suppresses the prescript.
|-
|}

{|class=wikitable
|+Parameters passed into {{Template link|cite encyclopedia}}
!Parameter||Set to||Notes
|-
|last= ||author= or last= ||If ''author='' and ''last='' are set the value of ''last='' is used. Use ''last2='' (etc) if there is more than one author.
|-
|first= ||first= ||Set to the value of ''first='' or not set. first2= if there is more than one author
|-
|author-link= ||  author-link= || Set to the value of ''author-link='' or not set. Use author-link2 to set the value of author-link2 etc. 
|-
|editor-first= ||Hugh || Automatically set within the template
|-
|editor-last= ||Chisholm || Automatically set within the template
|-
|encyclopedia= || [[Encyclopædia Britannica Eleventh Edition|Encyclopædia Britannica]]||Automatically set within the template
|-
|chapter= ||chapter= ||Set to the text of ''chapter='' or not set
|-
|title= ||wstitle= or title= or article=||Uses ''wstitle='' if it has a value. If ''wstitle='' is empty or missing, uses ''title='' if it has a value. If ''title='' is empty or missing, uses ''article=''. Default value is blank.
|-
|url= ||url= || Set to the value of url= unless ''wstitle='' is set in which case it is not set.
|-
|access-date= || access-date= || Set to the value of ''access-date='' unless ''wstitle='' is set in which case it is not set.
|-
| language=||en  ||Set by default within the wrapped template 
|-
| edition= ||Eleventh ||Automatically set within the template
|-
| date= || ||Not set (see year)
|-
| year= ||1911||Automatically set within the template
|-
| month= || ||Not set
|-
| publisher= ||Cambridge University Press ||automatically set within the template
|-
| volume= ||volume= ||Set to the value of ''volume='' or not set
|-
| location= || ||Not set
|-
| id= || ||Not set
|-
| isbn= || ||Not set
|-
| oclc= || ||Not set
|-
| doi= || ||Not set
|-
| page= ||page=||Set to the value of ''page='' or not set
|-
| pages= ||pages=||Set to the value of ''pages='' or not set
|-
| quote=|| ||Not set
|-	
| mode= ||mode= ||Set to the value of ''mode='' or set to default.<ref group=nb>The parameter is provided because {{Template link|cite encyclopedia}} (the wrapper for this template) sets mode="cs1"  ([[Help:Citation Style 1|citation style 1]]) while the other standard template {{Template link|citation}} sets mode="cs2" ([[Help:Citation Style 2|citation style 2]]). So the parameter ''mode'' can be set to cs2 to allow this template to emulate the look of {{Template link|citation}} if that is considered to be desirable.</ref>
|-
| ref=||harv||automatically set within the template, but it can be overwritten with a user supplied value. It means that {{Template link|sfn}} and {{Template link|harvnb}} can be used to link to this template, for example, {{Template link expanded|sfn|Chisholm|1911}}. ([[Template:Sfn#Citation_template_does_not_support_.7Cref.3Dharv|more details]])
|}

== Tracking categories ==
This template adds the hidden category "[[:Category:Wikipedia articles incorporating text from the 1911 Encyclopædia Britannica|Wikipedia articles incorporating text from the 1911 Encyclopædia Britannica]]" to the articles it is used in.

The template calls {{Template link|Cite EB1911}} and, depending on parameters used, it also adds the following hidden categories:
* {{clc|Wikipedia articles incorporating a citation from the 1911 Encyclopaedia Britannica with no article parameter}}
* {{clc|Wikipedia articles incorporating a citation from the 1911 Encyclopaedia Britannica with Wikisource reference}}
* {{clc|Wikipedia articles incorporating a citation from the 1911 Encyclopaedia Britannica without Wikisource reference}}

== See also ==
* [[Wikipedia:WikiProject Encyclopaedia Britannica]]—for information on usage of the material.
* {{Template link|Sect1911}} Attribute a section to EB 1911
* {{Template link|Cite EB1911}} Cite an EB 1911 article.
* {{Template link|EB1911 poster}} display an EB 1911 Wikisource article in a top box on the right
* {{Template link|Update-EB}} for articles with information from the 1911 Encyclopaedia that are outdated and require updates (for example information in geographical articles overemphasises railway links and ignores more recent forms of transport, and do not mention 100 years of political changes).

==Notes==
{{reflist|group=nb}}

<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
{{DEFAULTSORT:Eb 1911}}
[[Category:1911 Britannica templates]]
[[Category:Encyclopedia source templates]]
[[Category:Wikisource link templates]]
[[Category:Templates that add a tracking category|{{PAGENAME}}]]
}}</includeonly>
<templatedata>
{
	"params": {
		"1": {},
		"noicon": {
			"description": "Set to \"1\" to suppress the icon."
		},
		"no-icon": {},
		"wstitle": {
			"description": "Title of the article on Wikisource",
			"example": "Bardowiek"
		},
		"no-prescript": {},
		"noprescript": {},
		"inline": {
			"description": "Changes the default prescript from \"This article\" to \"One or more of the preceding sentences\". Useful for inline citations.",
			"example": "1"
		},
		"_debug": {},
		"volume": {
			"example": "3"
		},
		"page": {}
	}
}
</templatedata>