root/scripturizer/trunk/readme.txt

Revision 4542, 7.3 kB (checked in by xaglen, 3 years ago)

added requested plugin metadata to readme.txt

Line 
1=== Scripturizer for Wordpress ===
2Tags: bible, scripture
3Contributors: xaglen, laurenceo
4
5SCRIPTURIZER PLUGIN FOR WORDPRESS 1.2+
6Glen Davis - www.glenandpaula.com
7http://dev.wp-plugins.org/wiki/Scripturizer for the latest documentation
8
9*********************************************************************************************
101.0 WHAT IT DOES
11*********************************************************************************************
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* Bible Gateway http://www.biblegateway.com/
20* Bible.org http://www.bible.org/ (the NET Bible)
21* The English Standard Version http://www.gnpcb.org/esv/
22* Oremus Bible Browser http://bible.oremus.org/ (the New Revised Standard Version)
23* Nestle-Aland 26th edition Greek New Testament http://www.zhubert.com
24* The Septuagint Greek Old Testament http://www.zhubert.com
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*********************************************************************************************
312.0 CREDIT
32*********************************************************************************************
33
34This plugin was derived from Heal Your Church Website's Scripturizer plugin for Movable Type.
35http://www.healyourchurchwebsite.com/archives/001176.shtml
36additional information is in credits.txt
37
38*********************************************************************************************
393.0 FILES
40*********************************************************************************************
41
42scripturizer.php
43LibronixLink.gif
44scripturizer_test.php
45readme.txt
46credits.txt
47
48*********************************************************************************************
494.0 REPORT ERRORS
50*********************************************************************************************
51
52http://dev.wp-plugins.org/newticket
53
54*********************************************************************************************
555.0 INSTALLATION
56*********************************************************************************************
57
585.1 Basic:
59
60       1) download scripturizer.php and put it in your Wordpress plugins directory:
61           - Assuming Wordpress is installed in http://yoursite/wordpress
62                http://yoursite/wordpress/wp-content/plugins
63
64       2) edit the file to change the default translation (initially NIV) and other basic options:
65
66           - Default translation:
67              - Translation to which scripturizer defaults if no translation is detected in the Scripture reference
68              - Look for the following line: "define('DEFAULT_BIBLE_TRANSLATION','NIV');"
69              - Change 'NIV' to any of the recognized translation acronyms (see Section 6.2 below)
70
71           - Dynamic substitution
72              - Controls whether scripturizer adds links:
73                 - Each time a post is viewed (dynamic)
74                 - At the time a post is created or edited (static, permanently edits post)
75              - Look for the following line: "define('DYNAMIC_SUBSTITUTION',TRUE);"
76                 - TRUE: Dynamic substitution (recommended)
77                 - FALSE: Static/permanent substitution
78              - Note that Dynamic Substitution allows for changes in default translation as well as changes in linked website interfaces
79
80           - Libronix Support
81              - Determines whether or not scripturizer adds Libronix Links
82                 - http://www.logos.com/support/lbs/weblinking
83              - Look for the following line: "define('LIBRONIX_LINKS',FALSE);"
84                 - TRUE: Libronix Links added
85                 - FALSE: Libronix Links not added
86
87       3) activate the plugin using the Wordpress administration interface
88
89           - From the Wordpress Dashboard: Manage / Plugins
90
915.2 Libronix Users:
92
93       1) download LibronixLink.gif and put it in your wp-content directory.
94       2) download scripturizer.php and put it in your wp-content/plugins directory.
95       3) change define('LIBRONIX_LINKS',FALSE) to TRUE
96       4) change the other defines, if you are so inclined
97       5) activate the plugin using the Wordpress administration interface
98
995.3 Developer:
100
101       1) If you see a feature you want to add (or a bug you want to fix), download scripturizer.php to a web-accessible directory
102       2) Also download scripturizer_test.php and put it in the same directory
103       3) Hack away and check your work by viewing scripturizer_test.php in your browser
104       4) Submit any improvements at http://www.wp-plugins.org/ (also submit improvements to the admittedly rudimentary scripturizer_test.php)
105
106*********************************************************************************************
1076.0 HOW TO USE SCRIPTURIZER
108*********************************************************************************************
109
1106.1 How Scripturizer Recognizes Scripture References:
111
112       1) Scripturizer will recognize Scripture references that conform to somewhat loose conventions:
113
114          - [Book] [Chapter]
115          - [Book] [Chapter]:[Verse]
116          - [Book] [Chapter]:[Verse]-[verse]
117
118       2) Where [Book] can be a full name or an abbreviation, with prefix as applicable. Note that prefixes can be in several formats:
119
120          - 1, 2, 3
121          - I, II, II
122          - First, Second, Third
123          - 1st, 2nd, 3rd
124
125       3) Scripturizer will recognize most common book abbreviations.
126
127          - NOTE: All abbreviated references to Judges should include the letter 'g' in order to differentiate between Judges and Jude.
128
129       4) Scripturizer can also recognize translation acronyms following Scripture references:
130
131          - [Reference] [Translation]
132          - [Reference] ([Translation])
133
1346.2 How Scripturizer Determines Scripture Translation:
135
136       1) If no translation reference is found, Scripturizer uses the default translation (see Section 5.1 above)
137
138       2) If a recognized translation reference is found, Scripturizer uses the referenced translation. Recognized translations/acronyms include the following:
139
140          - NIV (New International Version)
141          - NASB (New American Standard Bible)
142          - HCSB (Holman Christian Standard Bible)
143          - AMP (Amplified Version)
144          - NLT (New Living Translation)
145          - KJV (King James Version)
146          - CEV (Contemporary English Version)
147          - NKJV (New King James version)
148          - KJ21 (21st Century King James Version)
149          - ASV (American Standard Version)
150          - WE (Worldwide English New Testament)
151          - YLT (Young's Literal Translation)
152          - DARBY (Darby Translation)
153          - Darby (Darby Translation)
154          - WYC (Wycliffe New Testament)
155          - NIV-UK (New International Version - United Kingdom)
156          - MSG (The Message Bible)
157          - NIRV (New International Reader's Version)
158          - NRSV (New Revisted Standard Version)
159          - NET (NET Bible)
160          - ESV (English Standard Version)
161          - NA26 (Nestle-Aland 26th edition Greek New Testament)
162          - LXX (Septuagint Greek Old Testament)
Note: See TracBrowser for help on using the browser.