Editing Template:Bibleverse/doc

{{Documentation subpage}}
{{tsh|bibleref}}
{{High-use}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Bibleverse}}
{{Notice |heading=This template should not be used inline in the body of an article |This template creates an external link, and therefore [[WP:ELBODY|should not be used in the body of an article]]. External links to the Bible should be placed in [[WP:footnotes|footnotes]].}}

This template is used to provide sources for [[Bible citation|Bible verse references]].

This template creates an external link. The [[WP:external links|external links content guideline]] states that external links "should not normally be used in the body of an article". Furthermore, the use of inline parenthetical referencing [[WP:parenthetical citations|is now deprecated]] on Wikipedia. '''Place external links to the Bible in [[WP:footnotes|footnotes]],''' but be aware that the Bible may be considered a [[WP:primary source|primary source]], which should be used with care in sourcing Wikipedia articles.

==Usage==
Code format:
:{{tlc|Bibleverse|''Bible book name''|''c:v&ndash;c:v''|''version''|''text''|nobook{{=}}|wlink{{=}}|multi{{=}}}}

;Optional parameters
:This template has four optional parameters:
:*(fourth parameter) - providing a fourth (unnamed) parameter will show specific text instead of the book/chapter information
:*<code>nobook</code> - When set to "yes", will omit the book from the link. {{t|bibleverse-nb}} can also be used for this feature.
:*<code>wlink</code> - When set to "yes", will wikilink the book name. {{t|bibleverse-lb}} can also be used for this feature.
:*<code>multi</code> - When set to "yes", allows for multiple books/chapters to be viewed on [[BibleGateway]]. See [[#Examples]] for use cases

;Example: {{tlc|_show_result=yes|Bibleverse|Genesis|1:1|KJV}}

* Shorthand can be used for the names, such as '''1 Sam''' or '''Deut'''. See the ''[http://hbl.gcc.libguides.com/BibleAbbrevChicago Chicago Manual of Style]'' for other acceptable abbreviations.
* Verse references may be simplified (for example, no range or entire chapter).

==Examples==
{|class="wikitable"
|Default, link to NRSV||{{tlc|_show_result=yes|Bibleverse|Genesis|1:15–16}}
|-
|Link to KJV (Wikisource)||{{tlc|_show_result=yes|Bibleverse|Genesis|1:15–16|KJV}}
|-
|Omitting the book||{{tlc|_show_result=yes|Bibleverse|Genesis|1:15–16|nobook{{=}}yes}}
|-
|Omitting the book with -nb||{{tlc|_show_result=yes|Bibleverse-nb|Genesis|1:15–16}}
|-
|Wikilinking the book||{{tlc|_show_result=yes|Bibleverse|Genesis|1:15–16|wlink{{=}}yes}}
|-
|Wikilinking the book with -lb||{{tlc|_show_result=yes|Bibleverse-lb|Genesis|1:15–16}}
|-
|Custom text||{{tlc|_show_result=yes|Bibleverse|Genesis|1:15–16|KJV|Example of custom text}}
|-
|Linking to multiple verses||{{tlc|_show_result=yes|Bibleverse|John 20:1–2, 11–18|multi{{=}}yes}}
|}
Note in the above that when {{para|multi|yes}}, the entire search term is in the first parameter.

==List of versions==

The following table holds a list of available Bible versions and the external sites used by the template to link them. If no version is supplied, the default source is the [[New Revised Standard Version]] on the [https://bible.oremus.org/ oremus bible browser] ''unless'' {{para|multi|yes}}, in which case the version will be provided by [[BibleGateway]] based on the best match to its search function. Versions not on this list can be used, which will use BibleGateway's repository.

{|class="wikitable"
!External site
!Code
!Version
!Example usage
|-
| rowspan = 7|[https://www.biblica.com Biblica] || ab || rowspan=5 | [[New International Version|NIV]] || {{Bibleverse|Genesis|1:15–16|ab}}
|-
| amp || {{Bibleverse|Genesis|1:15–16|amp}}
|-
| msg || {{Bibleverse|Genesis|1:15–16|msg}}
|-
| niv || {{Bibleverse|Genesis|1:15–16|niv}}
|-
| nlt || {{Bibleverse|Genesis|1:15–16|nlt}}
|-
| nirv || [[New International Reader's Version|NIrV]] || {{Bibleverse|Genesis|1:15–16|nirv}}
|-
| nivuk || NIV (UK) || {{Bibleverse|Genesis|1:15–16|nivuk}}
|-
| [https://www.esv.org ESV.org] || esv || [[English Standard Version|ESV]] || {{Bibleverse|Genesis|1:15–16|esv}}
|-
| rowspan = 2|[https://mechon-mamre.org/index.htm Mechon Mamre] || jps || [[Jewish Publication Society of America Version|JPS]] || {{Bibleverse|Genesis|1:15–16|jps}}
|-
| he || JPS with Hebrew || {{Bibleverse|Genesis|1:15–16|he}}
|-
| rowspan = 2| [https://bible.oremus.org/ oremus Bible Browser] || nrsv || [[New Revised Standard Version|NRSV]] || {{Bibleverse|Genesis|1:15–16|nrsv}}
|-
| nrsvae || NRSV (UK) || {{Bibleverse|Genesis|1:15–16|nrsvae}}
|-
| [https://bible.usccb.org/bible bible.usccb.org] || nab || [[United States Conference of Catholic Bishops|USCCB]] || {{Bibleverse|Genesis|1:15–16|nab}}
|-
| rowspan = 5 | Wikisource || asv || [[American Standard Version|ASV]] || {{Bibleverse|Genesis|1:15–16|asv}}
|-
| kjv || [[King James Version|King James]] || {{Bibleverse|Genesis|1:15–16|kjv}}
|-
| web || [[World English Bible|World English]] || {{Bibleverse|Genesis|1:15–16|web}}
|-
| ws || [[Wikisource]] || {{Bibleverse|Genesis|1:15–16|ws}}
|-
| wyc || [[Wycliffe's Bible|Wycliffe]] || {{Bibleverse|Genesis|1:15–16|wyc}}
|}

==Redirects==
* This template is the result of many similar templates being merged together. A full list of redirects can be found [https://en.wikipedia.org/wiki/Special:WhatLinksHere?target=Template%3ABibleverse&namespace=&hidetrans=1&hidelinks=1 at this link].

==Wrappers==
* {{t|bibleverse-lb}} ("link book"): used for providing a wikilink to the book.
* {{t|bibleverse-nb}} ("no book"): used for omitting the book name from the link.
* {{t|Tanakhverse}}


==TemplateData==
{{TemplateData header}}
<templatedata>{
	"description": "A template to generate a link to selected Bible editions at several sites including biblegateway.com. This template will create a link with the name of the book and the specified chapter and verse, range(s) of chapter(s) and verse(s), or entire chapter. Add |nobook=yes to create a link without the book name in the anchor text of the link.",
	"params": {
		"1": {
			"label": "Book",
			"description": "The name of the book.",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Chapter:verse",
			"description": "The chapter and verse, range(s) of chapter(s) and verse(s), or entire chapter to be cited (for example: '5:4', '1:1–2', '21:1–24:7', '1:2–3; 13:10', '6').",
			"type": "string",
			"required": true
		},
		"3": {
			"label": "Source",
			"description": "The edition to be cited. Given in common abbreviations (for example, 'KJV', 'NIV', 'ESV', 'NASB', 'HE'). Default is 'NRSV'.",
			"type": "string",
			"required": false
		},
		"4": {
			"label": "Text",
			"description": "Alternate text to be shown in place of the book/chapter information.",
			"type": "string",
			"required": false
		},
		"nobook": {
			"label": "No book",
			"description": "If set to 'yes' will omit the book from the link.",
			"type": "string",
			"required": false
		},
		"wlink": {
			"label": "Wikilink",
			"description": "If set to 'yes' will add a wikilink to the book name.",
			"type": "string",
			"required": false
		},
		"multi": {
			"label": "Multiple verses",
			"description": "Set to 'yes' to allow for multiple chapters/verses to be shown in the results.",
			"type": "string",
			"required": false
		}
	}
}</templatedata><includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Bible external link templates]]
}}</includeonly>