DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Display Christian Watchwords

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Holzinger Franz
Changed:2014-11-27T11:47:42.434640975
Author:David Bruehlmeier
Email:typo3@bruehlmeier.com
Info 3:
Info 4:

EXT: Display Christian Watchwords

Extension Key: watchwords

Copyright 2004-2014, David Bruehlmeier, <typo3@bruehlmeier.com>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Display Christian Watchwords 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 2

FAQ 3

Configuration 3

Reference 3

Priorities 4

Standard Output 5

Known problems 5

To-Do list 5

Changelog 5

Introduction

What does it do?

This extension adds a new content element which will get a new Christian Watchword every day. The watchwords are fetched from www.biblegateway.com.

Screenshots

Backend:

img-1

Example from a live website (Frontend):

img-2

Users manual

This extension comes with a fully working TypoScript configuration, so you can use it ‘out-of-the-box’.

After installation, you will notice that a new Content Element (Plugin) has been added:

Module Web>Page (Using the Pagecontent wizard)

img-3

You can choose the bible version from which the watchwords will be displayed. If you choose no version (and set no version in TypoScript), the “English: New International Version” is the default setting.

img-1

And you’re done! Without any further configuration, the result should look something like this:

img-4

FAQ

Question: The watchwords are not displayed. All I see is the message “Sorry, no data could be fetched!”.

Answer: This is the case whenever your watchwords provider cannot be reached. Most probably, this is due to settings of your webserver. The watchwords are normally fetched using fopen, which may be disabled on your webserver, e.g. when running in SAFE_MODE. You can try to use curl by adding the following setting to your localconf.php file (using the install tool):

$TYPO3_CONF_VARS['SYS']['curlUse'] = '1';

If you are behind a proxy, try setting these additional options:

$TYPO3_CONF_VARS['SYS'][curlProxyServer] = 'myproxy';
$TYPO3_CONF_VARS['SYS'][curlProxyTunnel] = '1';
$TYPO3_CONF_VARS['SYS'][curlProxyUserPass] = 'myproxy_password';

Configuration

Reference

testFile

Property

testFile

Data type

string

Description

If you would like to use a test file (e.g. one you have already downloaded on your own server), you can this property. The difference to the url-property is that no parameters will be added (like the ?format=xml parameter).

Example:

This configuration will return the watchwords in the example file delivered with this extension from your webserver.

plugin.tx_watchwords_pi1.testFile = typo3conf/ext/watchwords/xml/biblegateway_en.xml

Default

templateFileBiblegateway

Property

templateFileBiblegateway

Data type

resource

Description

If you would like to use a template for the styling of the output, you can use this property. The following markers can be used:

  • ###DATE### (Date)
  • ###VERSE### (Verse of the day)
  • ###BIBLE_LINK### (URL directly linking to the verse of the day)
  • ###VERSE_SOURCE### (Source of the verse)
  • ###COPYRIGHT### (Copyright notice)
  • ###LICENSE### (License URL)

NOTE: If this property is set, the properties for date, verse and copyright are disregarded.

Default

EXT:watchwords/pi1/template_biblegateway.inc

verse

Property

verse

Data type

boolean / stdWrap

Description

If no templateFile is used, the bible verse is only displayed if this property is true. The stdWrap properties also apply if the templateFile is used.

Default

verseSource

Property

verseSource

Data type

boolean / stdWrap

Description

If no templateFile is used, the source of the bible verse is only displayed if this property is true. The stdWrap properties also apply if the templateFile is used.

NOTE: Unfortunately, the value for the verseSource is provided by www.biblegateway.com in English only , even if non-English bible version is chosen.

Default

license

Property

license

Data type

stdWrap

Description

The license-url cannot be suppressed by setting it to false as this would constitute a breach of the license agreement.

Default

standard

Property

standard

Data type

stdWrap

Description

Text that will be displayed, if no watchword could be fetched with the current configuration.

Example:

The following configuration will define a standard text in English (default language) and German.

standard = Sorry, no data could be fetched!
standard.lang.de = Es konnten keine Daten ermittelt werden!

Default

Sorry, no data could be fetched!

bibleVersion

Property

bibleVersion

Data type

integer

Description

The bible version in which the verse will be displayed. The following bible versions are supported:

1: Albanian: Albanian Bible

21: Bulgarian: Bulgarian Bible

80: Chinese (Simplified): Chinese Union Version

22: Chinese (Traditional): Chinese Union Version

11: Danish: Dette er Biblen på dansk

8: English: American Standard Version

16: English: Darby Translation

47: English: English Standard Version

9: English: King James Version

31: English: New International Version

15: English: Young’s Literal Translation

2: French: Louis Segond

10: German: Luther Bibel 1545

69: Greek: 1550 Stephanus New Testament

68: Greek: 1881 Westcott-Hort New Testament

70: Greek: 1894 Scrivener New Testament

23: Haïtian Creole: Haïtian Creole Version

81: Hebrew: The Westminster Leningrad Codex

17: Hungarian: Hungarian Kairoli

18: Icelandic: Icelandic Bible

3: Italian: Conferenza Episcopale Italiana

20: Korean: Korean Bible

4: Latin: Biblia Sacra Vulgata

24: Maori: Maori Bible

5: Norwegian: Det Norsk Bibelselskap 1930

12: Polish: Biblia Tysiaclecia

25: Portugese: João Ferreira de Almeida Atualizada

14: Romanian: Romanian

13: Russian: Russian Synodal Version

42: Spanish: Nueva Versión Internacional

6: Spanish: Reina-Valera Antigua

7: Swedish: Svenska 1917

27: Ukrainian: Ukrainian Bible

19: Vietnamese: 1934 Vietnamese Bible

Default

31

(English: New International Version)

[tsref:plugin.tx_watchwords_pi1]

Priorities

Several properties of this extension can be defined in different ways. For such properties, the following priorities in getting the respective values are applied:

Bible Version

Bible version defined in the Plugin

Value of the TypoScript property plugin.tx_watchwords_pi1.bibleVersion

Default bible version (English: New International Version)

Layout

Use of the template file as defined with the property plugin.tx_watchwords_pi1.templateFileBiblegateway

The display of each value can be enabled/disabled through the respective property. All values are run through stdWrap. The final output is a string of values, concatenated in the following order:

Date (property plugin.tx_watchwords_pi1.date)

Verse (property plugin.tx_watchwords_pi1.verse)

Bible link (property plugin.tx_watchwords_pi1.bibleLink)

Bible verse source (property plugin.tx_watchwords_pi1.verseSource)

Copyright notice (property plugin.tx_watchwords_pi1.copyright)

License url (property plugin.tx_watchwords_pi1.license)

Standard Output

If any of the following problems occur, the value returned by the extension will be the text defined in the property plugin.tx_watchwords_pi1.standard. Please note that if you use translations by means of the stdWrap-property here, TYPO3 will get the language from the site language (property config.language) and not from the extension!

  • The property plugin.tx_watchwords_pi1.testFile is not defined
  • No file could be fetched
  • The XML-file is not valid

Known problems

None yet. Please let me know ( typo3@bruehlmeier.com ) if you encounter any problems.

To-Do list

Nothing planned.

Changelog

  • Version 1.0.1 (November 27, 2014)

    bugfix for reloading of the cache (disableAcquireCacheData) in TYPO3 6.2.

  • Version 1.0.0 (October 26, 2014)

    Runnable also under TYPO3 6.1 and 6.2.

  • Version 0.7.1 (February 27, 2009)

    • Removed www.losung.de as watchwords provider.
    • Removed the update function, which was used to update from version 0.2.0 to 0.3.0.
    • Removed deprecated code and files.
  • Version 0.7.0 (November 16, 2007)

    • Raised minimum requirement to PHP5
    • Due to licensing problems, it is uncertain if the watchwords service provided by www.losung.de will be continued. For this reason, as of version 0.7.0 a watchwords provider can be selected in the plugin’s configuration. For the time being, I recommend choosing www.biblegateway.com as your watchwords provider.
    • The TypoScript property plugin.tx_watchwords_pi1.url has been removed and is not supported anymore.
    • If you are updating from an earlier version, please refer to the chapter “Changing the watchwords provider”
  • Version 0.6.0 (November 2, 2007)

    Caching improvement: Watchwords are now stored in the cache for each day/language and only fetched once from the server. Thanks to Benjamin Mack for this improvement!

  • Version 0.5.0 (February 7, 2006)

    Support new marker ###OT_INT### for intro to the watchword of the Old Testament. Note that this is not always supplied by www.losung.de . Also support the new TypoScript property oldTestamentIntro.

  • Version 0.4.0 (January 12, 2006)

    • Support new marker ###NT_INT### for intro to the watchword of the New Testament (such as “John the seer writes:”). Also support new TypoScript property newTestamentIntro. Updated the standard template to include the new marker. Thanks to Martin Schoenbeck for the suggestion!
    • Small redesign: When running on PHP5, the extension is now using simpleXML.
    • Fixed bug: Encoding issues when using PHP5. Now the extension should be running fine on PHP4 and PHP5.
    • Fixed bug: missing breaks in switch-statement
  • Version 0.3.0 (October 19, 2005)

    • The output of the extension is now cached. The cache is checked each time it is called, because it must be from the current day (otherwise, old watchwords would be displayed from the cache). If the cache is not from the current day, it is automatically refreshed (and the new watchwords are fetched fron www.losung.de ). This results in a much better perfomance.
    • The extension now properly handles all charsets. Therefore, all languages supported by www.losung.de are now available. The output will be rendered in the same charset as every other output.
    • Changed to FlexForms. Please use the UPDATE function in the Extension Manager when updating from version 0.1.0 or 0.2.0
  • Version 0.2.0 (July 2, 2004)

    • Included new translations of the extension (Finnish, Norwegian, German)
    • Minor changes to the manual (included note for the license agreement and the new property license)
    • Change in tx_watchwords_pi1->main (url now also contains the format- property, new xml-element ‘LICENSE’)
    • Change in ext_typoscript_constants.txt (url = http://www.losung.de /cgi-bin/today.pl ` ?format=XML11 <http://www.losung.de/cgi-bin/today.pl?format=XML11>`_ )
  • Version 0.1.0 (May 28, 2004)

    First public version

img-5 EXT: Display Christian Watchwords - 6