Table of Contents
Compatible with DokuWiki
- 2020-07-29 "Hogfather" no
- 2018-04-22 "Greebo" yes
- 2017-02-19 "Frusterick Manners" unknown
- 2016-06-26 "Elenor Of Tsort" unknown
This plugin recognizes bible verses (Mark 3:1, Amos 1:4-13) in prose and converts them to the equivalent of HTML <acronym>s which display the verse as the hover-text. That way, if a user hovers over “Mark 3:1,” pop-up text allows him to read about when Jesus first met a Dokuwiki developer: “and he entered again into the synagogue, and there was a man there who had a withered hand.”
While the plugin is verbosely commented for easy modification and expanded bible support, version 1.0 supports only the Douay Rhiems (“old” Catholic)1) translation of the bible.
Search and install the plugin using the Extension Manager.
Alternatively, refer to Plugins on how to install plugins manually:
- Unzip the file
- drop the contents into your
…/lib/plugins/directory and upload to your server.
- Any existing pages will need to be re-built (no change to the page is required, but rebuilding gives DokuWiki a chance to re-parse your text)
Simply write valid bible verse addresses in the text body of your page:
====== PlayGround ====== \\ As seen in the bible, Mark 3:1 , He tests his wiki code. Not HTML code.\\ Lets try some more: 1 Machabees 1:1, and maybe Amos 2:2 and how about 2 Peter 1:1; Romans 3:3\\ Good? \\ Mark 3:3\\ Mark 1:1\\ Mark 2:22-25\\ Amos 1:1-25\\ Mark 3:1-5 \\ Okay, all is good.
Results in a Rendered Page.jpg where hovering over links look like:
To quote Mark chapter 3, verse one:
To quote Mark chapter 3, verse one through 9:
To quote Second Kings chapter 11 verse 8:
2 Kings 11:8
Configuration and Settings
No custom configurations have been added. But that'd be great. You should add some (bible edition, language?).
syntax.php is the only workhorse file, and is heavily commented for easy modification. It contains all 6 required functions and one custom function of my own at the bottom.
To add new translations of the bible:
- create a directory for the bible text files (like “bible_NAB”).
- Separate the bible by chapter into separate text files called CHAPTER.txt, using underscores for spaces (like “1_Kings.txt”).
- Make sure that each verse of the bible is a separate line that looks like 'CHAPTER#:VERSE#. CONTENT' (like “1:1. In the beginning God created heaven, and earth.”).
- Now modify syntax.php to set the variable $validBibleBooksArr to contain the valid books (I use 73 for the Catholic bible, but Protestant bibles have only 66 books).
- Modify syntax.php to correct $filename to point to your bible text files instead of “bible_douayRheims/”
- Initial release
Known Bugs and Issues
Listing a match in the regexp that is an invalid bible verse will cause a warning/error to print out at the top of your page. This is by design, but it might be preferable to just ignore those.
- More translations of the bible would be great.
- Configuration options for choosing the desired translation would be great.