Sermons API

by Etienne de Bruin, Justin Bodeutsch

Display mode: list

Show

before_show, after_show

Here are the tags available to before_show and after_show in sermon list:

TagDescription
__pagination__
Divides the records into smaller groups and provides links to navigate through them
show

Here are the tags available to show in sermon list:

TagDescription
__title__ outputs the sermon title
__slug__ the URL safe version of the title (more info)
__titlelink__ creates a link with the title as the text
__url__ looks like "/article/slug"
__summary__  
_preview__
A shortened version of the text. HTML is stripped. Defaults to be no more than 250 characters. Can be specified with __perview limit='120'__  Uses the description if no summary is available.
__passage__ passage assigned to the sermon
__group__ comma separated list of group names
__groupslug__ slug of an associated group
__series__ the title of the series for the article
__seriesslug__ the slug of the series
__category__ comma separated list of categories
__categoryslug__  
__categorylinks__
comma separated list of linked categories. Use parameter 'path' to specify where links will go, default is '/sermons/category/'. Use 'separator' to use a different separator than comma.
__date__ formattable date. Use __date format='j/m/Y'__ a complete list of tags is available
__dateTwo__ formattable date
__dateThree__ formattable date
__preacher__ the preacher(s) of the preacher
__preacherslug__  
__preacherdesc__ the description of the preacher
__preacherImg__ the image of the preacher in an img tag
__preacherImgThumb__ thumbnail of the preacher image in an img tag
__preacherNum__ number of sermons by that preacher
__audio__ the url of the audio
__audioplayer__ creates a link to the popup audio player (more info)
__notes__ url to the notes
__image__ the the image in an img tag
__imageurl__ the url of the image
__imagetmb__ thumbnail of the image in an img tag
__videoplayer__ creates a link to the popup video player. Handles optional attributes: __videoplayer linktext='Watch This' width='480' height='400' __ (more info)
__video__ url to the article's video
__id__ system id of the article
__alt__ returns 'alt' for every other line
__first__ displays 'first' for the first record returned
__last__ displays 'last' for the last record returned
__tags__
Comma separated list of keywords
__featured__ displays 'featured' if record is featured
__ commentNumber __ number of comments for that event. I.E. Comments(3)
__commentNumberonly__ number of comments with no "Comments()" around it
group_show
TagDescription
__title__ the title of whatever we are grouping by
__description__  
__slug__  
__categoryNum__ if grouping by category, displays the numbers of sermons in this category
__subtitle__ the title of whatever we are subgrouping by
__subdescription__  
__subslug__  
__preacher__ if grouping by preacher, displays the name of the preacher
__preacherslug__  
__preacherdesc__  
__preacherImg__ image of the preacher in an img tag
__preacherImgThumb__ thumbnail image in an img tag
__preacherNum__ number of sermons by that preacher
__thistitle__ displays the title of the group on every iteration
__thisslug__ displays the slug of the group on every iteration

Parameters

features

Only show items published as featured.

Example:

"features",
Monklet Example:

features="features"

nonfeatures

Only show items not published as featured.

Example:

"nonfeatures",

Monklet Example:nonfeatures="nonfeatures"

howmany

Sets the maximum number of items to display

Example:

"howmany:3",

offset

Skips the first X records returned

Example:

"offset:1",

find_group

Only show items assigned to that group. Can find multiple groups with a comma separated list.

Example:

"find_group:group1,group2,group3",

find_series

Only show items assigned to that series. Can find multiple series with a comma separated list. Can return the "current" series with "find_series:current",

Example:

"find_series:series1,series2,series3",

hide_series

Will not show items assigned to that series. Will also work with current.

Example:

"hide_series:series-slug,series-slug2",

 Example:

"hide_series:current",

find_category

Only show items assigned to that category. Can find multiple categories with a comma separated list.

Example:

"find_category:category1,category2,category3",

find_preacher

Only show items assigned to that preacher.

Example:

"find_preacher:preacher-slug",

find_month

Only show items from that month.

Example:

"find_month:2007-11",

hide_date

Will not show items with dates in the past or future.

Examples:

"hide_date:past",
"hide_date:future",

find_tag

Finds all posts with that tag.

Example:

"find_tag:tag-slug",

page

For pagination, sets which page of content to display. Needs to receive the value of $_GET['page'] from the querystring.

Example:

"page:".$_GET['page'],

querystring

For pagination, will add to the end of the querystring of the pagination links.

Example: "querystring:author=bob&category=bible"

order

Sets sort order of items in list

item description
recent by date, starting with most recent
preacher by first name, alphabetically
series by series name, alphabetically
category by category, alphabetically
title by title, in alphabetical order
groupby

Sets a criteria to group the list by.

Available grouping criteria:

  • series
  • category
  • preacher
  • month
  • year

Example:

"groupby:series",

subgroupby

Sets a criteria to subgroup the list by. Requires "groupby" to be set

Available subgrouping criteria:

  • series
  • category
  • preacher
  • month
  • year

Example:

"groupby:year","subgroupby:month", 

 

nocache

Prevents the output from being cached. Caching increases the speed of getContents considerably so this tag is not reccomended except for testing purposes, places where the output is random, events lists where the output is time sensitive, or context sensitve getContents. nocache does not apply to monklets.

example:

"nocache",

noecho

getConents default to 'print' the output. With noecho, you can assign the contents to a variable to be printed later. This is helpful if you have repeated content on a page.

example:

"noecho",

 

Display mode: detail

Show

show

Here are the tags available to show in sermon list:

TagDescription
__title__ outputs the sermon title
__slug__ the URL safe version of the title (more info)
__titlelink__ creates a link with the title as the text
__url__ looks like "/article/slug"
__summary__  
__passage__ passage assigned to the sermon
__group__ comma separated list of group names
__groupslug__ slug of an associated group
__series__ the title of the series for the article
__seriesslug__ the slug of the series
__category__ title of the category
__categoryslug__  
__subcategory__ the title of the child category
__subcategoryslug__  
__categorylinks__ comma separated list of linked categories. Use parameter 'path' to specify where links will go, default is '/sermons/category/'. Use 'separator' to use a different separator than comma.
__date__ formattable date. Use __date format='j/m/Y'__ a complete list of tags is available
__preacher__ the preacher(s) of the preacher
__preacherslug__  
__preacherdesc__ the description of the preacher
__preacherImg__ the image of the preacher in an img tag
__preacherImgThumb__ thumbnail of the preacher image in an img tag
__preacherNum__ number of sermons by that preacher
__audio__ the url of the audio
__audioplayer__ creates a link to the popup audio player (more info)
__notes__ url to the notes
__image__ the the image in an img tag
__imageurl__ the url of the image
__imagetmb__ thumbnail of the image in an img tag
__videoplayer__ creates a link to the popup video player. Handles optional attributes: __videoplayer linktext='Watch This' width='480' height='400' __ (more info)
__video__ url to the article's video
__tags__
comma separated list of keywords
__ commentNumber __ number of comments for that event. I.E. Comments(3)
__commentNumberonly__ number of comments with no "Comments()" around it
__ commentList__ Preformatted list of comments with text box to add new comments

Parameters

find

Will accept the slug of a sermon.

Example:

"find:sermon-slug",