Difference between revisions of "Template:Catholic Encyclopedia/doc"
imported>MerlIwBot m (robot Removing: ro:Format:Catholic Encyclopedia, it:Template:Catholic Encyclopedia) |
imported>Vanisaac |
||
| (22 intermediate revisions by 16 users not shown) | |||
| Line 8: | Line 8: | ||
==Usage== | ==Usage== | ||
| + | ===Wikisource=== | ||
| + | The Catholic Encyclopedia is available on [[Wikisource]] at [[s:Catholic Encyclopedia (1913)]], and is integrated into this template. | ||
| + | |||
| + | To automatically generate a link to the cited article, use "'''wstitle='''Name of Article". | ||
===Quick explanation (''aide-mémoire'')=== | ===Quick explanation (''aide-mémoire'')=== | ||
| − | The template can be placed in different locations and depending on | + | The template can be placed in different locations and, depending on what is required, the parameters can be mixed and matched: |
{|class=wikitable | {|class=wikitable | ||
|- | |- | ||
| − | !Location | + | ! Location !! Parameters !! Example !! Notes |
|- | |- | ||
| − | | | + | | References |
| − | | | + | | {{tlc|{{BASEPAGENAME}}|wstitle{{=}}<var>CE name</var>}} |
| − | |{{ | + | | {{{{BASEPAGENAME}}|wstitle=St. Theodotus of Ancyra}} |
| − | |Use | + | | Use {{para|wstitle|<var>CE name</var>}} if the article exists on [[Wikisource]]. If not, use {{para|title|<var>CE name</var>}} |
|- | |- | ||
| − | | | + | | References |
| − | | | + | | {{tlc|{{BASEPAGENAME}}|title{{=}}|url{{=}}|first{{=}}|last{{=}}|volume{{=}}|page{{=}}}} |
| − | |{{ | + | | {{{{BASEPAGENAME}}|title=St. Theodotus of Ancyra|first=Francis|last=Mershman|url=https://archive.org/stream/catholicencyclop14herbuoft#page/578/mode/1up|volume=14|page=579}} |
| − | | | + | | Some additional information: {{para|title}} instead of {{para|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. |
|- | |- | ||
| − | |[[WP:CITE#Inline citations| | + | | [[WP:CITE#Inline citations|Inline citation]] |
| − | | | + | | {{tlc|{{BASEPAGENAME}}|inline{{=}}1|wstitle{{=}}<var>CE name</var>}} |
| − | |{{ | + | | {{{{BASEPAGENAME}}|inline=1|wstitle=St. Theodotus of Ancyra}} |
| − | | | + | | {{para|inline|1}} alters the prescript from "This article..." to "One or more...". Suitable for noting that a paragraph is copied from CE. |
|- | |- | ||
| − | | | + | | Inline citation |
| − | | | + | | {{tlc|{{BASEPAGENAME}}|prescript{{=}}|title{{=}}<var>CE name</var>}} |
| − | |{{ | + | | {{{{BASEPAGENAME}}|title=St. Theodotus of Ancyra|prescript=}} |
| − | | | + | | {{para|prescript}} removes the prescript suitable for a citation where a paragraph is a summary of a paragraph from an CE article and not a copy. {{para|title}} for no copy on Wikisource. |
|- | |- | ||
| − | | | + | | Further reading |
| − | | | + | | {{tlc|{{BASEPAGENAME}}|no-icon{{=}}1|prescript{{=}}|url{{=}}<var>http://...</var>|title{{=}}<var>CE name</var>}} |
| − | |{{ | + | | {{{{BASEPAGENAME}}|no-icon=1|prescript=|title=St. Theodotus of Ancyra|url=http://www.newadvent.org/cathen/14579a.htm}} |
| − | | | + | | {{para|no-icon|1}} removes the lead icon, {{para|prescript}} removes the prescript {{para|title}} for the article name not yet on Wikisource. {{para|url}} for where the text can be found online. |
|- | |- | ||
| − | | | + | | External links |
| − | | | + | | {{tlc|{{BASEPAGENAME}}|no-icon{{=}}1|prescript{{=}}|wstitle{{=}}<var>CE name</var>}} |
| − | |{{ | + | | {{{{BASEPAGENAME}}|no-icon=1|prescript=|wstitle=St. Theodotus of Ancyra}} |
| − | | | + | | {{para|no-icon|1}} removes the lead icon, {{para|prescript}} removes the prescript as the source is not used in the article. |
|} | |} | ||
===Detailed notes=== | ===Detailed notes=== | ||
| − | |||
This template is wrapper around {{tl|cite encyclopedia}}. In its default mode it attributes text to an article from the [Old] [[Catholic Encyclopedia]]. | This template is wrapper around {{tl|cite encyclopedia}}. In its default mode it attributes text to an article from the [Old] [[Catholic Encyclopedia]]. | ||
This template automatically sets some of the parameters passed into {{tl|cite encyclopedia}} for example "publisher = Robert Appleton Company". 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}}. | This template automatically sets some of the parameters passed into {{tl|cite encyclopedia}} for example "publisher = Robert Appleton Company". 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}}. | ||
| − | Minimum is: | + | Minimum is: {{tlc|{{BASEPAGENAME}}|title{{=}}<var>CE article name</var>}} or {{tlc|{{BASEPAGENAME}}|wstitle{{=}}<var>CE article name</var>}}<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 Wikipedia article contains some text copied from somewhere in the 15-volumes of the [Old] Catholic Encyclopedia!</ref> |
| − | Full set is: | + | Full set is:{{tlc|{{BASEPAGENAME}}|wstitle{{=}}|prescript{{=}}|no-icon{{=}}|inline{{=}}|author{{=}}|last{{=}}|first{{=}}|authorlink{{=}}|authors{{=}}|title{{=}}|url{{=}}|accessdate{{=}}|volume{{=}}|page{{=}}|pages{{=}}}} |
{|class=wikitable | {|class=wikitable | ||
|+Additional parameters | |+Additional parameters | ||
| − | !Parameter ||Note | + | !Parameter || Note |
|- | |- | ||
| − | |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 CE 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 CE article on wikisource, and unsets ''title'' and ''url'' if they are also set. |
|- | |- | ||
| − | |inline=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]]). | + | |inline=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]]). |
|- | |- | ||
| − | |no-icon=1 ||Suppresses the lead icon (useful with {{tl|Wikisource-inline}}). | + | |no-icon=1 || Suppresses the lead icon (useful with {{tl|Wikisource-inline}}). |
|- | |- | ||
| − | |prescript=''alternative prescript''||''prescript'' can either be set to an alternative string of text (in which case add ''&nbsp;'' to the end of the string as a separator from the first word of the citation); or if set with no string it will remove prescript string from in front of the citation. | + | |prescript=''alternative prescript'' || ''prescript'' can either be set to an alternative string of text (in which case add ''&nbsp;'' to the end of the string as a separator from the first word of the citation); or if set with no string it will remove prescript string from in front of the citation. |
|- | |- | ||
|} | |} | ||
{|class=wikitable | {|class=wikitable | ||
| − | |+ | + | |+Parameters passed into {{tl|cite encyclopedia}} |
| − | ! | + | !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. |
|- | |- | ||
| − | |first= ||first= ||Set to the value of ''first='' or not set | + | |first= || first= || Set to the value of ''first='' or not set |
|- | |- | ||
| − | |authorlink= || | + | |authorlink= || authorlink= || Set to the value of ''authorlink='' or not set |
|- | |- | ||
| − | | | + | |authors= || authors= || Unlikely to be needed but can be set (or author2= etc.) |
|- | |- | ||
| − | |editor-first= ||Charles || Automatically set within the template | + | |editor-first= || Charles || Automatically set within the template |
|- | |- | ||
| − | |editor-last= ||Herbermann || Automatically set within the template | + | |editor-last= || Herbermann || Automatically set within the template |
|- | |- | ||
| − | |encyclopedia= || [[Catholic Encyclopedia]]||Automatically set within the template | + | |encyclopedia= || [[Catholic Encyclopedia]] || Automatically set within the template |
|- | |- | ||
| − | |title= ||wstitle= or title= ||Set to ''wstitle='' if set | + | |title= || wstitle= or title= || Set to ''wstitle='' if set; if not, then to ''title=''; 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. | + | |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 | |accessdate= || accessdate= || Set to the value of ''accessdate='' or not set | ||
|- | |- | ||
| − | | language=|| | + | | language= || || Not set |
|- | |- | ||
| − | | edition= || | + | | edition= || || Not set |
|- | |- | ||
| − | | date= || ||Not set (see year) | + | | date= || || Not set (see year) |
|- | |- | ||
| − | | year= || defaults to 1913 ||If the ''volume'' parameter is set then | + | | year= || defaults to 1913 || If the ''volume'' parameter is set then |
:vol. set to 1 or 2 sets year to 1907 | :vol. set to 1 or 2 sets year to 1907 | ||
:vol. set to 3 or 4 sets year to 1908 | :vol. set to 3 or 4 sets year to 1908 | ||
| Line 111: | Line 114: | ||
if volume is not set the default is 1913 but setting the ''year'' parameter to some other value overrides the automatic settings. | if volume is not set the default is 1913 but setting the ''year'' parameter to some other value overrides the automatic settings. | ||
|- | |- | ||
| − | + | | publisher= || Robert Appleton Company || automatically set within the template | |
| − | |||
| − | | publisher= ||Robert Appleton Company ||automatically set within the template | ||
|- | |- | ||
| − | | volume= ||volume= ||Set to the value of ''volume='' or not set | + | | volume= || volume= || Set to the value of ''volume='' or not set |
|- | |- | ||
| − | | location= || ||Not set | + | | location= || || Not set |
|- | |- | ||
| − | | id= || ||Not set | + | | id= || || Not set |
|- | |- | ||
| − | | isbn= || ||Not set | + | | isbn= || || Not set |
|- | |- | ||
| − | | oclc= || ||Not set | + | | oclc= || || Not set |
|- | |- | ||
| − | | doi= || ||Not set | + | | doi= || || Not set |
|- | |- | ||
| − | | page= ||page=||Set to the value of ''page='' or not set | + | | page= || page= || Set to the value of ''page='' or not set |
|- | |- | ||
| − | | pages= ||pages=||Set to the value of ''pages='' or not set | + | | pages= || pages= || Set to the value of ''pages='' or not set |
|- | |- | ||
| − | | quote=|| ||Not set | + | | quote= || || Not set |
|- | |- | ||
| − | | ref=||harv||automatically | + | | ref= || harv || Set to the value of ''ref='' or set automatically within the template. This means that {{tl|sfn}} and {{tl|harvnb}} link to this template as intended. (If you need to ask don't worry about it) |
|} | |} | ||
==Hidden categories== | ==Hidden categories== | ||
| − | This template includes | + | This template includes a hidden category as several hidden sub categories: |
| − | *[[:Category:Articles incorporating text from the 1913 Catholic Encyclopedia | + | *[[:Category:Articles incorporating text from the 1913 Catholic Encyclopedia]] |
| − | |||
| − | |||
==See also== | ==See also== | ||
*[[:Category: Catholic Encyclopedia templates]] | *[[:Category: Catholic Encyclopedia templates]] | ||
| + | *{{tl|Cite Catholic Encyclopedia}} for use when a Catholic Encyclopedia article is cited, but the text is not copied into the Wikipedia article. | ||
| + | *{{tl|Catholic Encyclopedia poster}} can be placed in the external links section when a Catholic Encyclopedia article has information relevant to the Wikipedia article but is not cited in the article. | ||
==Notes== | ==Notes== | ||
{{reflist|group=nb}} | {{reflist|group=nb}} | ||
| − | < | + | <includeonly>{{Sandbox other|| |
| − | + | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | |
| − | |||
| − | |||
| − | |||
[[Category:Catholic Encyclopedia templates|{{PAGENAME}}]] | [[Category:Catholic Encyclopedia templates|{{PAGENAME}}]] | ||
| − | + | }}</includeonly> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | </includeonly> | ||
Latest revision as of 01:19, 24 April 2020
| This is a documentation subpage for Template:Catholic Encyclopedia. It contains usage information, categories and other content that is not part of the original template page. |
Note: Due to its public-domain status, the Catholic Encyclopedia can be incorporated into any work, including Wikipedia. When using the material two things should be considered :
- It was written in the first two decades of the Twentieth Century and many parts are dated
- It explicitly follows a Catholic point of view
Contents
Usage
Wikisource
The Catholic Encyclopedia is available on Wikisource at s:Catholic Encyclopedia (1913), and is integrated into this template.
To automatically generate a link to the cited article, use "wstitle=Name of Article".
Quick explanation (aide-mémoire)
The template can be placed in different locations and, depending on what is required, the parameters can be mixed and matched:
| Location | Parameters | Example | Notes |
|---|---|---|---|
| References | {{Catholic Encyclopedia|wstitle=CE name}}
|
Use |wstitle=CE name if the article exists on Wikisource. If not, use |title=CE name
| |
| References | {{Catholic Encyclopedia|title=|url=|first=|last=|volume=|page=}}
|
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.
| |
| Inline citation | {{Catholic Encyclopedia|inline=1|wstitle=CE name}}
|
|inline=1 alters the prescript from "This article..." to "One or more...". Suitable for noting that a paragraph is copied from CE.
| |
| Inline citation | {{Catholic Encyclopedia|prescript=|title=CE name}}
|
|prescript= removes the prescript suitable for a citation where a paragraph is a summary of a paragraph from an CE article and not a copy. |title= for no copy on Wikisource.
| |
| Further reading | {{Catholic Encyclopedia|no-icon=1|prescript=|url=http://...|title=CE name}}
|
Herbermann, Charles, ed. (1913). "St. Theodotus of Ancyra". Catholic Encyclopedia. New York: Robert Appleton Company. | |no-icon=1 removes the lead icon, |prescript= removes the prescript |title= for the article name not yet on Wikisource. |url= for where the text can be found online.
|
| External links | {{Catholic Encyclopedia|no-icon=1|prescript=|wstitle=CE name}}
|
Herbermann, Charles, ed. (1913). "St. Theodotus of Ancyra". Catholic Encyclopedia. New York: Robert Appleton Company. | |no-icon=1 removes the lead icon, |prescript= removes the prescript as the source is not used in the article.
|
Detailed notes
This template is wrapper around {{cite encyclopedia}}. In its default mode it attributes text to an article from the [Old] Catholic Encyclopedia.
This template automatically sets some of the parameters passed into {{cite encyclopedia}} for example "publisher = Robert Appleton Company". Over and above the standard parameter passed into {{cite encyclopedia}} there are some additional parameters and those are listed below in a separate table from the table of parameters passed into {{cite encyclopedia}}.
Minimum is: {{Catholic Encyclopedia|title=CE article name}} or {{Catholic Encyclopedia|wstitle=CE article name}}[nb 1]
Full set is:{{Catholic Encyclopedia|wstitle=|prescript=|no-icon=|inline=|author=|last=|first=|authorlink=}}
| 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 CE article on wikisource, and unsets title and url if they are also set. |
| inline=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 previous section). |
| no-icon=1 | Suppresses the lead icon (useful with {{Wikisource-inline}}). |
| prescript=alternative prescript | prescript can either be set to an alternative string of text (in which case add to the end of the string as a separator from the first word of the citation); or if set with no string it will remove prescript string from in front of the citation. |
| Parameter | Set to | Notes |
|---|---|---|
| last= | author= or last= | If author= and last= are set the value of last= is used. |
| first= | first= | Set to the value of first= or not set |
| authorlink= | authorlink= | Set to the value of authorlink= or not set |
| authors= | authors= | Unlikely to be needed but can be set (or author2= etc.) |
| editor-first= | Charles | Automatically set within the template |
| editor-last= | Herbermann | Automatically set within the template |
| encyclopedia= | Catholic Encyclopedia | Automatically set within the template |
| title= | wstitle= or title= | Set to wstitle= if set; if not, then to title=; 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. |
| accessdate= | accessdate= | Set to the value of accessdate= or not set |
| language= | Not set | |
| edition= | Not set | |
| date= | Not set (see year) | |
| year= | defaults to 1913 | If the volume parameter is set then
if volume is not set the default is 1913 but setting the year parameter to some other value overrides the automatic settings. |
| publisher= | Robert Appleton Company | 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 | |
| ref= | harv | Set to the value of ref= or set automatically within the template. This means that {{sfn}} and {{harvnb}} link to this template as intended. (If you need to ask don't worry about it) |
Hidden categories
This template includes a hidden category as several hidden sub categories:
See also
- Category: Catholic Encyclopedia templates
- {{Cite Catholic Encyclopedia}} for use when a Catholic Encyclopedia article is cited, but the text is not copied into the Wikipedia article.
- {{Catholic Encyclopedia poster}} can be placed in the external links section when a Catholic Encyclopedia article has information relevant to the Wikipedia article but is not cited in the article.
Notes
- ↑ 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 Wikipedia article contains some text copied from somewhere in the 15-volumes of the [Old] Catholic Encyclopedia!