source: scripturizer/trunk/readme.txt @ 327080

Revision 327080, 6.5 KB checked in by chipbennett, 17 months ago (diff)
Line 
1=== Scripturizer ===
2Tags: bible, scripture
3Contributors: xaglen, laurenceo, chipbennett
4Donate Link:
5Tested up to: 3.0.4
6Requires at least: 3.0
7Stable tag: 2.1
8
9Scripturizer will convert Bible references in your posts and comments into hyperlinks to online Bibles.
10
11== Description ==
12
13Scripturizer will convert Bible references in your posts and comments into hyperlinks to online Bibles.
14
15For example, it will change John 3:16 into something like
16<a href="http://biblegateway.com/passage/?search=ROM+6:23&version=46;">John 3:16</a>
17
18Online Bibles currently supported are:
19
20* <a href="http://www.biblegateway.com/">Bible Gateway</a>
21* <a href="http://www.bible.org/">The NET Bible</a>
22* <a href="http://www.gnpcb.org/esv/">The English Standard Version</a>
23* <a href="http://bible.oremus.org/" title="the New Revised Standard Version">Oremus Bible Browser</a>
24* <a href="http://www.zhubert.com">Septuagint Greek OT / Nestle-Aland 26th ed. Greek NT</a>
25
26You can customize the plugin to use your favorite Bible translation or to include links useful for users
27of Logos Bible Software by editing scripturizer.php and adjusting the configuration parameters near the
28top of the file.
29
30== Other Notes ==
31
32*********************************************************************************************
33CREDITS
34*********************************************************************************************
35
36[Glen Davis] (www.glenandpaula.com)
37
38This plugin was derived from [Heal Your Church Website's Scripturizer plugin for Movable Type](http://www.healyourchurchwebsite.com/archives/001176.shtml). Additional information is in credits.txt
39
40*********************************************************************************************
41FILES
42*********************************************************************************************
43
44* scripturizer.php
45* LibronixLink.gif
46* scripturizer_test.php
47* readme.txt
48* credits.txt
49
50*********************************************************************************************
51DOCUMENTATION AND REPORTING ERRORS
52*********************************************************************************************
53
54[Plugin Documentation](http://dev.wp-plugins.org/wiki/Scripturizer)
55[Bug Reports](http://dev.wp-plugins.org/newticket)
56
57== Installation ==
58
59Basic:
60
611. Download scripturizer.php and put it in your Wordpress plugins directory:
62 - Assuming Wordpress is installed in http://yoursite/wordpress
63 - http://yoursite/wordpress/wp-content/plugins
642. Activate the plugin using the Wordpress administration interface
65 - From the Wordpress Dashboard: Manage / Plugins
663. View the Plugin Options page to change the default translation (initially NIV) and other basic options:
67 - Default translation:
68     - Translation to which scripturizer defaults if no translation is detected in the Scripture reference
69 - Dynamic substitution
70     - Controls whether scripturizer adds links:
71         - Each time a post is viewed (dynamic)
72         - At the time a post is created or edited (static, permanently edits post)
73     - Note that Dynamic Substitution allows for changes in default translation as well as changes in linked website interfaces
74 - Libronix Support
75     - Determines whether or not scripturizer adds Libronix Links
76         - http://www.logos.com/support/lbs/weblinking
77
78Libronix Users:
79
801. download LibronixLink.gif and put it in your wp-content directory.
812. download scripturizer.php and put it in your wp-content/plugins directory.
823. change define('LIBRONIX_LINKS',FALSE) to TRUE
834. change the other defines, if you are so inclined
845. activate the plugin using the Wordpress administration interface
85
86Developer:
87
881. If you see a feature you want to add (or a bug you want to fix), download scripturizer.php to a web-accessible directory
892. Also download scripturizer_test.php and put it in the same directory
903. Hack away and check your work by viewing scripturizer_test.php in your browser
914. Submit any improvements at http://www.wp-plugins.org/ (also submit improvements to the admittedly rudimentary scripturizer_test.php)
92
93== Frequently Asked Questions ==
94
95= How Scripturizer Recognizes Scripture References =
96
971. Scripturizer will recognize Scripture references that conform to somewhat loose conventions:
98 - [Book] [Chapter]
99 - [Book] [Chapter]:[Verse]
100 - [Book] [Chapter]:[Verse]-[verse]
1012. Where [Book] can be a full name or an abbreviation, with prefix as applicable. Note that prefixes can be in several formats:
102 - 1, 2, 3
103 - I, II, II
104 - First, Second, Third
105 - 1st, 2nd, 3rd
1063. Scripturizer will recognize most common book abbreviations.
107 - NOTE: All abbreviated references to Judges should include the letter 'g' in order to differentiate between Judges and Jude.
1084. Scripturizer can also recognize translation acronyms following Scripture references:
109 - [Reference] [Translation]
110 - [Reference] ([Translation])
111
112= How Scripturizer Determines Scripture Translation =
113
1141. If no translation reference is found, Scripturizer uses the default translation (see Section 5.1 above)
1152. If a recognized translation reference is found, Scripturizer uses the referenced translation. Recognized translations/acronyms include the following:
116 - NIV (New International Version)
117 - NASB (New American Standard Bible)
118 - HCSB (Holman Christian Standard Bible)
119 - AMP (Amplified Version)
120 - NLT (New Living Translation)
121 - KJV (King James Version)
122 - CEV (Contemporary English Version)
123 - NKJV (New King James version)
124 - KJ21 (21st Century King James Version)
125 - ASV (American Standard Version)
126 - WE (Worldwide English New Testament)
127 - YLT (Young's Literal Translation)
128 - DARBY (Darby Translation)
129 - Darby (Darby Translation)
130 - WYC (Wycliffe New Testament)
131 - NIV-UK (New International Version - United Kingdom)
132 - MSG (The Message Bible)
133 - NIRV (New International Reader's Version)
134 - NRSV (New Revisted Standard Version)
135 - NET (NET Bible)
136 - ESV (English Standard Version)
137 - NA26 (Nestle-Aland 26th edition Greek New Testament)
138 - LXX (Septuagint Greek Old Testament)
139
140 == Screenshots ==
141
142N/A
143
144== Changelog ==
145
146= 2.1 [2010.12.29] =
147* Completely rewrote settings to use WordPress Settings API
148* Added contextual help
149* Added CSS class to HTML anchor tag, for formatting reference links
150* Added support for all BibleGateway translations, including non-English
151
152= 1.6 [2010.12.16] =
153* Updates to readme.txt file.
154* No functional changes (yet)
155
156= 1.55 =
157* N/A
158
159= 1.2 =
160* N/A
161
162= 1.0 =
163* Original release.
164
165== Upgrade Notice ==
166
167= 2.1 =
168* Major functional rewrite, to bring Plugin current with WordPress
169
170= 1.6 =
171* Updates to readme.txt file. No functional changes (yet).
Note: See TracBrowser for help on using the repository browser.