Home

Download this help site
(PDF 80MB)

Download

Customizing theme gadgets

This functionality is only intended for experienced web designers

Icon

Please read this page before you proceed: Advanced customization warning
Theme override is intended for people with advanced web design skills. Incorrect use may result in your website malfunctioning.
Note: our technical support team does not provide support related to theme overrides.

Gadgets are elements used to display content on Wild Apricot site pages. Gadgets can be used to display page components such as login boxes, menus, forum updates, and membership registration forms, among many others. The appearance of gadgets will vary depending on the website theme, as will the gadget style options.

Gadgets, like controls and master layouts, are rendered using a combination of HTML and StringTemplate, a Java template engine.

Once you enable theme overrides and download the theme files, you'll find a Gadgets folder, containing files that control the behavior of the gadgets used in the theme.

Individual gadget configuration files

For each system gadget, there is a separate subfolder under Gadgets containing several files, including the following:

File

Description

MainConfig.cfg

Gadget configuration file.

GadgetTemplate.tpl

Gadget template file. This file provides the actual code for the gadget. You can modify this file to change how the gadget functions.


MainConfig.cfg is the main configuration file for your gadget. In it, you can set the following parameters:

Parameter

Description

Title

Full name of the gadget.

ShortTitle

Short name of the gadget.

Module

Name of the module providing the data to the gadget.

Description

Description of the gadget.

Icon

Icon to be displayed in gadget selection screen.

IconSmall

Small icon to be displayed in gadget selection screen.

Dedication

Type of gadget.

Classname

Class name to be added to gadget outer HTML.

Creating a new gadget

To create a new gadget, follow these steps:

  1. Create a folder under the Gadgets folder.
  2. Create MainConfig.cfg and GadgetTemplate.tpl files. 
  3. If you want, you can add gadget style settings to appear on the Colors & styles screen. For more information, see Customizing Colors and Styles options for themes.

Gadgets and modules

Gadgets can use modules. Modules provide additional data to be used by the gadget. For example, if you're creating photo album gadget, you'll need a collection of links to photos and thumbnails. If you're creating a login form gadget, you'll need the form URL to send login data to. 

See also Adding parameters to gadgets to learn how to add and use parameters in your gadget.

On this page: 

  • No labels
 
Wild Apricot Inc. 144 Front Street West Suite 725, Toronto, Ontario, Canada M5J 2L7