Difference between revisions of "Template:Bibleverse/doc"

From blackwiki
Jump to navigation Jump to search
imported>Atethnekos
(→‎Template data: +update links)
imported>Little Mountain 5
(rm now optional "Book#" parameter)
Line 7: Line 7:
 
==Usage==
 
==Usage==
 
Code format:
 
Code format:
:<font color="red">(</font><code><nowiki>{{Bibleverse|BOOK#|BOOKNAME|c:v&ndash;c:v|SOURCE}}</nowiki></code><font color="red">)</font></pre>
+
:<font color="red">(</font><code><nowiki>{{Bibleverse|BOOK|c:v&ndash;c:v|SOURCE}}</nowiki></code><font color="red">)</font></pre>
  
 
:<font color="crimson"> Note parentheses:</font> (See [[WP:EL]]). Inline external links (this template links offsite) '''must be separated''' from the article text by parentheses. (Parentheses are deliberately not included in this template to allow for flexible usage.)
 
:<font color="crimson"> Note parentheses:</font> (See [[WP:EL]]). Inline external links (this template links offsite) '''must be separated''' from the article text by parentheses. (Parentheses are deliberately not included in this template to allow for flexible usage.)
  
;Example: <code><nowiki>{{Bibleverse||John|3:16|KJV}}</nowiki></code> yields: {{Bibleverse||John|3:16|KJV}}
+
;Example: <code><nowiki>{{Bibleverse|John|3:16|KJV}}</nowiki></code> yields: {{Bibleverse|John|3:16|KJV}}
  
In text, with parentheses, this looks like this ({{Bibleverse||John|3:16|KJV}}).
+
In text, with parentheses, this looks like this ({{Bibleverse|John|3:16|KJV}}).
 
 
Note the empty parameter <code>||</code> before "John" in the above examples. This is to handle the first parameter, "<code>BOOK#</code>", which is only necessary for numbered books (e.g., 2 Corinthians, 1 Samuel).
 
  
 
; Detail
 
; Detail
 
This template is used to provide sources for Bible verse references. See the [[Template talk:Bibleverse|talk page]] for more usages, examples and source codes.  
 
This template is used to provide sources for Bible verse references. See the [[Template talk:Bibleverse|talk page]] for more usages, examples and source codes.  
  
*'''''DO NOT put any spaces anywhere in the template.'''''
 
 
*You can use shorthand for the names, such as '''Sam''' or '''Deut'''.
 
*You can use shorthand for the names, such as '''Sam''' or '''Deut'''.
 
*Verse references may be simplified (for example, no range or entire chapter).
 
*Verse references may be simplified (for example, no range or entire chapter).
*If there is only one book, leave the BOOK# parameter blank.
 
  
 
==List of sources==
 
==List of sources==
Line 47: Line 43:
 
|}
 
|}
  
==Alternative usage==
+
==Alternative version==
An alternative which works, but may result in a double spacing, is:
 
:<code><nowiki> {{Bibleverse|BOOKNAME|BOOK#|c:v-c:v|SOURCE_CODE}} </nowiki></code>.
 
Note, though, that if no book number is relevant, the blank argument must be there, e.g.<nowiki> {{Bibleverse|Genesis||1:15-16|HE}} </nowiki>
 
:produces: {{Bibleverse|Genesis||1:15-16|HE}}<!-- this is intentionally Genesis||, see explanation --> (compare the spacing in the example below).
 
 
 
 
An alternative version of this template is available that does not include the book name: [[Template:Bibleverse-nb]]. It can be used to create lists of verses, e.g. <nowiki> [[Book of Exodus|Exodus]] {{Bibleverse-nb||Exodus|1:2-3|HE}}; {{Bibleverse-nb||Exodus|13:10|HE}} </nowiki>
 
An alternative version of this template is available that does not include the book name: [[Template:Bibleverse-nb]]. It can be used to create lists of verses, e.g. <nowiki> [[Book of Exodus|Exodus]] {{Bibleverse-nb||Exodus|1:2-3|HE}}; {{Bibleverse-nb||Exodus|13:10|HE}} </nowiki>
 
:produces: [[Book of Exodus|Exodus]] {{Bibleverse-nb||Exodus|1:2-3|HE}}; {{Bibleverse-nb||Exodus|13:10|HE}}
 
:produces: [[Book of Exodus|Exodus]] {{Bibleverse-nb||Exodus|1:2-3|HE}}; {{Bibleverse-nb||Exodus|13:10|HE}}
  
 
==Examples==
 
==Examples==
*Example1: <nowiki> {{Bibleverse|1|Samuel|3:16-4:18|31}} </nowiki> produces a link to the NIV translation (31 in the source list as linked below): {{Bibleverse|1|Samuel|3:16-4:18|31}}
+
*Example1: <nowiki> {{Bibleverse|1 Samuel|3:16-4:18|31}} </nowiki> produces a link to the NIV translation (31 in the source list as linked below): {{Bibleverse|1 Samuel|3:16-4:18|31}}
*Example2:  <nowiki> {{Bibleverse||Genesis|1:15-16|HE}} </nowiki> produces: {{Bibleverse||Genesis|1:15-16|HE}}
+
*Example2:  <nowiki> {{Bibleverse|Genesis|1:15-16|HE}} </nowiki> produces: {{Bibleverse|Genesis|1:15-16|HE}}
  
  
Line 66: Line 57:
 
"params": {
 
"params": {
 
   "1": {
 
   "1": {
     "label": "Book number",
+
     "label": "Book",
    "description": "The number of the book.  E.g., '2' if citing 2 Samuel, or '1' if citing 1 Corinthians.",
+
     "description": "The name of the book. Forms are listed at tools.wmflabs.org/bibleversefinder/biblebooks_bibleref.txt",
    "type": "number",
 
    "required": false
 
  },
 
  "2": {
 
    "label": "Book name",
 
     "description": "The name of the book in a single word or shortened form. If the book is numbered, then the number should not be included here but rather in the book number parameter. E.g., include here 'Samuel' if citing 1 Samuel. Do not include any spaces. Forms are listed at tools.wmflabs.org/bibleversefinder/biblebooks_bibleref.txt",
 
 
     "type": "string",
 
     "type": "string",
 
     "required": true
 
     "required": true
 
   },
 
   },
   "3": {
+
   "2": {
 
     "label": "Chapter:verse",
 
     "label": "Chapter:verse",
 
     "description": "The chapter and verse to be cited.  Also, the range to be cited, or just the chapter.  For example: '5:4', '1:1-2', '21:1-24:7' or '6'.  Do not include any spaces.",
 
     "description": "The chapter and verse to be cited.  Also, the range to be cited, or just the chapter.  For example: '5:4', '1:1-2', '21:1-24:7' or '6'.  Do not include any spaces.",
Line 83: Line 68:
 
     "required": true
 
     "required": true
 
   },
 
   },
   "4": {
+
   "3": {
 
     "label": "Source",
 
     "label": "Source",
 
     "description": "The edition to be cited.  Leave blank to generate a list of links to all available editions.  Given in common abbreviations (e.g., 'KJV', 'NIV') or according to the numbers or abbreviations listed at tools.wmflabs.org/bibleversefinder/bibleversefinder.php#srcref",
 
     "description": "The edition to be cited.  Leave blank to generate a list of links to all available editions.  Given in common abbreviations (e.g., 'KJV', 'NIV') or according to the numbers or abbreviations listed at tools.wmflabs.org/bibleversefinder/bibleversefinder.php#srcref",

Revision as of 21:54, 11 January 2014

Usage

Code format:

({{Bibleverse|BOOK|c:v–c:v|SOURCE}})
Note parentheses: (See WP:EL). Inline external links (this template links offsite) must be separated from the article text by parentheses. (Parentheses are deliberately not included in this template to allow for flexible usage.)
Example
{{Bibleverse|John|3:16|KJV}} yields: John 3:16

In text, with parentheses, this looks like this (John 3:16).

Detail

This template is used to provide sources for Bible verse references. See the talk page for more usages, examples and source codes.

  • You can use shorthand for the names, such as Sam or Deut.
  • Verse references may be simplified (for example, no range or entire chapter).

List of sources

A list of sources and codes that may be used to trigger them is at tools.wmflabs.org/bibleversefinder/bibleversefinder.php#srcref

Here is a sample list (this list is subject to change, please check link above):

Code Translation
(do not include or, just number or text)
1000 Show user all options
31 or NIV New International Version (BibleGateway)
49 or NASB New American Standard Bible (BibleGateway)
9 or KJV King James Version (BibleGateway)
105 or HE Hebrew-English - parallel MT and JPS 1917 (Mechon Mamre)
65 or TM The Message (BibleGateway)

Alternative version

An alternative version of this template is available that does not include the book name: Template:Bibleverse-nb. It can be used to create lists of verses, e.g. [[Book of Exodus|Exodus]] {{Bibleverse-nb||Exodus|1:2-3|HE}}; {{Bibleverse-nb||Exodus|13:10|HE}}

produces: Exodus 1:2–3; 13:10

Examples

  • Example1: {{Bibleverse|1 Samuel|3:16-4:18|31}} produces a link to the NIV translation (31 in the source list as linked below): 1 Samuel 3:16–4:18
  • Example2: {{Bibleverse|Genesis|1:15-16|HE}} produces: Genesis 1:15–16


Template data

A template to generate a link to the various Bible editions at www.biblegateway.com. This template will create a link with the name of the book and specified chapter and verse, or range of chapters and verses, or just an entire chapter. Use Bibleverse-nb to create a link without the book name in the anchor text of the link.

Template parameters

ParameterDescriptionTypeStatus
Book1

The name of the book. Forms are listed at tools.wmflabs.org/bibleversefinder/biblebooks_bibleref.txt

Stringrequired
Chapter:verse2

The chapter and verse to be cited. Also, the range to be cited, or just the chapter. For example: '5:4', '1:1-2', '21:1-24:7' or '6'. Do not include any spaces.

Stringrequired
Source3

The edition to be cited. Leave blank to generate a list of links to all available editions. Given in common abbreviations (e.g., 'KJV', 'NIV') or according to the numbers or abbreviations listed at tools.wmflabs.org/bibleversefinder/bibleversefinder.php#srcref

Stringoptional