Difference between revisions of "Template:LDS/doc"
imported>Biggins (General reorganization; biggest change was deleting the redundant section manually laying out parameter details in order to solely use the TemplateData extension) |
imported>Biggins m (Clean up) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | This template links to | + | This template makes it easy to create links to [[Latter Day Saint movement]] scriptures, including to specific chapters/sections and verses inside those texts. By default, the template links to the texts as stored on [[Wikisource:|Wikisource]], but adding the optional "website=lds" parameter will create links to the LDS Church's website instead. |
| + | |||
| + | <pre>{{LDS|display text|book name|chapter|verse|end verse|footnote (deprecated)|cross ref flag (deprecated)|nonconsecutive end verse flag|website}}</pre> | ||
:'''Note:''' This template does not use parameter names (with the exception of the "website" parameter for specifying the website that hosts the text); parameter names below are only for documentation purposes. Parameters must be passed in the order given. | :'''Note:''' This template does not use parameter names (with the exception of the "website" parameter for specifying the website that hosts the text); parameter names below are only for documentation purposes. Parameters must be passed in the order given. | ||
| Line 13: | Line 15: | ||
# Displays in the article text as: {{LDS|Eth.|Ether|12|4}} | # Displays in the article text as: {{LDS|Eth.|Ether|12|4}} | ||
| − | == | + | == Template Data == |
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 81: | Line 83: | ||
"description": "DEPRECATED If this has any value, then it changes the citation to link to the verse only and displays all verses that cross reference to it in the LDS church website's sidebar. (Ignores the value in footnote, if any)", | "description": "DEPRECATED If this has any value, then it changes the citation to link to the verse only and displays all verses that cross reference to it in the LDS church website's sidebar. (Ignores the value in footnote, if any)", | ||
"example": "x", | "example": "x", | ||
| − | "deprecated": "In theory this once worked for citations to the LDS church's website, but as of September 2020 it no longer does. It remains solely for backwards compatibility. | + | "deprecated": "In theory this once worked for citations to the LDS church's website, but as of September 2020 it no longer does. It remains solely for backwards compatibility." |
| − | |||
}, | }, | ||
"8": { | "8": { | ||
| Line 88: | Line 89: | ||
"end verse flag" | "end verse flag" | ||
], | ], | ||
| − | "label": "nonconsecutive verse flag", | + | "label": "nonconsecutive end verse flag", |
"description": "if this has any value at all, then the hyphen before the 'end verse' parameter will not be automatically added. This allows for quoting of non-contiguous verses such as \"John 3:5, 16\" — the end verse parameter in this example should be \", 16\"", | "description": "if this has any value at all, then the hyphen before the 'end verse' parameter will not be automatically added. This allows for quoting of non-contiguous verses such as \"John 3:5, 16\" — the end verse parameter in this example should be \", 16\"", | ||
"example": "y", | "example": "y", | ||
| − | "type": "string | + | "type": "string" |
| − | |||
}, | }, | ||
"website": { | "website": { | ||
| Line 107: | Line 107: | ||
} | } | ||
}, | }, | ||
| − | "description": "For citing to | + | "description": "For citing to Latter Day Saint movement scriptures on Wikisource (or the LDS church website)", |
"paramOrder": [ | "paramOrder": [ | ||
"1", | "1", | ||
| Line 124: | Line 124: | ||
== Examples == | == Examples == | ||
| − | |||
| − | |||
| − | |||
{| class=wikitable | {| class=wikitable | ||
| + | ! Wikitext !! Result !! Notes | ||
|- | |- | ||
| − | + | | {{tlx|LDS|Eth.|Ether|12}} | |
| − | + | | {{LDS|Eth.|Ether|12}} | |
| − | |{{tlx|LDS|Eth.|Ether|12}} | + | | Cite to entire chapter |
| − | |||
| − | | | ||
| − | |||
| − | |||
| − | | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| {{tlx|LDS|Doctrine and Covenants|dc|130|22}} | | {{tlx|LDS|Doctrine and Covenants|dc|130|22}} | ||
| {{LDS|Doctrine and Covenants|dc|130|22}} | | {{LDS|Doctrine and Covenants|dc|130|22}} | ||
| + | | Cite to specific verse | ||
|- | |- | ||
| {{tlx|LDS|1 Nephi|1_ne|22|22|24}} | | {{tlx|LDS|1 Nephi|1_ne|22|22|24}} | ||
| {{LDS|1 Nephi|1_ne|22|22|24}} | | {{LDS|1 Nephi|1_ne|22|22|24}} | ||
| − | | | + | | Cite to consecutive range of verses; note the en dash automatically added between beginning and ending verses |
| − | |||
| − | |||
|- | |- | ||
| {{tlx|LDS|John|john|3|5}} | | {{tlx|LDS|John|john|3|5}} | ||
| {{LDS|John|john|3|5}} | | {{LDS|John|john|3|5}} | ||
| + | | Cite to KJV of the Bible | ||
|- | |- | ||
| − | | {{tlx|LDS|John|john|3|5|, | + | | {{tlx|LDS|John|john|3|5|–14, 16|||x}} |
| − | | {{LDS|John|john|3|5|, | + | | {{LDS|John|john|3|5|–14, 16|||y}} |
| − | + | | Cite to nonconsecutive range of verses; note that the en dash must be manually added | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | | ||
| − | |||
| − | |||
|} | |} | ||
=== See also === | === See also === | ||
| + | * {{tl|LDS/legacy}} | ||
* {{tl|Bibleverse}} | * {{tl|Bibleverse}} | ||
| − | |||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
Revision as of 09:01, 1 September 2020
| 40px | This is a documentation subpage for Template:LDS. It contains usage information, categories and other content that is not part of the original template page. |
This template makes it easy to create links to Latter Day Saint movement scriptures, including to specific chapters/sections and verses inside those texts. By default, the template links to the texts as stored on Wikisource, but adding the optional "website=lds" parameter will create links to the LDS Church's website instead.
{{LDS|display text|book name|chapter|verse|end verse|footnote (deprecated)|cross ref flag (deprecated)|nonconsecutive end verse flag|website}}
- Note: This template does not use parameter names (with the exception of the "website" parameter for specifying the website that hosts the text); parameter names below are only for documentation purposes. Parameters must be passed in the order given.
Basic usage
{{LDS|Eth.|Ether|12|4}}
Results:
- Creates html link to https://en.wikisource.org/wiki/Book_of_Mormon_(1981)/Ether#12:4
- Jumps to verse on page
- Displays in the article text as: Eth. 12:4
Template Data
For citing to Latter Day Saint movement scriptures on Wikisource (or the LDS church website)
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| display text | 1 display display name | text to display to user before the chapter/verse numbers; usually the full book name ("First Nephi") or an abbreviation ("1 Ne."), but it could be anything (e.g., "My favorite book of scripture") or even left blank (useful if citing to multiple different chapters of the same book and you don't want to repeat the book name)
| String | suggested |
| book name | 2 book | name of book (or abbreviation of book used by LDS Church website)
| String | suggested |
| chapter | 3 chap section | chapter (or section) of scripture being cited
| Number | optional |
| verse | 4 initial verse | verse of scripture being cited
| Number | optional |
| end verse | 5 end verses | end verse(s) of a series of cited verses, such as the 5 in "John 3:4–5" or the "–5, 16" in "John 3:4–5, 16". An en dash is automatically added between this parameter and the verse# parameter unless the end verse flag has a value (see the end verse flag parameter for more info about that usage)
| String | optional |
| footnote | 6 footnote | DEPRECATED Letter of footnote to cite to. If this parameter has any value, it changes the citation to link to the verse *and* highlights the footnote matching the letter. If no match found, does not highlight anything.
| String | deprecated |
| cross ref flag | 7 | DEPRECATED If this has any value, then it changes the citation to link to the verse only and displays all verses that cross reference to it in the LDS church website's sidebar. (Ignores the value in footnote, if any)
| Unknown | deprecated |
| nonconsecutive end verse flag | 8 end verse flag | if this has any value at all, then the hyphen before the 'end verse' parameter will not be automatically added. This allows for quoting of non-contiguous verses such as "John 3:5, 16" — the end verse parameter in this example should be ", 16"
| String | optional |
| website | website host site source | website to which to link; default is wikisource, but set this (named!) parameter to "lds" to cite to the LDS Church's website instead
| String | optional |
Examples
| Wikitext | Result | Notes |
|---|---|---|
{{LDS|Eth.|Ether|12}}
|
Eth. 12 | Cite to entire chapter |
{{LDS|Doctrine and Covenants|dc|130|22}}
|
Doctrine and Covenants 130:22 | Cite to specific verse |
{{LDS|1 Nephi|1_ne|22|22|24}}
|
1 Nephi 22:22–24 | Cite to consecutive range of verses; note the en dash automatically added between beginning and ending verses |
{{LDS|John|john|3|5}}
|
John 3:5 | Cite to KJV of the Bible |
{{LDS|John|john|3|5|–14, 16|||x}}
|
John 3:5–14, 16 | Cite to nonconsecutive range of verses; note that the en dash must be manually added |
See also
- {{LDS/legacy}}
- {{Bibleverse}}