WordPress.org
Get WordPress

Plugin Directory

Changeset 433107


Ignore:
Timestamp:
09/04/2011 03:51:10 AM (15 years ago)
Author:
danielsummers
Message:

Created version 3 of the plug-in

Location:
hcsb-verse-of-the-day/trunk
Files:
5 added
3 deleted
1 edited

Legend:

Unmodified
Added
Removed

  • hcsb-verse-of-the-day/trunk/readme.txt

    r188597 r433107  
    1 === HCSB Verse of the Day ===
     1=== HCSB Verse of the Day (Plus) ===
    22Contributors: danielsummers
    33Tags: bible, verse, votd
    4 Requires at least: 2.0
    5 Tested up to: 2.9
     4Requires at least: 3.2
     5Tested up to: 3.2.1
    66Stable tag: trunk
    77
    88This plug-in provides a Verse (or Passage) of the Day, based on the reference
    9 from BibleGateway.com, in the Holman Christian Standard Bible version.
     9from BibleGateway.com.  Originally written for the Holman Christian Standard
     10Bible (HCSB), it now also supports the English Standard Version (ESV), New King
     11James Version (NKJV), New International Version (NIV), and King James Version
     12(KJV) translations.
    1013
    1114== Description ==
    1215
    1316HCSB Verse of the Day utilizes the reference given by BibleGateway.com in their
    14 Verse of the Day RSS feed, and parses the content of their website to extract
    15 the text of the verse or passage in the Holman Christian Standard Bible version.
    16 Versions are provided for PHP version 4 and PHP version 5.  (The PHP 5 version
    17 utilizes the enhanced OO capabilities in that version of the language.)
     17Verse of the Day RSS feed.  For versions they do not provide in their feed, it
     18parses the content of their website to extract the text of the verse or passage.
     19The plug-in provides a widget, that will display the verse, a reference, and the
     20credits for the translation and source (Bible Gateway).  It also provides
     21several template tags, as well as the ability to utilize a custom set of
     22template tags in a single tag.  See the documentation at the top of the plug-in
     23on how to create this.  There is also a settings page, where you can select the
     24translation to be used.
    1825
    19 The plug-in provides several template tags, as well as the ability to utilize a
    20 custom set of template tags in a single tag.  See the documentation at the top
    21 of the plug-in on how to create this.
     26PHP 5 is required for this plug-in (which is why this requires "at least" 3.2).
     27I could go back and determine what the earliest version would be where this
     28would work (I think it's 2.8), but why?  Upgrade and get the security-enhanced
     29goodness!  :)
     30
     31Version 3 represents a major refactoring of the code behind this plug-in;
     32however, if you just used the template tags that were available in version 2,
     33this should drop in and work seamlessly.  It also eliminates many of the
     34deprecated WordPress functions that version 2 employed, so you'll want this
     35to ensure that it doesn't break in an upcoming WordPress upgrade.
    2236
    2337As this plug-in parses a web page, please let me know if you find a reference
    2438that does not work.  If BibleGateway changes their HTML, this plug-in will need
    25 to be (and will be) modified.
     39to be (and will be) modified.  (The HCSB and NKJV use this parsing.)
    2640
    2741NOTE:  BibleGateway.com does not provide its "Verse of the Day" service in the
    … …  
    4256== Installation ==
    4357
    44 Upload "votd\_hcsb.php" (PHP 4) or "votd\_hcsb\_php5.php" (PHP 5) to your
    45 wp-content/plugins directory.  Additionally, if you create your own set of tags,
    46 modify the file "votd\_hcsb\_custom.php" and upload it to the same directory.
    47 (The custom file will appear as another plug-in in the WordPress plug-in
    48 manager.)  The plug-in(s) can then beactivated through the WordPress Plugin
    49 Administration page, and the desired template tag(s) added to your theme as
    50 desired.  The tags, their parameters, and how to create a custom set of template
    51 tags are all detailed in the documentation at the top of the plugin.
    52 
    53 IF UPGRADING FROM 1.x SERIES - The file "option\_fix.sql" contains a SQL command
    54 to remove the options that this series used.  (The option storing mechanism is
    55 different in 2.0 and above.)  It is not required, but it can be run to delete
    56 the old options from the WordPress database.
     58Unzip the archive, and upload the "hcsb-verse-of-the-day" directory to your
     59wp-content/plugins directory.  Once activated, the widget will be available for
     60use in your theme, and the template tags will be active.  If you're using
     61template tags, and want to create your own set of tags (to minimize the
     62footprint in your theme), modify the file "votd\_hcsb\_custom.php" and upload
     63it to the same directory.  This custom file will appear as another plug-in in
     64the WordPress plug-in manager, and will need to be activated separately.
Note: See TracChangeset for help on using the changeset viewer.