Difference between revisions of "Template:Bibleref2/doc"

From blackwiki
Jump to navigation Jump to search
imported>GregorB
(+cat)
imported>Jerome Charles Potts
(clean-up)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 
+
== Purpose ==
== See also ==
+
This template inserts an external link to a Bible reference at [http://www.biblegateway.com/ biblegateway.com], allowing for choice of translation.
* [[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}}
 
  
 
==Format==
 
==Format==
Format: <nowiki> {{bibleref2|BOOKNAME|c:v-c:v|Optional_ Bible_Version|Optional_Display}} </nowiki><br><br>
+
:<nowiki>{{bibleref2|BOOKNAME|c:v-c:v|Optional_Bible_Version|Optional_Display}}</nowiki>
  
Examples:<nowiki>{{bibleref2|1John|1:9}}</nowiki><br>
+
==Parameters==
<nowiki>{{bibleref2|1John|1:9|NIV}}</nowiki><br><nowiki>{{bibleref2|1John|1:9|NIV|1 John 1:9}}</nowiki>
+
;BOOKNAME:You can use full name or standard abbreviation for the name of the Bible book, such as '''Mark''', '''1Jn''', '''2Tim''', '''2Sam.''' or '''Deut.''' Periods are optional.
 
+
;c<nowiki>:</nowiki>v-c<nowiki>:</nowiki>v:Chapter, Chapter:Verse, Chapter:Verses, Chapter-Chapter, Chapter:Verse-Chapter:Verse
Explanations:<br>
+
::Valid examples:3 3:16 3:16-18 3:16-4:18 3:16-18,4:2
*'''BOOKNAME:''' You can use full name or standard abbreviation for the name of the Bible book, such as '''Mark''', '''1Jn''', '''2Tim''', '''2Sam.''' or '''Deut.''' Periods are optional.
+
::You may omit the verses and list only a chapter, like '''|John|1|'''
 
+
*The only required parameters are the |Book| and at least |chapter|
*'''c:v-c:v''' Chapter, Chapter:Verse, Chapter:Verses, Chapter-Chapter, Chapter:Verse-Chapter:Verse
+
*The ''Optional_Bible_Version'' parameter are those abbreviations listed at http://www.biblegateway.com/versions/. The present default is biblegateway's default. Please notice that many foreign language versions are available.
 
+
*The ''Optional_Display'' can be any text you want to appear at the end. For example, <nowiki>{{Bibleref2|2Tim|2:15||2 Timothy 2:15}}</nowiki> will display {{Bibleref2|2Tim|2:15||2 Timothy 2:15}} instead of 2Tim 2:15. You also could add an abbreviation in front of Optional_Display parameter. For instance, <nowiki>{{Bibleref2|2Tim|2:15||cf. 2 Timothy 2:15}}</nowiki>
**'''Legal examples:''' 3 3:16 3:16-18 3:16-4:18 3:16-18,4:2
 
 
 
**You may omit the verses and list only a chapter, like '''|John|1|'''
 
 
 
**The only required parameters are the |Book| and at least |chapter|
 
 
 
*The '''Optional_ Bible_Version'' parameter are those abbreviations listed at http://www.biblegateway.com/versions/. The present default is biblegateway's default. Please notice that many foreign language versions are available.
 
 
 
*The '''Optional_Display''' can be any text you want to appear at the end. For example, {{Bibleref2|2Tim|2:15||2 Timothy 2:15}} will display 2 Timothy 2:15 instead of 2Tim 2:15. You also could add an abbreviation in front of Optional_Display parameter. For instance, {{Bibleref2|2Tim|2:15||cf. 2 Timothy 2:15}}
 
  
 
'''DO NOT put any spaces anywhere in the template.'''
 
'''DO NOT put any spaces anywhere in the template.'''
Line 357: Line 342:
  
 
== Examples ==
 
== Examples ==
Please see next section for discussion about abbreviations for the version of the Bible.
+
:<nowiki>{{bibleref2|1John|1:9}}</nowiki>
 
+
:<nowiki>{{bibleref2|1John|1:9|NIV}}</nowiki>
 +
:<nowiki>{{bibleref2|1John|1:9|NIV|1 John 1:9}}</nowiki>
 
{|
 
{|
|'''CODE'''||'''RESULT'''
+
!Code!!Result
 
|-
 
|-
| <pre>
+
|<nowiki>{{bibleref2|John|3:16|}}</nowiki>||{{bibleref2|John|3:16}}
{{bibleref2|John|3:16|}}
 
</pre>||{{bibleref2|John|3:16}}
 
 
|-
 
|-
|<pre>
+
|<nowiki>{{bibleref2|John|3:16-18|NKJV|John 3:16-18}}</nowiki>||{{bibleref2|John|3:16-18|NKJV|John 3:16-18}}
{{bibleref2|John|3:16-18|NKJV|John 3:16-18}}
 
</pre>||{{bibleref2|John|3:16-18|NKJV|John 3:16-18}}
 
 
|-
 
|-
|| <pre>
+
|<nowiki>{{bibleref2|1Jn|1:9-2:11||ASV|1 John 1:9ff}}</nowiki>||{{bibleref2|1Jn|1:9-2:11|ASV|1 John 1:9ff}}
{{bibleref2|1Jn|1:9-2:11||ASV|1 John 1:9ff}}
 
</pre>||{{bibleref2|1Jn|1:9-2:11|ASV|1 John 1:9ff}}
 
 
|-
 
|-
|| <pre>
+
|<nowiki>{{bibleref2|1Cor|13|AMP|1 Cor. 13}}</nowiki>||{{bibleref2|1Cor|13|AMP|1 Cor. 13}}
{{bibleref2|1Cor|13|AMP|1 Cor. 13}}
 
</pre>||{{bibleref2|1Cor|13|AMP|1 Cor. 13}}
 
|-
 
|| <pre>
 
{{bibleref2|Gen.|1:1||Creation}}
 
</pre>||{{bibleref2|Gen.|1:1||Creation}}
 
 
|-
 
|-
 +
|<nowiki>{{bibleref2|Gen.|1:1||Creation}}</nowiki>||{{bibleref2|Gen.|1:1||Creation}}
 
|}
 
|}
 
=Documentation=
 
== Purpose ==
 
 
This template inserts an external link to a Bible reference at [http://www.biblegateway.com/ biblegateway.com], allowing for choice of translation.
 
 
==Available translations==
 
Translations available through Biblegateway.com may be found at http://www.biblegateway.com/usage/linking/versionslist.php
 
 
== Usage ==
 
Examples:
 
 
<pre>{{bibleref2|John|3:16}}</pre>
 
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>''
 
*'''Reference''' is the chapter, chapter-and-verse, or chapter-and-verse range within the book; if omitted, it defaults to Chapter 1.
 
*<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.
 
*<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:
 
**spell out a numbered book like "1 Timothy" instead of the default display of "1Timothy"
 
**add the version such as "(NASB");
 
**indicate any other note to be displayed as part of the link.
 
  
 
==Differences from Template '''bibleref'''==
 
==Differences from Template '''bibleref'''==
Line 414: Line 364:
 
#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
&#123;&#123;[[Template:Bibleref2|bibleref2]]&#125;&#125;&#32;&mdash;
 
  
{{Seealso|Template:Bibleref2-nb|Template:Bibleref2c|Template:Bibleref2c-nb}}
+
== See also ==
 
+
* [[Template:Bibleref2-nb]]
== Added documentation ==
+
: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}}
; Created : [[User:Afaprof01|Afaprof01]] 23:35, 24 April 2007 (UTC)
+
* [[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}}
  
<includeonly>
+
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Bible link templates]]
 
[[Category:Bible link templates]]
 
[[simple:Template:Bibleref2]]
 
[[simple:Template:Bibleref2]]
 
</includeonly>
 
</includeonly>

Revision as of 07:09, 23 October 2010

Purpose

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

Format

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

Parameters

BOOKNAME
You can use full name or standard abbreviation for the name of the Bible book, such as Mark, 1Jn, 2Tim, 2Sam. or Deut. Periods are optional.
c:v-c:v
Chapter, Chapter:Verse, Chapter:Verses, Chapter-Chapter, Chapter:Verse-Chapter:Verse
Valid examples:3 3:16 3:16-18 3:16-4:18 3:16-18,4:2
You may omit the verses and list only a chapter, like |John|1|
  • The only required parameters are the |Book| and at least |chapter|
  • The Optional_Bible_Version parameter are those abbreviations listed at http://www.biblegateway.com/versions/. The present default is biblegateway's default. Please notice that many foreign language versions are available.
  • The Optional_Display can be any text you want to appear at the end. For example, {{Bibleref2|2Tim|2:15||2 Timothy 2:15}} will display 2 Timothy 2:15Template:Only in print instead of 2Tim 2:15. You also could add an abbreviation in front of Optional_Display parameter. For instance, {{Bibleref2|2Tim|2:15||cf. 2 Timothy 2:15}}

DO NOT put any spaces anywhere in the template.

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

Psalm 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

Matthew 47 MATT

Mark 48 MARK

Luke 49 LUKE

John 50 JOHN

Acts 51 ACTS

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

2 John 70 2JOHN

3 John 71 3JOHN

Jude 72 JUDE

Revelation 73 REV

Available ENGLISH 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
The Message (MSG)
Today's New International Version (TNIV)
Worldwide English (New Testament) (WE)
Wycliffe New Testament (WYC) Young's Literal Translation (YLT)

Examples

{{bibleref2|1John|1:9}}
{{bibleref2|1John|1:9|NIV}}
{{bibleref2|1John|1:9|NIV|1 John 1:9}}
Code Result
{{bibleref2|John|3:16|}} John 3:16Template:Only in print
{{bibleref2|John|3:16-18|NKJV|John 3:16-18}} John 3:16-18Template:Only in print
{{bibleref2|1Jn|1:9-2:11||ASV|1 John 1:9ff}} 1 John 1:9ffTemplate:Only in print
{{bibleref2|1Cor|13|AMP|1 Cor. 13}} 1 Cor. 13Template:Only in print
{{bibleref2|Gen.|1:1||Creation}} CreationTemplate:Only in print

Differences from Template bibleref

Similar to Template bibleref with three main differences:

  1. This template always defaults to ESV if translation_abbr is left blank.
  2. It always produces a link to biblegateway.com
  3. It allows a display reference as the fourth parameter

See also

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