Technology Services for Ministry

SMS User's Guide

List View

List view properties are specified at plugin.tx_wecsermons_pi1.listView.

For browse box settings, See http://typo3.org/fileadmin/typo3api-4.0.0/df/d32/classtslib__pibase.html#ba8eebaed52748cdf9acb31562295378

 

Property: 

Data Type: 

Description 

Default Value: 

layoutCode 

int 

Valid values are 1-4. 

1 = Brief Layout 

2 = Series Layout 

3 = Verbose Layout 

4 = Custom Layout 

 

Example: 

# Force single views to always use the "Customized Layout" 

layoutCode = 4

 

startDate 

string 

The earliest date in time that you would like entries to be visible in list views. Any record with this date or later will be visible in the list view. 

 

Example: 

# Include any sermon record having a date of 12/24/2000 or later. 

startDate = 12/24/2000

Note: 

String value should always have the syntax of: 

mm/dd/yyyy 

 

endDate 

string 

The latest date in time that you would like entries to be visible in list views. Any record with this date or earlier will be visible in the list view. 

 

Example: 

# Include any sermon record having a date of 12/23/2001 or earlier. 

startDate = 12/23/2001

Note: 

String value should always have the syntax of: 

mm/dd/yyyy 

 

maxDetailResults 

int 

The maximum number of results to display in a list view. If grouping is enabled, this is the maximum number of detail results. 

 

Example: 

# Display the first 20 results of the list 

maxDetailResults = 20

20 

maxGroupResults 

int 

The maximum number of groups to display if grouping is enabled. 

 

Example: 

# Only show the first 5 groups 

maxGroupResults = 5

emptyGroups 

boolean 

Enables or disables empty groups from displaying if grouping is enabled. Empty groups are grouped results which have no related records. 

 

Example: 

# Allow displaying of groups which have no related records 

emptyGroups = 1


Illustration : The Results-Browser

maxPages 

int 

The maximum number of page links to be shown in the browse -box at one time. (See Illustration 28) 

 

Example: 

# Only allow 4 page links in the browse-box 

maxPages = 4

Note: 

This is the browse-box output <Page1> <Page2>, etc. Restricts how many links are shown at once. A reasonable value would be between 3 and 7. 

dontLinkActivePage 

boolean 

Enable or disable the browse-box page link for the currently viewed page page. 

 

Example: 

# Disable the link to the current page in the browse-box 

dontLinkActivePage = 1

Note: 

To disable linking of active page, set value = 1. To enable, set value = 0. 

 

showFirstLast 

boolean 

Enable or disable the display of  "<< First" and "Last >>" page links within the browse box.

 

Example: 

# Enable the display of first and last links in the browse-box 

showFirstLast = 1

 

pagefloat 

int / keyword 

Defines the position the current page is shown in the list of pages in the browse box. If the value is an integer it will be interpreted as position in the list of pages (1 = as the first page, etc. - See Illustration 28). If the value is the keyword "center" the current page will be shown in the middle of the browse links.

 

Example: 

# Force the current page to float in center of page links 

pagefloat = center

 

showRange 

boolean 

This enables or disables the display of the pagelinks as ranges e.g., 1-5 6-10  11-15... instead of 1  2  3...

 

Example: 

# Enable ranges of pages in the browse-box 

showRange = 1

 

showResultCount 

int 

Specifies how the results-browser is displayed, e.g., "Displaying results 1 to 15 out of 30" 

 

Example: 

# Enable the browse-box links as ranges 

showResultCount = 1

Note: 

0: Only the result-browser will be shown 

1 (Default): the text "Displaying results..." and the result-browser will be shown. 

2: Only the text "Displaying results..." will be shown, without the browse-box. 

alternatingClass 

string 

A string appended to a class declaration of odd rows of the list view. This allows one to style even and odd rows independently. 

 

Example: 

# Odd rows of a list view will have 'odd' appended to them 

alternatingClass = odd

Note: 

The string is appended to 'tx-wecsermons-pi1-list'. Therefore, if you set the string value = odd, the class delcaration would be: 

class="tx-wecsermons-pi1-list-odd" 

odd 

general_dateWrap 

->stdWrap 

The general formatting of dates displayed in list view. If this is assigned a value, this formatting will be used in the event that a formatting is not applied to a specific field in the SMS database. 

 

Example: 

# General formatting of a date in list view 

general_dateWrap.strftime = %A,

Note:  

Above example would format the date 12/24/2006 as: 

Sunday, Dec 24 2006 

 

See the PHP documentation for string formatting options.

strftime = %A,  %b. %d %Y

browseBox_linkWraps 

(config) 

The browseBox_linkWraps configuration array is used to define all wraps that are used in conjunction with the browse-box. Each of the configuration properties are detailed below. 

 

Example: 

# Formatting for all browse-box wrappings 

browseBox_linkWraps {

        browseBoxWrap.wrap = <div class="browseBoxWrap">|</div>

        showResultsWrap.wrap = <div class="showResultsWrap">|</div>

        browseLinksWrap.wrap = <div class="browseLinksWrap">|</div>

        showResultsNumbersWrap.wrap = <span class="showResultsNumbersWrap">|</span>

        disabledLinkWrap.wrap = <span class="disabledLinkWrap">|</span>

        inactiveLinkWrap.wrap = <span class="inactiveLinkWrap">|</span>

        activeLinkWrap.wrap = <span class="activeLinkWrap">|</span>

 

browseBoxWrap 

->stdWrap 

This is the wrap for the complete results-browser (See Illustration 28).  

 

Example: 

# Wrap for entire results-browser 

browseBox_linkWraps.browseBoxWrap = <div class="browseBoxWrap">|</div>

<!--
List browsing box:
-->
<div class="tx-wecsermons-pi1-browsebox">|</div>

showResultsWrap 

->stdWrap 

This wraps the text “Displaying results....” (See Illustration 28) 

 

Example: 

# Wrap the results content 

browseBox_linkWraps.showResultsWrap.wrap = <div class="showResultsWrap">|</div>

 

 

browseLinksWrap 

->stdWrap 

Wrap for the browse-box links. (See Illustration 28) 

 

Example: 

# Wrap the browse links

browseBox_linkWraps.browseLinksWrap.wrap = <div class="browseLinksWrap">|</div>

 

 

showResultsNumbersWrap 

->stdWrap 

Wrap for the numbers in the text: “Displaying results 1 to 4 out of 22.” (See Illustration 28) 

 

Example: 

# Wrap the results numbers only

browseBox_linkWraps.showResultsNumbersWrap.wrap = <div class="showResultsNumbersWrap">|</div>

 

disabledLinkWrap 

->stdWrap 

Wrap for disabled links (e.g., the “Last >>” link when it appears on the last page). 

 

Example: 

# Wrap the disabled link  

browseBox_linkWraps.disabledLinkWrap.wrap = <div class="disabledLinkWrap">|</div>

 

inactiveLinkWrap 

->stdWrap 

Wrap for inactive links (normal links). 

 

Example: 

# Wrap the inactive links

browseBox_linkWraps.inactiveLinkWrap.wrap = <div class="inactiveLinkWrap">|</div>

 

activeLinkWrap 

->stdWrap 

Wrap for active links. 

 

Example: 

# Wrap the active links  

browseBox_linkWraps.activeLinkWrap.wrap = <div class="activeLinkWrap">|</div>

 

tx_wecsermons_sermons 

(config) 

See the definition of this configuration below.

 

tx_wecsermons_series 

(config) 

See the definition of this configuration below.

 

tx_wecsermons_speakers 

(config) 

See the definition of this configuration below.

 

tx_wecsermons_topics 

(config) 

See the definition of this configuration below.

 

tx_wecsermons_seasons 

(config) 

See the definition of this configuration below.

 

tx_wecsermons_resources 

(config) 

See the definition of this configuration below.

 

[plugin.tx_wecsermons_pi1.listView] 

 

  WEC_Sermon_Management_System_1.0_02.sxw 22 / 30