User:Joren/Netbibleapi/doc
This is a documentation subpage for User:Joren/Netbibleapi. It may contain usage information, categories and other content that is not part of the original user template page. |
Netbibleapi is a template to allow citation of the NET Bible. A link is created that anchors directly to the specific verse on the NET Bible's site, and upon mouse-over a tooltip is provided to the user informing them of what version is being linked to. By default, if no verse is specified, John 3:16 is used. The title of the generated link (and the tooltip) may be changed to suit the editor's needs.
Right now this links directly to the NET Bible API, which displays the verse, only the verse, and nothing but the verse. In other words, no "next chapter" links, no navigation tools, etc. We should probably change this...
The cool thing is, you can do multiple verses and verse ranges. Make sure you separate the ranges by semi-colon; e.g. John 3:16; 18-20.
The NET gateway will likely correct abbreviations (e.g. mt for Matthew) - just realize that if you put an abbreviation in the passage, that will also show up in the link's title on Wikipedia by default.
Usage
[edit]{{User:Joren/Netbibleapi|passage|whatever you want the link title to say|formatting}}
or you can use named parameters, too:
{{User:Joren/Netbibleapi|passage=passage | title=whatever you want the link title to say | formatting=formatting}}
This will create a link to the NET Bible's website, which displays a copy of that translation at the specified passages. Additionally, if the user hovers the cursor above the link, a tooltip will be generated with the link title with "(NET Translation)" appended.
- passage - Accepts any formatting that net.bible.org accepts; e.g. Book Chapter:Verse or John 3:16. It is safe to use numerical prefixes (e.g. 1 John, 2 John). However, Roman numerals are not supported. You can do multiple citations using this parameter, as long as books are separated by semi-colons; e.g. "Exodus 20:2-17; Dt 5:6-21; Ex 34:11-27" will work. You can also abbreviate multiple citations from the same book or chapter, as long as verses within a chapter are separated by a comma (not a semi-colon). E.g. "John 3:5-6, 16-18" or "Romans 3:23, 10-18; 6:23; 5:8; 10:9, 13" will also work. If (for some very interesting reason) no verse is specified, John 3:16 is used.
- title: This will change the text of the link to whatever you want. Also changes the tooltip (except for the translation title)
- formatting: This is supposed to change the formatting style of the passage linked to. In theory, "full" gives you paragraphs, bolding, italics, and notes, while "para" does just the paragraph and "plain" gives the straight text with no formatting whatsoever. In actual experience I don't see any difference.
Examples
[edit]{{User:Joren/Netbibleapi}}
{{User:Joren/Netbibleapi|John 3:17}}
{{User:Joren/Netbibleapi|1 Samuel 16:7}}
{{User:Joren/Netbibleapi|Romans 3:23, 10-18; 6:23; 5:8; 10:9, 13|The Romans Road}}
{{User:Joren/Netbibleapi|Exodus 20:2-17; Dt 5:6-21; Ex 34:11-27|The Ten Commandments (Exodus 20:2-17)}}
Formatting (seems to have no effect right now)
[edit]{{User:Joren/Netbibleapi|Exodus 20:2-17; Dt 5:6-21; Ex 34:11-27|The Ten Commandments (Exodus 20:2-17)|full}}
{{User:Joren/Netbibleapi|Exodus 20:2-17; Dt 5:6-21; Ex 34:11-27|The Ten Commandments (Exodus 20:2-17)|para}}
{{User:Joren/Netbibleapi|Exodus 20:2-17; Dt 5:6-21; Ex 34:11-27|The Ten Commandments (Exodus 20:2-17)|plain}}