Difference between revisions of "Template:Cite EB1911/doc"

From blackwiki
Jump to navigation Jump to search
imported>Bob Burkhardt
(unnamed arg not deprecated)
imported>DavidBrooks
(Canonical hyphenated parameter names)
 
(55 intermediate revisions by 20 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. -->
 +
{{Lua|Module:template wrapper}}
  
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
+
==Usage==
 +
This template indicates that an article incorporates information from the [[Encyclopædia Britannica Eleventh Edition|Eleventh Edition of the ''Encyclopædia Britannica'']], a work now in the [[public domain]].
  
==Usage==
+
If the Wikipedia article incorporates a copy of '''text''' from (or close paraphrasing of) an article in the [[Encyclopædia Britannica Eleventh Edition|Eleventh Edition of the ''Encyclopædia Britannica'']], then use the template {{tl|EB1911}} which prepends an attribution string to the citation (see the [[WP:PLAGIARISM|plagiarism]] guideline).
This template indicates that an article incorporates information from the [[Encyclopædia Britannica Eleventh Edition|Eleventh Edition of the ''Encyclopædia Britannica'']] a work now in the [[public domain]].
 
  
If the Wikipedia article incorporates a copy of '''text''' from, (or close paraphrasing of), an article in the [[Encyclopædia Britannica Eleventh Edition|Eleventh Edition of the ''Encyclopædia Britannica'']], then use the template {{tl|1911}} which prepends an attribution string to the citation (see the [[WP:PLAGIARISM|plagiarism]] guidline).
+
===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 encyclopaedia 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 supported by a citation from somewhere in the 29-volumes of the Eleventh Edition of the Encyclopædia Britannica!</ref>
  
 
===Summary===
 
===Summary===
 
The template can be placed in different locations and depending on the what it is required the parameters can be mixed and matched:
 
The template can be placed in different locations and depending on the what it is required the parameters can be mixed and matched:
 +
 
{|class=wikitable
 
{|class=wikitable
 
|-
 
|-
Line 16: Line 20:
 
|<nowiki>{{Cite EB1911|wstitle=</nowiki>''EB name''<nowiki>}}</nowiki>
 
|<nowiki>{{Cite EB1911|wstitle=</nowiki>''EB name''<nowiki>}}</nowiki>
 
|{{Cite EB1911|wstitle=Alfred the Great}}
 
|{{Cite EB1911|wstitle=Alfred the Great}}
|Use '''wstitle=''EB name''''' if the article exists on [[Wikisource]] if not use '''title=''EB name'' '''
+
|Use '''wstitle=''EB name''''' if the article exists on [[Wikisource]] if not use '''title=''EB name'' '''.
 
|-
 
|-
 
|<nowiki>{{Cite EB1911|title=|url=|first=|last=|volume=|pages=}}</nowiki>
 
|<nowiki>{{Cite EB1911|title=|url=|first=|last=|volume=|pages=}}</nowiki>
|{{Cite EB1911|title=Alfred the Great|first=Charles|last=Plummer|url=http://www.archive.org/stream/encyclopaediabri01chisrich#page/582/mode/1up|volume=1|pages=582–584}}
+
|{{Cite EB1911|title=Alfred the Great|first=Charles|last=Plummer|url=https://www.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'''.
+
|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'''.
 
|}
 
|}
  
 
===Detailed notes===
 
===Detailed notes===
 
 
This template is wrapper around {{tl|cite encyclopedia}}. In its default mode it attributes text to an article from Eleventh Edition of the Encyclopædia Britannica.
 
This template is wrapper around {{tl|cite encyclopedia}}. In its default mode it attributes text to an article from Eleventh Edition of the Encyclopædia Britannica.
  
This template automatically sets some of the parameters passed into {{tl|cite encyclopedia}} for example "publisher = Cambridge University Press". Over and above the standard parameter passed into {{tl|cite encyclopedia}} there are some additional parameters and those are listed below in a separate table from the table of parameters passed into {{tl|cite encyclopedia}}.<ref group=nb>For backwards compatibility with {{tl|Wikisource1911Enc citation}}  and {{tl|1911EB}}, and for compatibility with similar templates, like {{tl|Cite Americana}}, a Wikisource title can also be specified using an unnamed argument instead of the <code>wstitle</code> parameter.</ref>
+
This template automatically sets some of the parameters passed into {{tl|cite encyclopedia}} for example "publisher = Cambridge University Press". Over and above the standard parameter passed into {{tl|cite encyclopedia}} there are some additional parameters and those are listed hereafter in a separate table from the table of parameters passed into {{tl|cite encyclopedia}}.
  
Minimum is:'''<nowiki>{{Cite EB1911 |article=</nowiki>''EB article name''<nowiki>}}</nowiki>''' or '''<nowiki>{{Cite EB1911 |wstitle=</nowiki>''EB article name''<nowiki>}}</nowiki>'''<ref group=nb>It will also work with no parameters, but that set a category flagging that no article name has been given, as it is not much use to the reader to inform them that a Wikipeda article contains some text copied from somewhere in the 29-volumes of the Eleventh Edition of the Encyclopædia Britannica!</ref>
+
Minimum is: '''<nowiki>{{Cite EB1911 |title=</nowiki>''EB article name''<nowiki>}}</nowiki>''' or '''<nowiki>{{Cite EB1911 |wstitle=</nowiki>''EB article name''<nowiki>}}</nowiki>'''
  
Full set is:'''<nowiki>{{Cite EB1911 |wstitle= |article= |no-icon |inline= |footnote= |author= |last= |first= |authorlink= |coauthors= |title= |url= |accessdate= |volume= |page= |pages= |ref=}}</nowiki>'''
+
Full set is: '''<nowiki>{{Cite EB1911 |wstitle= |display= |noicon= |short= |footnote= |author= |last= |first= |author-link= |chapter= |title= |url= |access-date= |volume= |page= |pages= |ref= |mode=}}</nowiki>'''
  
 
{|class=wikitable
 
{|class=wikitable
Line 37: Line 40:
 
!Parameter ||Note
 
!Parameter ||Note
 
|-
 
|-
|article=''EB name''||If set is assigned to ''title''. If ''title'' is set ''article'' is ignored.
+
|author=''author name''||Assigned to ''last'' ignored if ''last'' is set.
 
|-
 
|-
|author=''author name''||Assigned to ''last'' ignored if ''last'' is set.
+
|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.
 
|-
 
|-
|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.
+
|noicon=1 ||Suppresses the lead icon (useful with {{tl|Wikisource-inline}}).
 
|-
 
|-
|no-icon=1 ||Suppresses the lead icon (useful with {{tl|Wikisource-inline}}).
+
|short=1 ||Suppresses publisher and editor display.
 
|-
 
|-
 +
|display=''label for Wikisource link''||If set, this text is used as a 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.
 
|}
 
|}
  
 
{|class=wikitable
 
{|class=wikitable
|+Paramaters passed into {{tl|cite encyclopedia}}
+
|+Parameters passed into {{tl|cite encyclopedia}}
!Paramater||Set to||Notes
+
!Parameter||Set to||Notes
 
|-
 
|-
|last= ||author= or last= ||If ''author='' and ''last='' are set the value of ''last='' is used.
+
|last= ||author= or last= ||If ''author='' and ''last='' are set the value of ''last='' is used. author2, (or last2) etc, are provided if there is more than one author
 
|-
 
|-
 
|first= ||first= ||Set to the value of ''first='' or not set
 
|first= ||first= ||Set to the value of ''first='' or not set
 
|-
 
|-
|authorlink= ||  authorlink= || Set to the value of ''authorlink='' or not set
+
|author-link= ||  author-link= || Set to the value of ''author-link='' or not set (author-link2 etc is available if needed)
 
|-
 
|-
|coauthors= || coauthors= || Unlikely to be needed but can be set
+
|editor-first= ||Hugh || Automatically set within the template unless '''short''' is set
 
|-
 
|-
|editor-first= ||Hugh || Automatically set within the template
+
|editor-last= ||Chisholm || Automatically set within the template unless '''short''' is set
 
|-
 
|-
|editor-last= ||Chisholm || Automatically set within the template
+
|encyclopedia= || [[Encyclopædia Britannica Eleventh Edition|Encyclopædia Britannica]]||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=||Set to ''wstitle='' if set, if not to ''title='' if set, if not to ''article='' if set, if not set then left blank.
 
|title= ||wstitle= or title= or article=||Set to ''wstitle='' if set, if not to ''title='' if set, if not to ''article='' if set, if not set then left blank.
Line 69: Line 73:
 
|url= ||url= || Set to the value of url= unless ''wstitle='' is set in which case it is not set.
 
|url= ||url= || Set to the value of url= unless ''wstitle='' is set in which case it is not set.
 
|-
 
|-
|accessdate= || accessdate= || Set to the value of ''accessdate='' or 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=||  ||Not set  
 
| language=||  ||Not set  
 
|-
 
|-
| edition= ||Eleventh ||Automatically set within the template
+
| edition= ||11th ||Set by default within the template, can be overridden
 
|-
 
|-
 
| date= || ||Not set (see year)
 
| date= || ||Not set (see year)
 
|-
 
|-
| year= ||1911||Automatically set within the template
+
| year= ||1911||Set by default within the template, can be overridden
 
|-
 
|-
 
| month= || ||Not set
 
| month= || ||Not set
 
|-
 
|-
| publisher= ||Cambridge University Press ||automatically set within the template
+
| publisher= ||Cambridge University Press ||Automatically set within the template unless '''short''' is set
 
|-
 
|-
 
| volume= ||volume= ||Set to the value of ''volume='' or not set
 
| volume= ||volume= ||Set to the value of ''volume='' or not set
Line 102: Line 106:
 
|-
 
|-
 
| ref= ||ref =||Set to the value of ''ref='' or not set
 
| ref= ||ref =||Set to the value of ''ref='' or not set
 +
|-
 +
| mode= ||mode= ||Set to the value of ''mode='' or set to default.<ref group=nb>The parameter is provided because {{tl|cite encyclopedia}} (the wrapper for this template) sets mode="cs1"  ([[Help:Citation Style 1|citation style 1]]) while the other standard template {{tl|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 {{tl|citation}} if that is considered to be desirable.</ref>
 
|}
 
|}
  
== Hidden categories ==
+
== Tracking categories ==
 
Depending on the parameters passed into this template, it adds the following hidden categories to the articles in which it is used:
 
Depending on the parameters passed into this template, it adds the following hidden categories to the articles in which it is used:
*[[:Category:Wikipedia articles incorporating a citation from the 1911 Encyclopaedia Britannica with an unnamed parameter]]
+
*{{clc|Wikipedia articles incorporating a citation from the 1911 Encyclopaedia Britannica with no article parameter}}
*[[:Category: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}}
*[[:Category: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}}
*[[:Category:Wikipedia articles incorporating a citation from the 1911 Encyclopaedia Britannica without Wikisource reference]]
 
  
For an overview group category of the above see:[[:Category:Wikipedia articles incorporating a citation from the 1911 Encyclopædia Britannica]]
+
For an overview group category of the above see: [[:Category:Wikipedia articles incorporating a citation from the 1911 Encyclopædia Britannica]].
  
 
== See also ==
 
== See also ==
* [[Wikipedia:1911 Encyclopaedia Britannica]]—for information on usage of the material.
+
* [[Wikipedia:WikiProject Encyclopaedia Britannica]]—for information on usage of the material.
* {{tl|Wikisource1911Enc}} ({{tl|EB1911}} redirect)—similar in function to the standard {{tl|wikisource}} but automatically handles the location of the article.
+
* {{tl|EB1911}} Attribute an EB 1911 article.
* {{Tl|1911 POV}}—for articles with potential POV issues related to using information from the 1911 Encyclopaedia Britannica
+
* {{tl|Sect1911}} Attribute a section to EB 1911.
 +
* {{tl|EB1911 poster}} display an EB 1911 Wikisource article in a top box on the right.
 +
* {{Tl|Update-EB}} for articles with issues related to using information from the 1911 Encyclopaedia Britannica.
  
 
==Notes==
 
==Notes==
 
{{reflist|group=nb}}
 
{{reflist|group=nb}}
  
<includeonly><!--
+
<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
+
++++ PLEASE ADD CATEGORIES AFTER THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
[[Category:1911 Britannica templates|{{PAGENAME}}]]
+
{{DEFAULTSORT:Eb1911 Cite}}
[[Category:Wikisource link templates|1911]]
+
[[Category:1911 Britannica templates]]
 
+
[[Category:Wikisource link templates]]
[[ja:Template:Cite EB1911]]
+
[[Category:Templates that add a tracking category|{{PAGENAME}}]]
</includeonly>
+
}}</includeonly>

Latest revision as of 20:12, 29 November 2020

Usage

This template indicates that an article incorporates information from the Eleventh Edition of the Encyclopædia Britannica, a work now in the public domain.

If the Wikipedia article incorporates a copy of text from (or close paraphrasing of) an article in the Eleventh Edition of the Encyclopædia Britannica, then use the template {{EB1911}} which prepends an attribution string to the citation (see the plagiarism guideline).

Error message

This template requires a title parameter: title= or wstitle= to associate the source of the text being used with a specific part of the massive encyclopaedia 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 article name needed and set a category flagging that no article name has been given.[nb 1]

Summary

The template can be placed in different locations and depending on the what it is required the parameters can be mixed and matched:

Parameters Example Note
{{Cite EB1911|wstitle=EB name}} Chisholm, Hugh, ed. (1911). "Alfred the Great" . Encyclopædia Britannica (11th ed.). Cambridge University Press. Use wstitle=EB name if the article exists on Wikisource if not use title=EB name .
{{Cite EB1911|title=|url=|first=|last=|volume=|pages=}}  Plummer, Charles (1911). "Alfred the Great". In Chisholm, Hugh (ed.). Encyclopædia Britannica. 1 (11th ed.). Cambridge University Press. pp. 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.

Detailed notes

This template is wrapper around {{cite encyclopedia}}. In its default mode it attributes text to an article from Eleventh Edition of the Encyclopædia Britannica.

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

Minimum is: {{Cite EB1911 |title=EB article name}} or {{Cite EB1911 |wstitle=EB article name}}

Full set is: {{Cite EB1911 |wstitle= |display= |noicon= |short= |footnote= |author= |last= |first= |author-link= |chapter= |title= |url= |access-date= |volume= |page= |pages= |ref= |mode=}}

Additional parameters
Parameter Note
author=author name Assigned to last ignored if last is set.
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.
noicon=1 Suppresses the lead icon (useful with {{Wikisource-inline}}).
short=1 Suppresses publisher and editor display.
display=label for Wikisource link If set, this text is used as a 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.
Parameters passed into {{cite encyclopedia}}
Parameter Set to Notes
last= author= or last= If author= and last= are set the value of last= is used. author2, (or last2) etc, are provided if there is more than one author
first= first= Set to the value of first= or not set
author-link= author-link= Set to the value of author-link= or not set (author-link2 etc is available if needed)
editor-first= Hugh Automatically set within the template unless short is set
editor-last= Chisholm Automatically set within the template unless short is set
encyclopedia= 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= Set to wstitle= if set, if not to title= if set, if not to article= if set, if not set then left 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= Not set
edition= 11th Set by default within the template, can be overridden
date= Not set (see year)
year= 1911 Set by default within the template, can be overridden
month= Not set
publisher= Cambridge University Press Automatically set within the template unless short is set
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
ref= ref = Set to the value of ref= or not set
mode= mode= Set to the value of mode= or set to default.[nb 2]

Tracking categories

Depending on the parameters passed into this template, it adds the following hidden categories to the articles in which it is used:

For an overview group category of the above see: Category:Wikipedia articles incorporating a citation from the 1911 Encyclopædia Britannica.

See also

Notes

  1. It is not much use to the reader to inform them that a Wikipedia article contains some text supported by a citation from somewhere in the 29-volumes of the Eleventh Edition of the Encyclopædia Britannica!
  2. The parameter is provided because {{cite encyclopedia}} (the wrapper for this template) sets mode="cs1" (citation style 1) while the other standard template {{citation}} sets mode="cs2" (citation style 2). So the parameter mode can be set to cs2 to allow this template to emulate the look of {{citation}} if that is considered to be desirable.