Difference between revisions of "Template:Bibleref2/doc"

From blackwiki
Jump to navigation Jump to search
imported>Afaprof01
imported>Vanisaac
m (→‎Related templates: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(33 intermediate revisions by 14 users not shown)
Line 1: Line 1:
== See also ==
+
{{documentation subpage}}
* [[Template:Bibleref2-nb]]
 
:Suppresses display of the Book for 2nd and subsequent sequential uses. Example: {{Bibleref2|John|3:16}}, {{bibleref2-nb|Jn|4:2}}, {{bibleref2-nb|Jn|5:8}}
 
* [[Template:Bibleref2c]]
 
:Puts citation into square brackets and displays it as superscript like typical references display. This is an example.{{Bibleref2c|Rom.|10:9-10}} Abbreviating Book names may significantly improve the appearance of Bible references displayed in citation or reference style.
 
*[[Template:Bibleref2c-nb]]
 
:Combines the superscript citation style and suppresses Book name for sequential citations from the same Book. Example: {{Bibleref2c|John|3:16}} {{bibleref2c-nb|Jn|4:2}} {{bibleref2c-nb|Jn|5:8}}
 
  
==Documentation==
+
== Purpose ==
{{bibleref2|John|3:16-18}}
+
This template inserts an external link to a Bible reference at [http://www.biblegateway.com/ biblegateway.com], allowing for choice of translation.
 
 
Format: <nowiki> {{bibleref2|BOOKNAME|c:v-c:v|Display_reference|translation_code}} </nowiki><br><br>
 
 
 
NOTE: You can use shorthand for the names, such as '''1Jn''', '''2Tim''', '''2Sam.''' or '''Deut.'''. Periods are optional. Also, verse references may be simplified (for example, no range or entire chapter).
 
 
 
You may omit the verses and list only a chapter, like '''|John|1|'''
 
The only required parameters are the |Book| and at least |chapter|.
 
  
'''DO NOT put any spaces anywhere in the template.'''
+
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." Consider placing external links to the Bible in [[WP: parenthetical citations|parenthetical citations]] or [[WP:footnotes|footnotes]], but be aware that the Bible may be considered a [[WP:primary source|primary source]].
  
== Examples ==
+
==Format==
Please see next section for discussion about abbreviations for the version of the Bible.
+
<pre><nowiki>{{bibleref2|BOOKNAME|c:v-c:v|Optional_Bible_Version|Optional_Display}}</nowiki></pre>
  
 +
==Examples==
 
{|
 
{|
|'''CODE'''||'''RESULT'''
 
 
|-
 
|-
| <pre>
+
! Code
{{bibleref2|John|3:16|}}
+
! Result
</pre>||{{bibleref2|John|3:16}}
 
 
|-
 
|-
|<pre>
+
| <code><nowiki>{{bibleref2|John|3:16|NASB}}</nowiki></code>
{{bibleref2|John|3:16-18|NKJV|John 3:16-18}}
+
| {{bibleref2|John|3:16|NASB}}
</pre>||{{bibleref2|John|3:16-18|NKJV|John 3:16-18}}
 
 
|-
 
|-
|| <pre>
+
| <code><nowiki>{{bibleref2|2 Pet. 1:21}}</nowiki></code>
{{bibleref2|1Jn|1:9-2:11||ASV|1 John 1:9ff}}
+
| {{bibleref2|2 Pet. 1:21}}
</pre>||{{bibleref2|1Jn|1:9-2:11|ASV|1 John 1:9ff}}
 
 
|-
 
|-
|| <pre>
+
| <code><nowiki>{{bibleref2|Gen|1:1|KJV|Creation}}</nowiki></code>
{{bibleref2|1Cor|13|AMP|1 Cor. 13}}
+
| {{bibleref2|Gen|1:1|KJV|Creation}}
</pre>||{{bibleref2|1Cor|13|AMP|1 Cor. 13}}
 
 
|-
 
|-
|| <pre>
+
| <code><nowiki>{{bibleref2|1Jn|1:9-2:11|NKJV|1 John 1:9ff}}</nowiki></code>
{{bibleref2|Gen.|1:1||Creation}}
+
| {{bibleref2|1Jn|1:9-2:11|NKJV|1 John 1:9ff}}
</pre>||{{bibleref2|Gen.|1:1||Creation}}
 
 
|-
 
|-
 +
| <code><nowiki>{{bibleref2|Mt 3:7–10; Lk 3:7–9||!}}</nowiki></code>
 +
| {{bibleref2|Mt 3:7–10; Lk 3:7–9||!}}
 
|}
 
|}
  
=Documentation=
+
==Parameters==
== Purpose ==
+
{{TemplateDataHeader}}
 +
<templatedata>{
 +
  "description": "Creates a Bible citation with a link to the cited passage at BibleGateway.",
 +
  "params": {
 +
    "1": {
 +
      "label": "Book",
 +
      "description": "The book of the Bible, in full (e.g. \"1 John\") or abbreviated (e.g. \"1Jn\"). Periods and spaces are optional. Alternatively, instead of specifying just the book here and then the chapter and verse separately, the entire citation, even to multiple passages in multiple books, can be specified here.",
 +
      "type": "string",
 +
      "required": true
 +
    },
 +
    "2": {
 +
      "label": "Chapter:Verse",
 +
      "description": "The chapter and verse within the book (e.g., \"3:16\"). May also be a range or series.",
 +
      "type": "string",
 +
      "required": false
 +
    },
 +
    "3": {
 +
      "label": "Version",
 +
      "description": "The translation version to use (e.g., \"NASB\"). Use \"!\" for BibleGateway's default.",
 +
      "type": "string",
 +
      "required": false,
 +
      "default": "NRSV"
 +
    },
 +
    "4": {
 +
      "label": "Display Text",
 +
      "description": "If specified, the text to display instead of the book, chapter, and verse.",
 +
      "type": "string",
 +
      "required": false
 +
    }
 +
  }
 +
}</templatedata>
  
This template inserts an external link to a Bible reference at [http://www.biblegateway.com/ biblegateway.com], allowing for choice of translation.
+
==Names of Books, Numerical ID, Standard Abbreviation==
 +
{{div col|colwidth=24em}}
 +
{| class="wikitable"
 +
|-
 +
! Book
 +
! Book ID
 +
! Standard Abbreviation
 +
|-
 +
| Genesis
 +
| 1
 +
| GEN
 +
|-
 +
| Exodus
 +
| 2
 +
| EXOD
 +
|-
 +
| Leviticus
 +
| 3
 +
| LEV
 +
|-
 +
| Numbers
 +
| 4
 +
| NUM
 +
|-
 +
| Deuteronomy
 +
| 5
 +
| DEUT
 +
|-
 +
| Joshua
 +
| 6
 +
| JOSH
 +
|-
 +
| Judges
 +
| 7
 +
| JUDG
 +
|-
 +
| Ruth
 +
| 8
 +
| RUTH
 +
|-
 +
| 1 Samuel
 +
| 9
 +
| 1SAM
 +
|-
 +
| 2 Samuel
 +
| 10
 +
| 2SAM
 +
|-
 +
| 1 Kings
 +
| 11
 +
| 1KGS
 +
|-
 +
| 2 Kings
 +
| 12
 +
| 2KGS
 +
|-
 +
| 1 Chronicles
 +
| 13
 +
| 1CHRO
 +
|-
 +
| 2 Chronicles
 +
| 14
 +
| 2CHRO
 +
|-
 +
| Ezra
 +
| 15
 +
| EZRA
 +
|-
 +
| Nehemiah
 +
| 16
 +
| NEH
 +
|-
 +
| Tobit
 +
| 17
 +
| TOB
 +
|-
 +
| Judith
 +
| 18
 +
| JDT
 +
|-
 +
| Esther
 +
| 19
 +
| ESTH
 +
|-
 +
| 1 Maccabees
 +
| 20
 +
| 1MA
 +
|-
 +
| 2 Maccabees
 +
| 21
 +
| 2MA
 +
|-
 +
| Job
 +
| 22
 +
| JOB
 +
|}
 +
{| class="wikitable"
 +
|-
 +
! Book
 +
! Book ID
 +
! Standard Abbreviation
 +
|-
 +
| Psalms
 +
| 23
 +
| PSA
 +
|-
 +
| Proverbs
 +
| 24
 +
| PROV
 +
|-
 +
| Ecclesiastes
 +
| 25
 +
| ECC
 +
|-
 +
| Song of Solomon
 +
| 26
 +
| SONG
 +
|-
 +
| Wisdom
 +
| 27
 +
| WIS
 +
|-
 +
| Sirach
 +
| 28
 +
| SIR
 +
|-
 +
| Isaiah
 +
| 29
 +
| ISA
 +
|-
 +
| Jeremiah
 +
| 30
 +
| JER
 +
|-
 +
| Lamentations
 +
| 31
 +
| LAM
 +
|-
 +
| Baruch
 +
| 32
 +
| BAR
 +
|-
 +
| Ezekiel
 +
| 33
 +
| EZEK
 +
|-
 +
| Daniel
 +
| 34
 +
| DAN
 +
|-
 +
| Hosea
 +
| 35
 +
| HOSEA
 +
|-
 +
| Joel
 +
| 36
 +
| JOEL
 +
|-
 +
| Amos
 +
| 37
 +
| AMOS
 +
|-
 +
| Obadiah
 +
| 38
 +
| OBAD
 +
|-
 +
| Jonah
 +
| 39
 +
| JONAH
 +
|-
 +
| Micah
 +
| 40
 +
| MICAH
 +
|-
 +
| Nahum
 +
| 41
 +
| NAHUM
 +
|-
 +
| Habakkuk
 +
| 42
 +
| HAB
 +
|-
 +
| Zephaniah
 +
| 43
 +
| ZEPH
 +
|-
 +
| Haggai
 +
| 44
 +
| HAG
 +
|-
 +
| Zechariah
 +
| 45
 +
| ZECH
 +
|-
 +
| Malachi
 +
| 46
 +
| MAL
 +
|}
 +
{| class="wikitable"
 +
|-
 +
! Book
 +
! Book ID
 +
! Standard Abbreviation
 +
|-
 +
| Matthew
 +
| 47
 +
| MATT or MT
 +
|-
 +
| Mark
 +
| 48
 +
| MARK or MK
 +
|-
 +
| Luke
 +
| 49
 +
| LUKE or LK or LU
 +
|-
 +
| John
 +
| 50
 +
| JOHN or JN
 +
|-
 +
| Acts
 +
| 51
 +
| ACTS or AC
 +
|-
 +
| Romans
 +
| 52
 +
| ROM
 +
|-
 +
| 1 Corinthians
 +
| 53
 +
| 1COR
 +
|-
 +
| 2 Corinthians
 +
| 54
 +
| 2COR
 +
|-
 +
| Galatians
 +
| 55
 +
| GAL
 +
|-
 +
| Ephesians
 +
| 56
 +
| EPH
 +
|-
 +
| Philippians
 +
| 57
 +
| PHIL
 +
|-
 +
| Colossians
 +
| 58
 +
| COL
 +
|-
 +
| 1 Thessalonians
 +
| 59
 +
| 1THES
 +
|-
 +
| 2 Thessalonians
 +
| 60
 +
| 2THES
 +
|-
 +
| 1 Timothy
 +
| 61
 +
| 1TIM
 +
|-
 +
| 2 Timothy
 +
| 62
 +
| 2TIM
 +
|-
 +
| Titus
 +
| 63
 +
| TIT
 +
|-
 +
| Philemon
 +
| 64
 +
| PHILE
 +
|-
 +
| Hebrews
 +
| 65
 +
| HEB
 +
|-
 +
| James
 +
| 66
 +
| JAS
 +
|-
 +
| 1 Peter
 +
| 67
 +
| 1PET
 +
|-
 +
| 2 Peter
 +
| 68
 +
| 2PET
 +
|-
 +
| 1 John
 +
| 69
 +
| 1JOHN or 1JN
 +
|-
 +
| 2 John
 +
| 70
 +
| 2JOHN or 2JN
 +
|-
 +
| 3 John
 +
| 71
 +
| 3JOHN or 3JN
 +
|-
 +
| Jude
 +
| 72
 +
| JUDE
 +
|-
 +
| Revelation
 +
| 73
 +
| REV
 +
|}
 +
{{div col end}}
  
==Available translations==
+
==Available versions==
Translations available through Biblegateway.com may be found at http://www.biblegateway.com/usage/linking/versionslist.php
 
  
== Usage ==
+
For the complete list of available versions, see [http://classic.biblegateway.com/versions/ http://classic.biblegateway.com/versions/].
Examples:
 
  
<pre>{{bibleref2|John|3:16}}</pre>
+
;Version and Abbreviation
or
 
<pre>{{bibleref2|John|3:16|NKJV}}</pre>
 
or
 
<pre>{{bibleref2|Jn|3:16|NKJV|John 3:16, NKJV}}</pre>
 
  
*'''Book''' is the [[Books of the bible|Bible book]] name in any abbreviation allowed by [http://www.biblegateway.com/ biblegateway.com]. It must not contain any blanks! Therefore, ''<tt>1Cor</tt> instead of <tt>1 Cor</tt><br>''
+
{{columns-list|colwidth=22em|
*'''Reference''' is the chapter, chapter-and-verse, or chapter-and-verse range within the book; if omitted, it defaults to Chapter 1.
+
* 21st Century King James Version (KJ21)
*<u>OPTIONAL</u>: '''Translation_Abbreviation''' is the  translation name abbreviation, such as NIV, KJV, NKJV, NASB, TLB, etc. If omitted, it defaults to '''TNIV'''. NOTE: '''RSV''' is ''not'' available. For complete list of available translations, see http://www.biblegateway.com/usage/linking/versionslist.php. Editor must use standard ''alphabetic'' abbreviations, not numerical ones.
+
* American Standard Version (ASV)
*<u>OPTIONAL</u>: ''Display_reference'' is the display choice of the editor. If omitted, then the ''Book'' and ''Reference'' will be displayed. Some uses for ''Display_reference'' include the ability to:
+
* Amplified Bible (AMP)
**spell out a numbered book like "1 Timothy" instead of the default display of "1Timothy"
+
* Contemporary English Version (CEV)
**add the version such as "(NASB");
+
* Darby Translation (DARBY)
**indicate any other note to be displayed as part of the link.
+
* Douay-Rheims 1899 American Edition (DRA)
 +
* English Standard Version (ESV)
 +
* Good News Translation (GNT)
 +
* Holman Christian Standard Bible (HCSB)
 +
* King James Version (KJV)
 +
* New American Standard Bible (NASB)
 +
* New Century Version (NCV)
 +
* New International Reader's Version (NIRV)
 +
* New International Version (NIV)
 +
* New International Version - UK (NIVUK)
 +
* New King James Version (NJKV)
 +
* New Living Translation (NLT)
 +
* New Revised Standard Version (NRSV)
 +
* The Message (MSG)
 +
* Worldwide English (New Testament) (WE)
 +
* Wycliffe New Testament (WYC)
 +
* Young's Literal Translation (YLT)
 +
}}
  
 
==Differences from Template '''bibleref'''==
 
==Differences from Template '''bibleref'''==
Similar to Template '''bibleref''' with three main differences:
+
Similar to {{Tl|Bibleref}} with three main differences:
#This template always defaults to TNIV if translation_abbr is left blank.
 
 
#It always produces a link to '''biblegateway.com'''
 
#It always produces a link to '''biblegateway.com'''
#It allows a display reference as the fourth parameter
+
#It allows a display reference as the fourth parameter. When the 4th parameter has contents, they will be all that is displayed. Otherwise, the Book-Chapter-Verse range of the 2nd parameter will print exactly as it is entered.
&#123;&#123;[[Template:Bibleref2|bibleref2]]&#125;&#125;&#32;&mdash;
 
  
{{Seealso|Template:Bibleref2-nb|Template:Bibleref2c|Template:Bibleref2c-nb}}
+
== Related templates ==
 +
* [[Template:Bibleref2-nb]]
 +
:Suppresses display of the Book for 2nd and subsequent sequential uses. Example: {{Bibleref2|John|3:16}}, {{bibleref2-nb|Jn|4:2}}, {{bibleref2-nb|Jn|5:8}}
 +
* [[Template:Bibleref2c]]
 +
:Puts citation into square brackets and displays it as superscript like typical references display. This is an example.{{Bibleref2c|Rom.|10:9-10}} Abbreviating Book names may significantly improve the appearance of Bible references displayed in citation or reference style.
 +
* [[Template:Bibleref2c-nb]]
 +
:Combines the superscript citation style and suppresses Book name for sequential citations from the same Book. Example: {{Bibleref2c|John|3:16}} {{bibleref2c-nb|Jn|4:2}} {{bibleref2c-nb|Jn|5:8}}
 +
* [[Template:Bibleref]]
 +
:The template mentioned above, which differs in 3 ways, as stated above.
  
== Added documentation ==
+
<includeonly>{{Sandbox other||<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
; Created : [[User:Afaprof01|Afaprof01]] 23:35, 24 April 2007 (UTC)
+
[[Category:Bible external link templates]]
 +
}}</includeonly>

Latest revision as of 23:54, 23 April 2020

Purpose

This template inserts an external link to a Bible reference at biblegateway.com, allowing for choice of translation.

This template creates an external link. The external links content guideline states that "external links should not normally be used in the body of an article." Consider placing external links to the Bible in parenthetical citations or footnotes, but be aware that the Bible may be considered a primary source.

Format

{{bibleref2|BOOKNAME|c:v-c:v|Optional_Bible_Version|Optional_Display}}

Examples

Code Result
{{bibleref2|John|3:16|NASB}} John 3:16Template:Only in print
{{bibleref2|2 Pet. 1:21}} 2 Pet. 1:21Template:Only in print
{{bibleref2|Gen|1:1|KJV|Creation}} CreationTemplate:Only in print
{{bibleref2|1Jn|1:9-2:11|NKJV|1 John 1:9ff}} 1 John 1:9ffTemplate:Only in print
{{bibleref2|Mt 3:7–10; Lk 3:7–9||!}} Mt 3:7–10; Lk 3:7–9Template:Only in print

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Bibleref2

Creates a Bible citation with a link to the cited passage at BibleGateway.

Template parameters

ParameterDescriptionTypeStatus
Book1

The book of the Bible, in full (e.g. "1 John") or abbreviated (e.g. "1Jn"). Periods and spaces are optional. Alternatively, instead of specifying just the book here and then the chapter and verse separately, the entire citation, even to multiple passages in multiple books, can be specified here.

Stringrequired
Chapter:Verse2

The chapter and verse within the book (e.g., "3:16"). May also be a range or series.

Stringoptional
Version3

The translation version to use (e.g., "NASB"). Use "!" for BibleGateway's default.

Default
NRSV
Stringoptional
Display Text4

If specified, the text to display instead of the book, chapter, and verse.

Stringoptional

Names of Books, Numerical ID, Standard Abbreviation

Book Book ID Standard Abbreviation
Genesis 1 GEN
Exodus 2 EXOD
Leviticus 3 LEV
Numbers 4 NUM
Deuteronomy 5 DEUT
Joshua 6 JOSH
Judges 7 JUDG
Ruth 8 RUTH
1 Samuel 9 1SAM
2 Samuel 10 2SAM
1 Kings 11 1KGS
2 Kings 12 2KGS
1 Chronicles 13 1CHRO
2 Chronicles 14 2CHRO
Ezra 15 EZRA
Nehemiah 16 NEH
Tobit 17 TOB
Judith 18 JDT
Esther 19 ESTH
1 Maccabees 20 1MA
2 Maccabees 21 2MA
Job 22 JOB
Book Book ID Standard Abbreviation
Psalms 23 PSA
Proverbs 24 PROV
Ecclesiastes 25 ECC
Song of Solomon 26 SONG
Wisdom 27 WIS
Sirach 28 SIR
Isaiah 29 ISA
Jeremiah 30 JER
Lamentations 31 LAM
Baruch 32 BAR
Ezekiel 33 EZEK
Daniel 34 DAN
Hosea 35 HOSEA
Joel 36 JOEL
Amos 37 AMOS
Obadiah 38 OBAD
Jonah 39 JONAH
Micah 40 MICAH
Nahum 41 NAHUM
Habakkuk 42 HAB
Zephaniah 43 ZEPH
Haggai 44 HAG
Zechariah 45 ZECH
Malachi 46 MAL
Book Book ID Standard Abbreviation
Matthew 47 MATT or MT
Mark 48 MARK or MK
Luke 49 LUKE or LK or LU
John 50 JOHN or JN
Acts 51 ACTS or AC
Romans 52 ROM
1 Corinthians 53 1COR
2 Corinthians 54 2COR
Galatians 55 GAL
Ephesians 56 EPH
Philippians 57 PHIL
Colossians 58 COL
1 Thessalonians 59 1THES
2 Thessalonians 60 2THES
1 Timothy 61 1TIM
2 Timothy 62 2TIM
Titus 63 TIT
Philemon 64 PHILE
Hebrews 65 HEB
James 66 JAS
1 Peter 67 1PET
2 Peter 68 2PET
1 John 69 1JOHN or 1JN
2 John 70 2JOHN or 2JN
3 John 71 3JOHN or 3JN
Jude 72 JUDE
Revelation 73 REV

Available versions

For the complete list of available versions, see http://classic.biblegateway.com/versions/.

Version and Abbreviation
  • 21st Century King James Version (KJ21)
  • American Standard Version (ASV)
  • Amplified Bible (AMP)
  • Contemporary English Version (CEV)
  • Darby Translation (DARBY)
  • Douay-Rheims 1899 American Edition (DRA)
  • English Standard Version (ESV)
  • Good News Translation (GNT)
  • Holman Christian Standard Bible (HCSB)
  • King James Version (KJV)
  • New American Standard Bible (NASB)
  • New Century Version (NCV)
  • New International Reader's Version (NIRV)
  • New International Version (NIV)
  • New International Version - UK (NIVUK)
  • New King James Version (NJKV)
  • New Living Translation (NLT)
  • New Revised Standard Version (NRSV)
  • The Message (MSG)
  • Worldwide English (New Testament) (WE)
  • Wycliffe New Testament (WYC)
  • Young's Literal Translation (YLT)

Differences from Template bibleref

Similar to {{Bibleref}} with three main differences:

  1. It always produces a link to biblegateway.com
  2. It allows a display reference as the fourth parameter. When the 4th parameter has contents, they will be all that is displayed. Otherwise, the Book-Chapter-Verse range of the 2nd parameter will print exactly as it is entered.

Related templates

Suppresses display of the Book for 2nd and subsequent sequential uses. Example: John 3:16Template:Only in print, 4:2Template:Only in print, 5:8Template:Only in print
Puts citation into square brackets and displays it as superscript like typical references display. This is an example.[Rom. 10:9-10]Template:Only in print Abbreviating Book names may significantly improve the appearance of Bible references displayed in citation or reference style.
Combines the superscript citation style and suppresses Book name for sequential citations from the same Book. Example: [John 3:16]Template:Only in print [4:2]Template:Only in print [5:8]Template:Only in print
The template mentioned above, which differs in 3 ways, as stated above.