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

From blackwiki
Jump to navigation Jump to search
imported>Howcheng
(new parameter: freearticle)
imported>JJMC89
(mark as wrapper)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
+
{{Documentation subpage}}{{CS1 wrapper|base=cite encyclopedia}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
___FORCETOC__
+
__FORCETOC__
  
 
== Usage ==
 
== Usage ==
'''<code><nowiki>{{Cite ODNB</nowiki>|id=''ODNB article number''|title=''ODNB article name''}}</code>'''
+
'''{{tlc|{{BASEPAGENAME}}|id{{=}}{{var|ODNB article number}}|title{{=}}{{var|ODNB article name}}}}'''
  
For example, '''<code><nowiki>{{Cite ODNB</nowiki>|id=29986|title=Worsley, Sir Richard}}</code>''' displays:
+
For example, '''{{tlc|{{BASEPAGENAME}}|id{{=}}29986|title{{=}}Worsley, Sir Richard}}''' displays:
:{{Cite ODNB|id=29986|title=Worsley, Sir Richard}}
+
:{{{{BASEPAGENAME}}|id=29986|title=Worsley, Sir Richard}}
  
;List of supported parameters (for a fuller explanation see {{Tl|cite encyclopedia}}):
+
'''List of supported parameters'''
These parameters are pre-set but can be overridden with other values
 
* encyclopedia=[[Oxford Dictionary of National Biography]]
 
* edition=online
 
* publisher=[[Oxford University Press]]
 
* ref=harv
 
  
Author names:
+
This template supports all parameters that are supported by {{tlx|cite encyclopedia}}.  These few are pre-set within the template (may be overridden):
* first=''name''; last=''name''; authorlink=''article name''
+
* {{para|encyclopedia|<nowiki>[[Oxford Dictionary of National Biography]]</nowiki>}}
* first2=''name''; last2=''name''; authorlink2=''article name'' — Useful for the name of the reviewer.
+
* {{para|edition|online}}
* first3=''name''; last3=''name''; — There may occasionally be three authors. Currently this template only handles up to three.
+
* {{para|publisher|<nowiki>[[Oxford University Press]]</nowiki>}}
* author=''name''
 
* author2=''name''
 
* author3=''name''
 
  
 
Article titles and identification:
 
Article titles and identification:
* title=''name of the ODNB article''
+
* {{para|title|{{var|name of the ODNB article}}}}
* id=''number'' — This is non standard and consists of the "article number" (the last set of digits of an ODNB doi or biography URL).
+
* {{para|id|{{var|number}}}} — This is nonstandard and consists of the "article number" (the last set of digits of an ODNB doi or biography URL); creates an internal doi if {{para|doi}} not present
* doi=''doi'' — Can be used instead of the parameter <code>id=</code>.
+
* {{para|doi|{{var|doi}}}} — Can be used instead of the parameter {{para|id}}
* url=''URL of the  ODNB article'' — Can be used with or in place of the parameter <code>id=</code>, but is also essential for ODNB non-biography articles such as "Themes" which do not conform to the usual ODNB url biography format and do not have a doi. See, for example:
+
* {{para|url|{{var|URL of the  ODNB article}}}} — Can be used with or in place of the parameter <code>id=</code>, but is also essential for ODNB non-biography articles such as "Themes" which do not conform to the usual ODNB url biography format and do not have a doi. See, for example:
 
** {{Green|Patrick Little, ‘Major-generals (act. 1655–1657)’, Oxford Dictionary of National Biography, Oxford University Press. http://www.oxforddnb.com/view/theme/95468}}  
 
** {{Green|Patrick Little, ‘Major-generals (act. 1655–1657)’, Oxford Dictionary of National Biography, Oxford University Press. http://www.oxforddnb.com/view/theme/95468}}  
** This can be handled like this:
+
** This can be handled like this (url):
** <code><nowiki>{{Cite ODNB |first=Patrick |last=Little |title=Major-generals (act. 1655–1657) |url=http://www.oxforddnb.com/view/theme/95468}}</nowiki></code>
+
**:{{tlc|{{BASEPAGENAME}} |first{{=}}Patrick |last{{=}}Little |title{{=}}Major-generals (act. 1655–1657) |url{{=}}http://www.oxforddnb.com/view/theme/95468}}
** {{Cite ODNB |first=Patrick |last=Little |title=Major-generals (act. 1655–1657) |url=http://www.oxforddnb.com/view/theme/95468}}
+
**::{{{{BASEPAGENAME}} |first=Patrick |last=Little |title=Major-generals (act. 1655–1657) |url=http://www.oxforddnb.com/view/theme/95468}}
 +
** or like this (doi):
 +
**:{{tlc|{{BASEPAGENAME}} |first{{=}}Patrick |last{{=}}Little |title{{=}}Major-generals (act. 1655–1657) |doi{{=}}10.1093/ref:odnb/95468}}
 +
**::{{{{BASEPAGENAME}} |first=Patrick |last=Little |title=Major-generals (act. 1655–1657) |doi=10.1093/ref:odnb/95468}}
 +
** or like this (id):
 +
**:{{tlc|{{BASEPAGENAME}} |first{{=}}Patrick |last{{=}}Little |title{{=}}Major-generals (act. 1655–1657) |id{{=}}95468}}
 +
**::{{{{BASEPAGENAME}} |first=Patrick |last=Little |title=Major-generals (act. 1655–1657) |id=95468}}
 
Years and dates
 
Years and dates
* origyear=''original year'' — The initial year of publication is usually 2004 if there has one or more updates the current year parameter may be different.
+
* {{para|origyear|{{var|original year}}}} — The initial year of publication is usually 2004; if the entry has been updated, the current year parameter may be different.
* year=''year of ODNB article publication''
+
* {{para|year|{{var|year of ODNB article publication}}}}
* date=''date of ODNB article publication'' — If date and year parameters are both set then date parameter value is displayed but year parameter value is used by templates such as {{Tl|harvnb}}.
+
* {{para|date|{{var|date of ODNB article publication}}}} — If date and year parameters are both set then date parameter value is displayed but year parameter value is used by templates such as {{Tl|harvnb}}.
* accessdate=''month year'' — Not needed as the ODNB has both date of article modification, a builtin archive and a doi structure.
+
* {{para|access-date}} — Not needed as the ODNB has both date of article modification, a builtin archive and a doi structure; if used, requires {{para|url}}
  
Some articles are freely available to the public, such as [https://doi.org/10.1093/ref:odnb/37018 Virginia Woolf]. In those cases, you can add the <code>freearticle</code> parameter.
+
Some articles are freely available to the public, such as [https://doi.org/10.1093/ref:odnb/37018 Virginia Woolf]. In those cases, you can add the {{para|freearticle}} parameter.
* freearticle=''y'' (or omit)
+
* {{para|freearticle|y}} (or omit)
 
+
*:{{tlc|{{BASEPAGENAME}} |id{{=}}37018 |title{{=}}Woolf [''née'' Stephen], (Adeline) Virginia |first{{=}}Lyndall |last{{=}}Gordon |freearticle{{=}}y}}
The <code>mode</code> parameter is able to alter the punctuation between fields, and the terminator. The default is [[Help:Citation Style 1|citation style 1]]: "." between fields and at the end. Set <code>mode=cs2</code> to change the appearance of this template to match [[Help:Citation Style 2|citation style 2]], the other commonly used template style of {{Tl|citation}}, which uses "," between fields and nothing at the end.
+
*::{{{{BASEPAGENAME}} |id=37018 |title=Woolf [''née'' Stephen], (Adeline) Virginia |first=Lyndall |last=Gordon |freearticle=y}}
* mode=''cs2'' (or omit)
 
  
 
== Hidden categories ==
 
== Hidden categories ==
Line 52: Line 49:
 
== See also ==
 
== See also ==
 
* {{tl|ODNBsub}} — A subscription template used as a postscript by this template.
 
* {{tl|ODNBsub}} — A subscription template used as a postscript by this template.
* {{tl|DNBfirst}} — Can be placed on the same line as {{Tl|Cite ODNB}} to allow readers who do not have access to ODNB to see older versions of the text now in the public domain. This is particularly useful if there is a version of the text available on Wikisource. Please refrain from using this template if the same DNB article is already available in the Wikipedia article via {{Tl|Cite DNB}} or {{Tl|DNB}}.
+
* {{tl|DNBfirst}} — Can be placed on the same line as {{Tlc|{{BASEPAGENAME}}}} to allow readers who do not have access to ODNB to see older versions of the text now in the public domain. This is particularly useful if there is a version of the text available on Wikisource. Please refrain from using this template if the same DNB article is already available in the Wikipedia article via {{Tl|Cite DNB}} or {{Tl|DNB}}.
 
* {{tl|Who's Who}}
 
* {{tl|Who's Who}}
 
* [[Wikipedia:WikiProject Dictionary of National Biography]].
 
* [[Wikipedia:WikiProject Dictionary of National Biography]].
 
* {{tl|Subscription or libraries}} — A template for use when a subscription may be required or the source may be at a library.
 
* {{tl|Subscription or libraries}} — A template for use when a subscription may be required or the source may be at a library.
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
+
<includeonly>{{sandbox other||
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
+
<!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
 
{{DEFAULTSORT:Cite Odnb}}
 
{{DEFAULTSORT:Cite Odnb}}
 
[[Category:Dictionary of National Biography templates]]
 
[[Category:Dictionary of National Biography templates]]
 
[[Category:Specific-source templates]]
 
[[Category:Specific-source templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 02:33, 19 April 2020


Usage

{{Cite ODNB|id=ODNB article number|title=ODNB article name}}

For example, {{Cite ODNB|id=29986|title=Worsley, Sir Richard}} displays:

"Worsley, Sir Richard". Oxford Dictionary of National Biography (online ed.). Oxford University Press. doi:10.1093/ref:odnb/29986. Template:ODNBsub

List of supported parameters

This template supports all parameters that are supported by {{cite encyclopedia}}. These few are pre-set within the template (may be overridden):

  • |encyclopedia=[[Oxford Dictionary of National Biography]]
  • |edition=online
  • |publisher=[[Oxford University Press]]

Article titles and identification:

Years and dates

  • |origyear=original year — The initial year of publication is usually 2004; if the entry has been updated, the current year parameter may be different.
  • |year=year of ODNB article publication
  • |date=date of ODNB article publication — If date and year parameters are both set then date parameter value is displayed but year parameter value is used by templates such as {{harvnb}}.
  • |access-date= — Not needed as the ODNB has both date of article modification, a builtin archive and a doi structure; if used, requires |url=

Some articles are freely available to the public, such as Virginia Woolf. In those cases, you can add the |freearticle= parameter.

Hidden categories

This template places articles that incorporate it into an administrative hidden category:

Pages using both |id= and |doi= are tracked in Category:Pages using cite ODNB with both doi and id parameters

See also

  • {{ODNBsub}} — A subscription template used as a postscript by this template.
  • {{DNBfirst}} — Can be placed on the same line as {{Cite ODNB}} to allow readers who do not have access to ODNB to see older versions of the text now in the public domain. This is particularly useful if there is a version of the text available on Wikisource. Please refrain from using this template if the same DNB article is already available in the Wikipedia article via {{Cite DNB}} or {{DNB}}.
  • {{Who's Who}}
  • Wikipedia:WikiProject Dictionary of National Biography.
  • {{Subscription or libraries}} — A template for use when a subscription may be required or the source may be at a library.