EXT: WEC eBible¶

Table of Contents¶

`Introduction <#__RefHeading__1407_1978431840>`_ `3 <#__RefHeading__1407_1978431840>`_

`A. Welcome <#__RefHeading__1409_1978431840>`_ `3 <#__RefHeading__1409_1978431840>`_

What is the Web-Empowered Church? 3

`B. About this Manual <#__RefHeading__1413_1978431840>`_ `3 <#__RefHeading__1413_1978431840>`_

`C. How to Use this Manual <#__RefHeading__1415_1978431840>`_ `4 <#__RefHeading__1415_1978431840>`_

`Overview <#__RefHeading__1417_1978431840>`_ `5 <#__RefHeading__1417_1978431840>`_

`A. What Does It Do? <#__RefHeading__1419_1978431840>`_ `5 <#__RefHeading__1419_1978431840>`_

`B. Features <#__RefHeading__1421_1978431840>`_ `5 <#__RefHeading__1421_1978431840>`_

`C. Screenshots <#__RefHeading__1423_1978431840>`_ `5 <#__RefHeading__1423_1978431840>`_

`Installation <#__RefHeading__1425_1978431840>`_ `8 <#__RefHeading__1425_1978431840>`_

`Step 1: Install the Extension <#__RefHeading__1427_1978431840>`_ `8 <#__RefHeading__1427_1978431840>`_

`Step 2: Install the Static Template <#__RefHeading__1429_1978431840>`_ `8 <#__RefHeading__1429_1978431840>`_

`Step 3: Install the WEC eBible Translation Plugin <#__RefHeading__1431_1978431840>`_ `8 <#__RefHeading__1431_1978431840>`_

`Configuration <#__RefHeading__1433_1978431840>`_ `9 <#__RefHeading__1433_1978431840>`_

`Advanced <#__RefHeading__1435_1978431840>`_ `11 <#__RefHeading__1435_1978431840>`_

`Limiting Translations on a Page <#__RefHeading__1437_1978431840>`_ `11 <#__RefHeading__1437_1978431840>`_

`Modifying the Look of eBible <#__RefHeading__1439_1978431840>`_ `11 <#__RefHeading__1439_1978431840>`_

`Appendix <#__RefHeading__1441_1978431840>`_ `12 <#__RefHeading__1441_1978431840>`_

`Appendix A <#__RefHeading__1443_1978431840>`_ `12 <#__RefHeading__1443_1978431840>`_

`TypoScript Reference <#__RefHeading__1445_1978431840>`_ `13 <#__RefHeading__1445_1978431840>`_

General API settings 13

WEC eBible Translation plugin 13

`Known Problems <#__RefHeading__1451_1978431840>`_ `13 <#__RefHeading__1451_1978431840>`_

`To-Do List <#__RefHeading__1453_1978431840>`_ `13 <#__RefHeading__1453_1978431840>`_

`Changelog <#__RefHeading__1455_1978431840>`_ `13 <#__RefHeading__1455_1978431840>`_

A. Welcome¶

Welcome to the adventure of doing ministry through technology!

B. About this Manual¶

This guide is organized into four main sections:

Overview: What the WEC eBible extension does, how it works, and what you can expect from the rest of the manual.

Installation: How to install the WEC eBible extension and how to get it running on your website.

Configuration: How to configure the WEC eBible extension and plugins for maximum impact on your website.

Advanced: How to modify the extension through TypoScript and other advanced functions.

C. How to Use this Manual¶

✔ To help make sense of the material on the following pages, we’ve used a few icons in the margin to highlight certain information.

T |img-1| ip : Tips are bits of information that are good to know. They may offer shortcuts to save you time or even make your website better.

N |img-2| ote : These notes are similar to tips, but usually contain information you should pay attention to. It might be details about a step that a whole operation hinges on or it may highlight an essential sequence of tasks.

C |img-3| aution : These notes draw your attention to things that can interrupt your service or website if not done correctly. Some actions can be difficult to undo.

T |img-4| echnical Stuff : These notes will explain how stuff works. If you want to know why certain steps are necessary or are just looking for a fuller explanation, these notes should help answer your questions.

I |img-5| nternet Link : These links will guide you to a website page that will demonstrate How-To do something or link you to more advanced information on the :underline:``http://webempoweredchurch.com <http://webempoweredchurch.com/>`_` or :underline:``http://typo3.org <http://typo3.org/>`_` websites.

A. What Does It Do?¶

The WEC eBible extension accesses tools graciously provided by eBible.com ( www.eBible.com ) that makes it easy for your Frontend users to view scripture verses within the context of your site. The eBible will parses (find) all Bible references on a website and displays the verse/s for the Frontend user in a variety of translations.

B. Features¶

• Parses embedded Bible references and displays the verses as a link that will take users to the eBible verse page;
• When users mouseover the link, a hover box with the verse/s text appears on their screen;
• When configured to do so, allows registered users to have Bible verses displayed in the translation of their choice.

C. Screenshots¶

Illustration 1: Screenshot: Parsed Link Display

Illustration 2: Screenshot: Verse Hover Box Display

When installed and configured, eBible will parse (find) scripture references and create hyperlinks from them that will display the verse/s as a hover box on mouseover (see Illustration 2). If the link is clicked the user will be taken to the eBible verse page (see Illustration 3). When a user mouses over an eBible enabled link it generates a hover box with the verse/s displayed as well as an invitation to read further on the eBible site. Click anywhere on the screen to remove the box.

Illustration 3: Screenshot: eBible.com Verse Page

When a user clicks a Bible reference link, they are taken to the eBible verse page where they are offered a number of study and reflection options.

The WEC eBible

Illustration 4: Screenshot: WEC eBible Translation Plugin

Illustration 5: Screenshot: WEC eBible Translation Plugin Expanded

Translation plugin can be placed on any page. The plugin allows Frontend users to choose their preferred translation and use that preferred translation throughout the site. For registered users who are logged in, this step will update their Frontend User Account. An anonymous user's selection will remain in effect until the TYPO3 “session” ends (typically, a day or so). Installation ============

To install and implement the eBible extension, you will need to do the following:

Install the Extension;

Install the eBible static template;

Install the WEC eBible Translation plugin (optional).

The following will take you through each step.

Step 1: Install the Extension¶

Install the eBible extension usingthe Extension Manager Module. You can get it by going to “Import extensions” in the Menu dropdown list, and then either do a Lookup for wec_ebible or click on the Retrieve/Update link to look for it in the whole list of extensions.

For details on how to install an extension, refer to the How-To at ht tp://webempoweredchurch.org/no_cache/support/help/tutorial/import_an d_install_an_extension/ .

Step 2: Install the Static Template¶

The static template contains the information used by the web browser to display the parsed verses throughout your website. The eBible static template can be installed in your site's main Template Record. The name of the Static Templates required by the WEC eBible extension is *WEC_eBible.*

I |img-5| nternet Link: Instructions for adding the Static Templates can be found in the how at `http://webempoweredchurch.org/no \_cache/support/help/tutorial/add\_a\_static\_template/ <http://webemp oweredchurch.org/no_cache/support/help/tutorial/add_a_static_template/ >`_ .

Once you've completed these steps, the WEC eBible extension will immediately parse recognized Bible verse references (see Appendix A for a list of parsable Bible books and abbreviations).

Step 3: Install the WEC eBible Translation Plugin¶

Note that this is an optional step. If your desire is only to enable the parsing feature, then you do not need to install the plugin. However, to allow anonymous Frontend users to choose their own translation and to easily enable registered users to change their permanent preferences, the plugin is necessary.

To install the plugin, follow the directions in the how-to found on the Web-Empowered Church website.

For instructions on how to add a plugin to your page, see the helpful how-to at: http://webempoweredchurch.org/no_cache/support/help/tuto rial/add_a_plugin/ .

With the exception of the Header, the plugin has few options, and no extension specific options. If you are not using the default sr_feuser_register template provided by the WEC Starter Package, you will have to add to your custom template and TypoScript configuration in order to have the Translation dropdown box appear in FE User accounts. See the documentation for the sr_feuser_register extension for details on how to do that.

Limiting Translations on a Page¶

There are times when you may want to limit the translation on a particular page. For instance, if you'd created a Bible study that had a word study that was dependent on a particular version, you might want to limit the translation.

To limit a translation on a page, do the following:

Install an extension template on the page you want to limit.

I |img-5| nternet Link: You can view a helpful how-to on accessing and changing Constant Editor values at:

http://webempoweredchurch.org/no_cache/support/help/tutorial/add_a_static_template/

Using the Template Module, open the Constant Editor of the extension template.

Check the Translation and the Allow User Definable Translation checkboxes and click the Update Button.

Once the form refreshes, select your preferred translation on the drop down menu and ensure the second check box of the Allow User Definable Translation is *unchecked,* then click the Update Button.

Once you've completed these steps, verses parsed on the affected page will only reflect the translation you've selected.

Modifying the Look of eBible¶

C |img-3| aution: This section presumes you have at least an intermediate knowledge of TYPO3, HTML, and CSS. Miscoding the CSS file can lead to vanishing words and even sections of your website.

You can change many of the ways eBible looks on your website by modifying the CSS file.

Download the example CSS file res/styles.css and save it to your local computer. You can access the file by clicking on the eBible icon in the Extension Manager and then selecting Edit Files in the drop down menu.

Once you've downloaded the file, you can modify it in any HTML editor. Once you've made your changes, rename the file to ebible.css, and use the Filelist module to upload it to the ext-templates folder.

Then add the following TypoScript code to the Setup field of either the root page's template or on the page template associated with the extension:

page.headerData.10 = TEXT

page.headerData.10.value = <link rel="stylesheet" href="fileadmin/ext- templates/ebible.css" type="text/css" charset="utf-8">

Appendix A¶

TypoScript Reference¶

The following is the TS reference for any option that cannot be set using constants in the Constants Editor.

Known Problems¶

To-Do List¶

Changelog¶