Module
From Online Business Wiki
Click on + to expand the category
Affiliate Programs
{module_affiliateprogram}
Displays stats for an affiliate in an Affiliate Program
Catalogue Modules
{module_catalogue,catID}
Displays an individual catalogue on a web page. Recommended use is to link directly to an individual catalogue rather than use the catalogue module using the link manager.
Parameters
- catID - system generated catalogue id (do not change)
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
Examples
{module_catalogue,591,_blank} - will display a content of a single catalogue according to the Individual Catalogue Layout inside a new window.
{module_cataloguebreadcrumbs}
Displays the breadcrumbs for Catalogues according to the catalogue tree which can have multiple levels
{module_shoppingcartsummary,Vertical,quote}
Displays the summary of the cart on the current catalogue page or web page. It will display "Shopping cart is empty." when the cart is empty and something like this when you have a product in it - "1 item(s), Total: $12.00 View Cart"
Parameters
- Vertical - renders details vertically. Default is that the output is displayed horizontally.
- isQuote
{module_shoppingcartsummary,true,false} - this module will display the output vertically.
{module_cataloguelistdump,-1,rowLength,targetFrame,sortBy}
Displays the List of all Catalogues as names that are links to those catalogues
Parameters
- -1 - Use -1 to display parent catalogs, use -2 to display all catalogs including sub-catalogs.
- rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
- sortBy - will sort the web apps in specified order
- Alphabetical - sorts items alphabetically
- Weight - sorts items by weight
Examples
{module_cataloguelistdump,-1,1,_blank,Alphabetical} - this module will display the catalogue list in the new window, alphabetically and all in one column
Content Holder
{module_contentholder,ID}
Displays the individual Content Holder
Parameters
- ID - system generated (do not change)
Forum Modules
{module_forum,filter,ID,targetFrame}
Displays the forum links according to the forum list layout
Parameters
- filter - filtering criteria for display and can be one of the following:
- i - individual item
- a - all items
- l - latest items
- r - random item
- ID - system generated (do not change)
- targetFrame - the frame in which to open the item in
Examples of use
{module_forum,i,317,true} - it will display an individual forum with an id of 317 and it will display it in the new frame
{module_forumsitesummary,numberOfPosts}
List of latest posts across all forums (list format)
Parameters
- numberOfPosts - it limits the number of posts the module will display
General Modules
{module_error}
Displays system error returned upon some action
{module_url,variable}
This module you can use in your web pages and it will allows you to capture information that you have appended to a URL. Please see module_url for further details.
{module_today}
Displays today's date, e.g. November 23, 2005
{module_visitorcountrycode}
The module {module_visitorcountrycode} will display the 2-letter country code of the current visitor. So if the visitor is from Australia, it'll display 'AU', if they are from the US, it'll display 'US'. So using some basic JavaScript you can direct anyone who is from Australia to one page, or to a blank page, or to an external site, and direct everyone else to your actual site.
{module_goback,image}
Displays the link to go back one page
Parameters
- image - If you place <img src="/button.gif" /> the link text will be replaced with an image
{module_closewindow}
Displays the link that closes the current browser window
{module_siteurl}
Displays the current URL (append http:// if required)
Literature Modules
{module_literature,filter,id,targetFrame}
When inserted into a page it will display the literature item(s). After adding the Literature module to a web page, you can make changes to it to slightly to alter its behavior.
Parameters
- filter - filtering criteria for display and can be one of the following:
- i - individual item
- a - all items
- l - latest items
- r - random item
- id system generated (do not change)
- targetFrame the frame in which to open the item in
Examples of use
Here are some examples of this module:
- {module_literature,i,823,_blank} - This will display the link to individual literature item which when clicked will open in the new window
- {module_literature,a,,_blank} - This module will display links to all literature items which when clicked will open in the new window
- {module_literature,l,} - This module will display the latest items (default is 10 items)
- {module_literature,r,} - This module will display 1 random literature item
Web App Modules
{module_webapps}
{module_webapps,ID,filter,itemID,notUsed,targetFrame,useBackup,resultsPerPage,hideEmptyMessage,rowLength,Sort}
When placed onto a web page or a template it displays the web app items according to the list or backup template.
Parameters
- ID - system generated web app id (do not change)
- filter - filtering criteria for display and can be one of the following:
- i - individual item
- a - all items
- l - latest items
- r - random item
- cl - latest items in a particular category
- itemID - system generated individual item id (do not change)
- notUsed - leave empty
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
- useBackup - specify True if you want to use the backup list template or leave empty
- resultsPerPage - total number of items per page before pagination is used
- hideEmptyMessage - specify True if you don't want the No Items Found message to be displayed.
- rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
- Sort - will sort the web apps in specified order
- alphabetical (default) - items are sorted in alphabetical order form A-Z
- date - will display the web app items newest to oldest
- datereverse - will display the web app items oldest to newest
- weightreverse - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.
- comments - display the items with the largest number of Comments first (can be used for a 'highest votes' type display).
Examples of use
{module_webapps,56,a,,,_blank,true,12,true,3} - this module will display 12 web app items according in the list view in the new window in three items per row way and the web app will use the backup layout.
{module_webapps,123,a,,,,,12} - will only display 12 items per page
{module_webapps,123,l,5} - will only display the latest 5 items (by date) on the page
The previous and next links can be customized using CSS. Each link has its own custom CSS class. To see the CSS class assigned to these links view the web page source where these links appear. The CSS class name format is: WebAppIDPrev and WebAppIDNext where ID is the internal ID assigned to your Web App. You can easily find the ID using Firebug once on the live page.
{module_webappsresults}
{module_webappsresults,notUsed,targetFrame,useBackupTemplate,resultsPerPage,hideEmptyMessage,rowLength,sort}
Displays web app search results in a list according to the list or a backup list layout
Parameters
- notUsed - RESERVED (please do not use this space)
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
- useBackupTemplate - specify True if you want to use the backup list template or leave empty
- resultsPerPage - total number of items per page before pagination is used
- hideEmptyMessage - specify True if you don't want the No Items Found message to be displayed.
- rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
- sort
- ALPHABETICAL (default) - items are sorted in alphabetical order form A-Z
- DATE - items are sorted from newest to oldest. The most recent item is displayed first.
- DATEREVERSE - will display the web app items oldest to newest
- weightreverse - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.
Examples
{module_webappsresults,,_blank,true,16,true,3,REVERSEDATE} - This module will display the web app search results
{module_webappscount,ID}
Count of items in the individual Web App
Parameters
- ID - system generated (do not change)
{module_webappscustomer}
{module_webappscustomer,webappid,criteria,item,effect,targetFrame,useBackupTemplate,resultsPerPage,hideEmptyMessage,rowLength,sort}
Displays the list of Web App Items submitted by a customer (must be logged in)
Parameters
- effect - you can place Ajax in this place to display the detailed item in Ajax effect
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
- useBackup - specify True if you want to use the backup list template or leave empty
- resultsPerPage - total number of items per page before pagination is used
- hideEmptyMessage - specify True if you don't want the No Items Found message to be displayed.
- rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
- sort
- ALPHABETICAL (default) - items are sorted in alphabetical order form A-Z
- DATE - items are sorted from newest to oldest. The most recent item is displayed first.
- DATEREVERSE - will display the web app items oldest to newest
- weightreverse - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.
Examples of use
{module_webappscustomer,56,a,} - will display all web app items that belong to the customer that's logged in for a web app with ID 56
Secure Zones Modules
{module_case,filter,workflowID,sortBy,templateId}
- Displays customer's case history within a secure zone, so, when customer logs in he/she is identified by the system and this module displays all their previous form submissions, according to the "case list layout" in Admin -> More Customization Options. Customer can view each case and download files attached to the case.
Parameters
- filter - sets display criteria.
- a - displays all items that belong to that customer
- c - display all cases that have a particular workflow assigned to them. Please note that only if this filter is used is the workflowID used as a next parameter. The best way to set the ID is to use module manager.
- sortBy - allows you to select the order in which you want to sort the items.
- Default - default sort here is Date Created
- Subject - sorts items according to the subject name alphabetically
- templateId - the sitewide template used to display the case details page
Examples of use
{module_case,a,,Default} - This module will display all the cases that belong to a particular customer and those will be sorted by date
{module_case,a,,Subject} - This module will display all the cases that belong to a particular customer and those will be sorted by subject which is the web form name if generated automatically and will be displayed alphabetically
{module_case,c,10044} - This module will display all cases that have workflow 10044 assigned to them
{module_caseresults}
Display the Case Search Results displayed after the case search form submission
{module_order,filter,workflowID}
Displays Customer's Order History (must be logged in to secure zone)
Parameters
- filter - filtering criteria for display and can be one of the following:
- a - all items
- c - all items in a particular workflow classification
- workflowID - system generated (do not change)
Examples
{module_order,c,10044} - will display all orders that belong to workflow with ID of 10044
{module_favorites}
Displays the list of favorites items for the customer that's logged in (must be logged in to secure zone)
{module_fullname}
Displays customer's Full Name (must be logged in to secure zone)
{module_firstname}
Displays Customer's First Name (must be logged in to secure zone)
{module_lastname}
Displays Customer's Last Name (must be logged in to secure zone)
{module_emailaddress}
Displays customer Email Address (must be logged in to secure zone)
{module_webaddress}
Displays customer Web address (must be logged in to secure zone)
{module_dob}
Displays Customer's date of birth (must be logged in to secure zone)
{module_username}
Displays Customer's Username (must be logged in to secure zone)
{module_password}
Displays Customer's Password (must be logged in to secure zone)
{module_homeaddress}
Displays Customer's Home Address (must be logged in to secure zone)
{module_homecity}
Displays Customer's Home City (must be logged in to secure zone)
{module_homezip}
Displays Customer's Home Zipcode (must be logged in to secure zone)
{module_homestate}
Displays Customer's Home State (must be logged in to secure zone)
{module_homecountry}
Displays Customer's Home Country (must be logged in to secure zone)
{module_workaddress}
Displays Customer's Work Address (must be logged in to secure zone)
{module_workcity}
Displays Customer's Work City (must be logged in to secure zone)
{module_workzip}
Displays Customer's Work Zipcode (must be logged in to secure zone)
{module_workstate}
Displays Customer's Work State (must be logged in to secure zone)
{module_workcountry}
Displays Customer's Work Country (must be logged in to secure zone)
{module_workphone}
Displays Customer's Work Phone (must be logged in to secure zone)
{module_workfax}
Displays Customer's Work Fax (must be logged in to secure zone)
{module_homephone}
Displays Customer's Home Phone (must be logged in to secure zone)
{module_homefax}
Displays Customer's Home Fax (must be logged in to secure zone)
{module_cellphone}
Displays Customer's Cell Phone (must be logged in to secure zone)
{module_title}
Displays Customer's Title (must be logged in to secure zone)
{module_company}
Display Company Name related to a customer that is logged in(must be logged in to secure zone)
{module_logout}
Renders a Log out link for a secure zone
{module_whosloggedin}
Displays the name of the contact that's currently logged in and it also displays the Log Out link. If the contact is not logged in the module will display "No one logged in. [Log in]"
Format:
{module_whosloggedin}
or
{module_whosloggedin,/loginpage.htm}
where /loginpage.htm is the page you want to send the customer to when they click on [Log in] link.
Example - when customer logged in
John Smith. Log Out
Example - when customer is logged out
No one logged in. [Log in]
{module_subscriptions}
Displays the list of logged in user's secure zone subscriptions, including name linked to landing page, expiry, cost, and a cancel link
Format:
{module_subscriptions,show_expiry,show_prices,reserved,render_json}
Where:
- show_expiry - shows or hides the expiry date of the secure zone (true/false; default:true)
- show_prices - shows or hides the cost of the subscription to that secure zone (true/false; default:true)
- render_json - renders a cancel link that allows the customer to cancel their subscription to the secure zone.
Menu Modules
{module_menu,menuID}
- Displays a single dynamic menu when placed on the page or a template. menuID is the ID of the particular dynamic menu and should not be changed. The ID is set by module manager when menu is inserted into the page.
WebForm Modules
{module_webform,formID}
-Displays a single web form on the page that matches the web form ID. Please note that you need to customize the form before you insert it onto the page as a module. One form cannot be inserted as a module and it is the form in eCommerce in the registration layout. formID should not be changed and it is assigned by module manager.
Product Modules
{module_productfeaturelist,tag,rowLength,sortType,targetFrame,useBackupTemplate}
Parameters
- tag being the product tag
- rowLength e.g. 3
- sortType can be alphabetical, price, date, expirydate or weight
- targetFrame e.g. _blank
- useBackupTemplate can be true or false
{module_product,catID,prodID,targetFrame}
Displays an individual product from a given catalogue on a web page according to a Small Product Layout (List Product Layout).
Parameters
- catID - system generated catalogue id (do not change)
- prodID - system generated product id (do not change)
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
Examples
{module_product,591,166845,_blank} - will display a single product according to the Small Product Layout inside a new window.
{module_productlistdump,-1,rowLength,targetFrame,sortBy}
Displays the List of all Products as names that are links to those products
Parameters
- -1 - please leave this parameter as is
- rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
- sortBy - will sort the item in specified order
- Alphabetical - sorts items alphabetically
- Weight - sorts items by weight
{module_productresults,rowLength,targetFrame,resultsPerPage,sortType,hideEmptyMessage,useLi}
- rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
- targetFrame - e.g. _blank. Specify the frame you want the item to open in
- resultsPerPage - specifies the number of results the search will display per page.
- sortType - sortType can be alphabetical, price or date
- hideEmptyMessage - specify True if you don't want the No Items Found message to be displayed
- UseLi - specify True to render the output in Li's instead of tables
Examples
{module_productlistdump,-1,1,_blank,Alphabetical} - this module will display the product list in the new window, alphabetically and all in one column
{module_shippingaddress}
This module displays the shipping address that's stored against the customer's record
{module_billingdetails}
This module displays the billing address that's stored against the customer's record
Search Modules
{module_searchresults,targetFrame,resultsPerPage}
- Displays site-wide search results. This module can reside on the same web page/template as the search box or it can reside on a different page. In the second case the action URL of the search box needs to be altered so that it redirects the visitor to the page this module resides on.
Parameters
- targetFrame - specifies in which frame the the results need to be opened
- resultsPerPage - specifies the number of results the search will display per page. Default is 10 results per page.
Examples of use
{module_searchresults,_blank,12} - This module will display 12 results per page in the new window.
Ad Rotator Modules
{module_adrotator,ID}
This module displays the individual Ad-Rotator.
Parameters
- ID - this parameter is assigned by the system and should nor be altered
Example
{module_adrotator,15264}
Photo Gallery Modules
{module_photogallery,ID,rowLength,targetFrame,resultsPerPage,Width,Height,UseStandardMethod}
This module takes in the additional parameters that allow you to customize it further:
{module_photogallery,ID,rowLength,targetFrame,resultsPerPage,Width,Height,UseStandardMethod}
Parameters
- ID - System generated ID (do not change)
- rowLength - Number of photos per row
- targetFrame - e.g. _blank. Specify the frame you want the photos to open in
- resultsPerPage - Number of photos per page
- Width/Height - The width and height of the thumbnail images. The default is 80 pixels.
- UseStandardMethod - Use the standard Thumbnail Generation. Set to False for better thumbnail quality (but increased file size).
Examples
Here is an example to display 4 photos per line and a maximum of 12 photos per page. The thumbnail size has also been set to 120x120 pixels.
{module_photogallery,id,4,,12,120,120,true}
Note: If an image is 640 pixels wide x 400 pixels high and you set the thumbnail size to 120 x 120 pixels the thumbnail image will have a maximum width of 120 and a smaller height. Proportions are respected when creating the thumbnail image. Alternatively if the image dimensions are 400 pixels wide x 640 pixels high then the height will be 120 pixels and the width smaller. The thumbnail size dictates the maximum width or the maximum height of the image.
Comments Modules
{module_ratingrank}
Displays rank of an item (number of stars)
{module_ratingfeedback,date}
Displays user comments on an item
If you add in the argument date after a commma then the order will change to Newest Posts First.
Bookings Modules
{module_booking,filter,ID or numberOfBookings}
Displays the list of of bookings according the bookings list layout.
Parameters
- filter - filtering criteria for display and can be one of the following:
- i - individual item
- a - all items
- l - latest items
- r - random item
- id - system generated (do not change)
- numberOfBookings - can be used in conjunction with l parameter to limit the number of bookings displayed
Examples
{module_booking,a,} - displays all bookings
{module_booking,i,24407} - displays individual booking with ID 24407
{module_booking,l,5} - displays 5 latest bookings
Blog Modules
{module_blog,filter,ID}
Displays the list of blogs according to the blog list layout. Recommended use is to link directly to an individual blog rather than use the blog module. Use the Link Manager for Blog URL.
Parameters
- filter - filtering criteria for display and can be one of the following:
- i - individual item
- a - all items
- l - latest items
- r - random item
- ID - system generated (do not change)
Examples of use
{module_blog,i,419} - will display the individual blog with ID of 419
{module_blogsitepost,numberOfPosts}
Displays latest posts across all blogs
Parameters
- numberOfPosts - limits the number of posts displayed by the module
{module_blogpostlist,ID,count,tag}
Displays latest posts across a single blog/tag
Parameters
- ID - system generated (do not change)
- count - how many posts to display - the default is 10
- tag - name of the single tag you want ot display the posts for
Example of use
{module_blogpostlist,419,1,business} - will display latest post in the blog with ID 419 where the tag is the word "business".
{module_blogsitesummary,ID,numberfOfPosts}
List of latest post names across all blogs (list format) or across the single blog
Parameters
- ID - if you use -1, you will display the summary across the whole site. For a single blog you need to use the blog ID.
- numberfOfPosts - limits the number of posts the module can display. Default is 5 posts.
Example of the output
1. Some Philosophical questions Richard Dawkins 01-Jan-2000 2. Welcome to my Blog! Woody Mark 01-Jan-2000
As you can see above, the module displays the number of the post followed by the name of the post that links to that post, the name of the author and the date.
RSS Modules
Web page Modules
{module_pagename}
- This module simply renders a web page name.
Examples of use
- The way to set up a different image which loads on a per page basis is to use the {module_pagename} to render the name of the page, but add this module to the image link, i.e. <img src=”/images/{module_pagename}.jpg”>. This will then render the word ‘About’ (if you are on a page named ‘About’) and the resulting image link would be <img src=”/images/About.jpg”>.
- You can also use this module between the title tags to set the title
{module_breadcrumbs,Separator}
- This module displays web page breadcrumbs which follow the sitemap.
Parameters
- Separator - can be any symbol such as > or : (default is column (:))
Examples of use
You can simply place {module_breadcrumbs,>} into the template and if you were to go to a page named Shirts which is under a page called Mens you will see this Mens > Shirts and then will all be links.
{module_backhome}
Link to go back to the home page. You can customize this link after inserting it into a web page or template.
{module_lastupdated}
Displays the last update date of a web page. If web page is using a template, last update date of template is never used only that of a web page.
{module_sitemap}
Inserts the current sitemap onto a web page. You can customize sitemap after inserting it into a web page.
{module_pageaddress}
Displays the URL of the current web page.
{module_referreraddress,target,text}
Displays a link to the referring page with the specified target and text.
Announcement Modules
{module_announcement}
{module_announcement,filter,id,noTemplate,effect,targetFrame,reserved,reserved,reserved,reserved,sort}
After adding the announcement module to a web page, you can make changes to it to slightly alter its behavior. Normally the module would look like:
{module_announcement,filter,id,noTemplate,effect,targetFrame,reserved,reserved,reserved,reserved,sort}
Parameters
- filter - filtering criteria for display and can be one of the following:
- i - individual item
- a - all items
- c - all items in some category
- cl - latest items in some category
- l - latest items
- r - random item
- id – system generated (do not change)
- noTemplate – if you want to force the item not to use a site-level template when displayed pass in true, otherwise leave empty
- effect – Enter ajax if you want to take advantage of the latest web technologies for a better customer experience
- targetFrame – the frame in which to open the item in
- reserved - for use in a future release
- sort - if you leave this parameter blank, by default announcements will be sorted from the latest to the oldest where the latest is displayed first
- alphabetical - will sort announcements alphabetically
- datereverse - will sort announcements in the reverse order, that is from the oldest to the latest
Examples of use
{module_announcement,a,,,,_parent} - will display all announcements and open them in parent frame
{module_announcement,l,5} - will display the latest 5 announcements.
{module_announcement,r,,true,ajax,_blank,,,,,datereverse} - will open a random item in a new window and will not apply the template and will use the Ajax effect where the detail content opens right underneath the announcement name and all the announcements will be displayed from the oldest to the latest
{module_announcement,cl,34392,,ajax,,,,,5} - will display the 5 latest announcements in category 34392
FAQ Modules
{module_faq,filter,id,noTemplate,effect,targetFrame}
After adding the FAQ module to a web page, you can make changes to it to slightly alter its behavior. Normally the module would look like:
{module_faq,filter,id,noTemplate,effect,targetFrame}
Parameters
- filter - filtering criteria for display and can be one of the following:
- i - individual item
- a - all items
- l - latest items
- r - random item
- id – system generated (do not change)
- noTemplate – if you want to force the item not to use a site-level template when displayed pass in true, otherwise leave empty
- effect – Enter ajax if you want to take advantage of the latest web technologies for a better customer experience
- targetFrame – the frame in which to open the item in
Examples of use
{module_faq,a,,,,_parent} - will display all announcements and open them in parent frame
{module_faq,l,5} - will display the latest 5 announcements.
{module_faq,r,,true,ajax,_blank} - will open a random item in a new window and will not apply the template and will use the Ajax effect where the detailed content opens right underneath the FAQ name.
{module_faqsearch}
Displays FAQ Search Form. You can customize form after inserting it into a web page or template.
{module_faqresults}
Displays the results of a FAQ search. Can be placed on the same page as the search form or a different page.
