Template:LDS/sandbox/doc

From blackwiki
Jump to navigation Jump to search

Usage

This template links to the English version of LDS texts on Wikisource and makes for easier referencing inside those texts.

Note: This template does not use parameter names (with the exception of a parameter for specifying the website that hosts the text, as explained below). Other parameter names below are only for documentation purposes. Parameters must be passed in the order given. Do not use spaces before or after the pipe "|"

Basic usage

{{LDS/sandbox|Eth.|Ether|12|4}}

Results:

  1. Creates html link to https://en.wikisource.org/wiki/Book_of_Mormon_(1981)/Ether#12:4
  2. Jumps to verse on page
  3. Displays in the article text as: Eth. 12:4

Full usage

{{LDS/sandbox|display|book name|chap#|verse#|end verse#|footnote|cross ref flag|end verse flag|website}}

Parameters:

parameter description optional?
|display= name of book to display in Wikipedia (e.g., "1. Ne.") optional
|book name= book name (either the full name or the short name (abbreviation) used by the LDS Church's website (see below) optional
|chap#= chapter or section of scripture being quoted optional
|verse#= verse of scripture being quoted optional
|end verse#= end verse of a series of verses, such as the 5 in "John 3:3–5"
The en dash is automatically added—unless end verse flag has a value, which allows quoting of non-contiguous verses such as "John 3:5, 16" — the end verse# in that situation should be ", 16"
optional
|footnote= letter of footnote - changes link to a link to the verse - and highlights the footnote matching the letter. If no match found, does not highlight anything optional (deprecated)
|cross ref flag= if this has any value, then it changes link to a link to the verse only and all verses that cross reference to it ignores the value in footnote (if any) optional (deprecated)
|end verse flag= if this has any value, then the hyphen before end verse# is not automatically added optional
|website= this parameter may specify the website to which to cite. The default value is "wikisource". optional

Examples with explanation

Template:Update-section

Example text Description URL & Display text
{{LDS/sandbox|Eth.|Ether|12}} Link to Chapter only https://en.wikisource.org/wiki/Book_of_Mormon_(1981)/Ether#Chapter_12
Ether 12
Eth. 12 12
{{LDS/sandbox|Eth.|Ether|12|4}} Link to verse https://en.wikisource.org/wiki/Book_of_Mormon_(1981)/Ether#12:4
Ether 12:4
Eth. 12:4
{{LDS/sandbox|John|john|3|5|,14-16|||x}} deprecated https://www.churchofjesuschrist.org/study/scriptures/nt/john/3.5,14-16?lang=eng#4
John 3:5,14-16
John 3:5,14-16
{{LDS/sandbox|Eth.|Ether|12|4|d}} Link to footnotes - deprecated

Examples and results

wikitext link result
{{LDS/sandbox|Genesis|gen|48}} Genesis 48
{{LDS/sandbox|Doctrine and Covenants|dc|130|22}} Doctrine and Covenants 130:22
{{LDS/sandbox|1 Nephi|1_ne|22|22|24}} 1 Nephi 22:22–24
{{LDS/sandbox|Moroni|moro|10|3|5}} Moroni 10:3–5
{{LDS/sandbox|John|john|3|5}} John 3:5
{{LDS/sandbox|John|john|3|5|,14-16|||x}} John 3:5,14-16
{{LDS/sandbox|John|john|3|5||d}} John 3:5–
{{LDS/sandbox|Jeremiah|jer|1|5||d}} Jeremiah 1:5–
{{LDS/sandbox|Jeremiah|jer|1|5||d|x}} Jeremiah 1:5–

Template Data

This template links to the English version of LDS texts on Wikisource and makes for easier referencing inside those texts. Note: This template does not use parameter names (with the exception of a parameter for specifying the website that hosts the text, as explained below). Other parameter names below are only for documentation purposes. Parameters must be passed in the order given. Do not use spaces before or after the pipe "|"

Template parameters

ParameterDescriptionTypeStatus
display1 Display Name display

name of book to display in Wikipedia

Default
LDS Standard Works
Example
1. Ne.
Stringsuggested
book name2 book name

name of book (or abbreviation of book used by LDS Church website)

Example
1-ne
Stringsuggested
chap#3 chap# chapter

chapter of scripture being quoted

Example
12
Numberoptional
verse#4 verse# verse

verse of scripture being quoted

Example
4
Numberoptional
end verse#5 end verse# end verse

end verse of a series of verses, such as the 5 in "John 3:3–5". The en dash is automatically added unless end verse flag has a value, which allows quoting of non-contiguous verses such as "John 3:5, 16" — the end verse# in that situation should be ", 16"

Unknownoptional
footnote6 footnote

letter of footnote - changes link to a link to the verse - and highlights the footnote matching the letter. If no match found, does not highlight anything

Example
d
Unknowndeprecated
cross ref flag7 cross ref flag

if this has any value, then it changes link to a link to the verse only and all verses that cross reference to it ignores the value in footnote (if any)

Example
x
Unknowndeprecated
end verse flag8 end verse flag

if this has any value, then the hyphen before `end verse#` is not automatically added

Example
y
Unknownoptional
websitewebsite website host site source

website to which to cite

Default
wikisource
Example
lds
Stringoptional

See also