View source for Template:Cite DGRG/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->

==Usage==
This template can be used in place of {{tl|cite encyclopedia}} to indicate that the ''[[Dictionary of Greek and Roman Geography]]'' is being cited to support information in an article. The advantage is that it will fill in certain fields automatically.

The ''Dictionary of Greek and Roman Geography'' (1854–57) is now in the [[public domain]]. Text from the ''DGRG'' is incorporated into an article then use the template {{tl|DGRG}} to attribution the text in compliance with the [[WP:Plagiarism|Plagiarism]] guideline.

===Quick explanation (''aide-mémoire'')===
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
|-
!Parameters||Example||Note
|-Cite DGRG
|<nowiki>{{Cite DGRG|wstitle=</nowiki>''DGRG article name''<nowiki>}}</nowiki>
|{{Cite DGRG|wstitle=Antilibanus}}
|Use '''wstitle=''DGRG article name''''' if the article exists on [[Wikisource]]. if not use '''title=''DGRG article name'' '''
|-
|<nowiki>{{Cite DGRG|title=|url=|first=|last=|volume=|pages=}}</nowiki>
|{{Cite DGRG |title=Antilibanus |first=Edward Boucher |last=James |url=https://books.google.com/books?id=9y0BAAAAQAAJ&pg=PA140#v=onepage&q&f=false |volume=1 |pages=140,141}}
|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'''. Volume also set year.
|}

===Detailed notes===
This template is wrapper around {{tl|cite encyclopedia}}. In its default mode it attributes text to an article from the third edition of the Dictionary of Christian Biography and Literature to the End of the Sixth Century.

This template automatically sets some of the parameters passed into {{tl|cite encyclopedia}} for example "publisher = John Murray". 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:'''<nowiki>{{Cite DGRG|title=</nowiki>''DGRG article name''<nowiki>}}</nowiki>''' or '''<nowiki>{{Cite DGRG|wstitle=</nowiki>''DGRG article name''<nowiki>}}</nowiki>'''

Full set is:'''<nowiki>{{Cite DGRG|</nowiki>wstitle= |no-icon |author= |last= |first= |authorlink= |coauthors= |title= |url= |accessdate= |volume= |page= |pages= |ref=<nowiki>}}</nowiki>'''

{|class=wikitable
|+Additional parameters
!Parameter ||Note
|-
|wstitle=''name of the article on wikisource'' ||If set, set link to a ''DGRG article name'' on wikisource, and unsets ''title'' and ''url'' if they are also set.
|-
|no-icon=1 ||Suppresses the lead icon (useful with {{tl|Wikisource-inline}}).
|-
|short =''x''||use this parameter in the "External links" to shorten the text displayed.
|-
|}

{|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.
|-
|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
|-
|displayauthors= ||  displayauthors= || Unlikely to be needed but can be set
|-
|editor-first= ||William || Automatically set within the template
|-
|editor-last= ||Smith || Automatically set within the template
|-
|editor-link= ||[[William Smith (lexicographer)]]||Automatically set within the template
|-
|encyclopedia= || [[Dictionary of Greek and Roman Geography]]|| Automatically set within the template
|-
|title= ||wstitle= or title=||Set to ''wstitle='' if set, if not to ''title='' 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.  If not set then a red super script warning string "<sup>[[s:Dictionary of Christian Biography and Literature to the End of the Sixth Century|<span style="color:red">article name needed</span>]]</sup>" is displayed. The red text links to the Wikisource page [[s:Dictionary of Christian Biography and Literature to the End of the Sixth Century]].
|-
|accessdate= || accessdate= || Set to the value of ''accessdate='' or not set
|-
| language=||  ||Not set 
|-
| edition= ||  ||Not set 
|-
| date= || ||Not set (see year)
|-
| year= ||1854–57||Automatically set within the template unless a year or a volume ''(volume=1'' sets ''year=1854'', ''volume=2'' sets ''year=1857'')
|-
| month= || ||Not set
|-
| publisher= ||John Murray ||automatically set within the template
|-
| volume= ||volume= ||Set to the value of ''volume='' or not set
|-
| location= || ||London
|-
| 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
|}

== Hidden categories ==
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 DGRG with no article parameter]]
*[[:Category:Wikipedia articles incorporating a citation from the DGRG without Wikisource reference]]
*[[:Category:Wikipedia articles incorporating a citation from the DGRG with Wikisource reference]]
For an overview group category of the above see:[[:Category:Wikipedia articles incorporating a citation from the DGRG]]

== See also ==
* {{tl|DGRG}}—calls this template, but a prescript for attribution of directly copied text.
* {{tl|DGRG poster}}—places article in a box. For user in an external links section.

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

<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->

{{DEFAULTSORT:Dgrg Cite}}
[[Category:Dictionary source templates]]
[[Category:Wikisource link templates]]
}}</includeonly>