@VOTD Twitterbot Help

Quick Start

Twitter this:
@votd Mt 1:1 esv

... and you will get this back:
Mat 1:1 - The book of the genealogy of Jesus Christ, the son of David, the son of Abraham. (ESV)


Contents


Introduction
Request Commands and their Syntax
. . . Syntax to request a verse
. . . Syntax to request lookup of a word
. . . Syntax to return the verse of the day manually
. . . Syntax to return a random verse
. . . Syntax for the help request
. . . Syntax to set your preferences
Examples
. . . sending a verse request
. . . sending a Bible name lookup request
. . . setting preferences
. . . the 'help' request
Details
. . . The verse request
. . . . . . Minimal abbreviations for the Books
. . . The Bible name lookup request
. . . Verse of the Day preferences
Other notes of interest
. . . ‘@’ vs ‘D’ choice
. . . Response times
. . . Outage Response Times
. . . Being considered
. . . Known problems
Advanced use
. . . Letting @votd send your status
Copyright Notices for the Versions Used
Revision History


Introduction

The VOTD (Verse Of The Day) Twitterbot provides a “pull” service which replies with the text when users send a Scripture reference or a dictionary word. There are 3 commands it responds to –

  1. the verse or word request itself,
  2. a command to set the user’s preferences for subsequent requests, and
  3. the ubiquitous 'help' command.

The 'bot also provides a "push" service for those who either subscribe or follow, which transmits the verse of the day each day after midnight EST.

On this help page, the originating user is assumed to have a Twitter ID of `@user`.

back to top

Request Commands and their Syntax

Add the following after the '@votd' address header:

Syntax to request a verse

[ '['message']' ] book [ chap [ :verse ] ] [ version ] [ > twitterlist ]

Syntax to request lookup of a word

'['message']' ] word [ dictionary ] [ > twitterlist ]

Syntax to return the verse of the day manually

votd [ version ] [ > twitterlist ]

Syntax to return a random verse

rand [ version ] [ > twitterlist ]

Syntax for the help request

?

Syntax to set your preferences

pref choice [ ... , choice ]
... where choice is one or more of the following choices:

1).   dict = { hit | con | str }
... (HITchcock's dictionary (default), the CONcordance to the KJV or STRong's concordance; only the first 3 letters are necessary.)

2).   ver = translation
... where translation is one of the following choices:
ASV, DBY, ESV, HNV, KJV, NASB, NIV, NKJV, NLB, NLT, RSV, RVR, VUL, WEB, WBST, YNG

3).   votd = choice
... where choice [ ... , choice ] is one or more of the following choices:
OFF, ON or PROMISES, BYGRACE or HOEKSTRA, AM, PM, UTMOST, BREAD

back to top

Examples of sending a verse request

@votd Matt 1

(verse will default to '1') - @votd will reply with:
Matt 1:1 - The book of the generation of Jesus Christ, the son of David, the son of Abraham. (KJV)
@votd [First verse of the NT] Matt 1 esv
tells @votd to use the ESV for this request, overriding any preferences that may have been set. The comment in square brackets is put in front of the response.

@votd will reply with
:
First verse of the NT: Mat 1:1 - The book of the genealogy of Jesus Christ, the son of David, the son of Abraham. (ESV)
@votd Matt 1:1 esv > @tom, @dick, @harry
tells @votd to reply with Matt 1:1 in the ESV translation, and then to retweet the text to the Twitter addresses that follow the 'greater than' sign.

It will reply to the originator with
:
Mat 1:1 - The book of the genealogy of Jesus Christ, the son of David, the son of Abraham. (ESV)

... and to @tom (and similarly to @dick and @harry) with:
RT @user Mat 1:1 - The book of the genealogy of Jesus Christ, the son of David, the son of Abraham. (ESV)
back to top

Examples of sending a Bible name lookup request

To look up a word in Hitchcock's Bible Dictionary (assuming it is your preferred or default dictionary)::
@votd Ruth
@votd will reply with:
Ruth={drunk; satisfied }
To look up a word in the KJV concordance::
@votd Ruth conc
@votd will reply with:
ruth={13/13= Rut 1:4,14,16,22; 2:2,8,21-22; 3:9; 4:5,10,13; Mat 1:5 };
To look up a word in Strong's concordance::
@votd Christos strong
@votd will reply with:
Christos(khris-tos')={G5547=from [G5548]; anointed, i.e. the Messiah, an epithet of Jesus:--Christ.};

To look up the Strong's number for a Greek or Hebrew word, use this format:
@votd G3323
@votd will reply with:
(G3323)-Messias (mes-see'-as)={of Hebrew origin ([H4899]); the Messias (i.e. Mashiach), or Christ:--Messias.}
back to top

Examples of setting preferences

use the KJV translation by default (for verse requests that don’t specify one); set the dictionary to Hitchcock's and turn on push of the verse of the day:
@votd pref ver=kjv, dict = hit, votd=on
back to top

Example of the 'help' request

@votd ?
will reply with a line listing the number of verses @votd has sent you, what your preferred translation and dictionary are, whether or not you are subscribed to the midnight push, and where to get help (this page, updated as new features are added):
329 verses; PREF: Ver=KJV, Dict=hit, Votd=following. For help: http://t4.gwilt.org/votdhelp.html
back to top

Details about the verse request

back to top

Minimal abbreviations for the Books

The following table lays out the minimum characters to define each book. You may type more, but they will be ignored. Three abbreviations are allowed despite being ambiguous - 'Cr' for Corinthians (as opposed to Chronicles); 'phl' for Philippians rather than Philemon and 'jud' for Jude not Judges - because the BLB uses them.


Bookalt.
abbrevs
Bookalt.
abbrevs
Bookalt.
abbrevs
Genesis   Isaiah   Romans rm
Exodus   Jeremiah   1Corinthians 1Cr
Leviticus lv Lamentations lm 2Corinthians 2Cr
Numbers   Ezekiel ezk Galatians  
Deuteronomy   Daniel   Ephesians  
Joshua jsh Hosea hs Philippians phl, php
Judges jdg, jg Joel jl Colossians  
Ruth rt Amos   1Thessalonians  
1Samuel   Obadiah   2Thessalonians  
2Samuel   Jonah jna 1Timothy  
1Kings   Micah   2Timothy  
2Kings   Nahum   Titus  
1Chronicles   Habukkuk   Philemon phm
2Chronicles   Zephaniah zp Hebrews hbr
Ezra   Haggai hg James jm
Nehemiah nh Zechariah zc 1Peter  
Esther   Malachi ml 2Peter  
Job jb Matthew mt, mw 1John  
Psalms   Mark mk, mr 2John  
Proverbs   Luke lk 3John  
Ecclesiastes   John jhn Jude jde, jud
Song of Solomon   Acts   Revelation rv
back to top

Details about the Bible name lookup request

back to top

Verse of the Day Prefence Details

There are several choices for the source of the automatic verse of the day:
choicesourcesent to you at
OFF - none -  
ON or PROMISES BLB Promises midnight EST
BYGRACE or HOEKSTRABLB Hoekstra midnight EST
AM BLB Spurgeon midnight EST
PM BLB Spurgeon noon EST
UTMOST RBC Utmost midnight EST
BREAD RBC Daily Breadmidnight EST
PROV Small Group Proverbsmidnight EST


Other details about the automatic push:

Other notes of interest

‘@’ vs ‘D’ choice

In general, people assume that 'following' a Twitterbot gets you the automatic service. This can be handy, since you can stop getting the 'bot's messages by unfollowing. It is not a great architecture, however, since it requires a lot of work on the part of the 'bot - repeated calls to find out who's following; possibly auto-following them back; then un-following them when they unfollow the 'bot; and Twitter currently has no method for determining who has stopped following the 'bot, which demands a lot of DB work as volume grows.

For these reasons, @votd was originally implemented as a subscription-only service. This went well with its initial approach, namely (the 'push' component) that the user sends a message to retrieve the text of a Bible verse. To get the daily verse sent automatically by the 'bot each midnight, the user subscribed to the service by sending in a specific message (pref votd=on). It quickly became apparent, however, that people were following without reading this help page - and thus assuming that simply 'following' would get them the verse of the day. So now the architecture has been changed and the user can either follow or subscribe to have @votd return the daily verse.

You can follow @votd, but you might regret it as traffic goes up. The advantages to following are (1) that the whole 140 characters can be used for the response (if your Twitter name is 10 characters long, for instance, that will be 12 more characters for the message); and (2) that the response is private. If you choose to follow, though, you’ll see every reply it makes to those users that don't follow - again, that's how the Twitter architecture works. And while that might be interesting for a while, you’ll probably get fed up fairly quickly. Whether @votd returns messages using the '@' or the 'D' form depends purely on whether you follow it or not.

back to top

Response times

@votd currently checks for inbound requests once a minute. Your Twitter client (OutTwit, Twhirl, etc.,) also has a time delay before it looks for Twitters. So the theoretical worst-case time for a response could be your client’s interval plus 1 minute – which is going to feel like a really looooong time.

back to top

Outage Response Times

If something goes wrong, I’ll fix it as soon as possible – but notifications from my web host can sometimes be hit-or-miss. Some problems will be Twittered in to me by the ‘bot, but any Twitter-related issues will obviously not.

back to top

Being considered

back to top

Known problems

back to top

Advanced use

Sending a verse as your status

There are two ways in which @votd can retweet a verse or word:

@votd Matt 1:1 ESV > @tom, @dick, @harry
will return the verse to the originator (@user) and also forward it on to the three other twitterers. They will see something like this:

RT @user Mat 1:1 - The book of the genealogy of Jesus Christ, the son of David, the son of Abraham. (ESV)

Sometimes you may want to send a verse as your status (i.e., to everyone following you). If you have logged on to @votd on the (@votd login page), then you can use the 'all' command:

@votd [Shortest verse in the Bible] John 11:35 KJV > all
which will return the verse as your next status (here we're also using the optional comment field):

Shortest verse in the Bible: John 11:35 - Jesus wept. (KJV) (via @votd)

You can also combine the 'all' choice with the regular retweet list, by entering 'all' at the front of the list like this:

@votd John 3:16 > all, @tom
This will send the following 3 pairs of tweets:

a] John 3:16 - For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not   b] perish, but have everlasting life. (KJV)
... will be sent to @user as the originator;

a] John 3:16 - For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not   b] perish, but have everlasting life. (KJV) (via @votd)
... will be sent as @user's regular status, and

RT @user a] John 3:16 - For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him   b] should not perish, but have everlasting life. (KJV)
... will be sent from @votd to @tom as a retweet.
back to top

Copyright Notices for the Versions Used

Many of these versions are drawn from the Blue Letter Bible's excellent site. This site has a page displaying more detailed copyright information here: Copyright information.

back to top

Revision History



For help, reporting problems or to recommend improvements, Twitter me @swggy.