Gantry provides full RTL (right-to-left) support allowing the ability to develop sites that use languages such as Hebrew, Arabic or Farsi. Find out more...

Custom Presets

This section covers the creation of a new custom preset in a Gantry-enabled template.

Creating a custom preset is a very simple task with Gantry. Check out this short video on how to customize your layout then create a custom preset based on your configuration options.

Step 1: Preparing

Gantry provides the ability for you to create your own custom presets based on any parameter in the template administrator. You should determine which parameters you wish to make a part of the presets. Write down their names as found in the templateDetails.xml file.

Step 2: Saving a Custom Preset

There are two types of presets. The first type is defined by the template itself. These are located in the $gantry_presets variable located in the gantry.config.php file.

$gantry_presets = array(
    'presets' => array(
        'preset1' => array(
            'name' => 'Preset 1',
            'cssstyle' => 'style1',
            'linkcolor' => '#2698de',
            'font-family' => 's:helvetica'
    ),
        'preset2' => array(
            'name' => 'Preset 2',
            'cssstyle' => 'style2',
            'linkcolor' => '#ff0000',
            'font-family' => 's:helvetica'
    ),
    ...

This array contains a set of presets comprised of another array of parameters along with a special parameter called name which is the display name for this preset.

The second kind of preset is the custom preset you can save from the template administrator. If you set a bunch of parameters in the administrator, you can click Save Preset from the Save button dropdown and save as new preset. This will save the same parameters as defined in the $gantry_presets variable. If you want to save new parameters, you will also need to add them to the $gantry_presets variable in order for them to be saved as a custom preset. If you save a custom preset, Gantry will create a file called presets.ini in your YOUR_SITE/templates/YOUR_TEMPLATE/custom/ folder. In the example below, we saved a custom preset and chose the name "New Preset" in the popup dialog.

newpreset_name="New Preset"
newpreset_linkcolor="#db2c2c"
newpreset_font-family="s:helvetica"

Step 3: Creating a Custom Thumbnail

When you create a new custom preset, there is a default image used in the preset chooser to represent this. You can create your own thumbnail for each style by creating a PNG file which is the 'short' name of the preset with the dimensions of 180px x 100px. For example, for our custom preset above, we would just create a small thumbnail called newpreset.png and put this file in the YOUR_SITE/templates/YOUR_TEMPLATE/admin/presets/ folder.

Step 4: Adding To Gantry's Presets

To transfer one of the custom presets into the core Gantry config file, you just need to convert the values in the preset.ini file into the array format as used in the gantry.config.php file. We've added this custom preset portion to the bottom of the array in the file:

...
'preset2' => array(
    'name' => 'Preset 1',
    'cssstyle' => 'style1',
    'linkcolor' => '#2698de',
    'font-family' => 's:helvetica'
),
'newpreset' => array(
    'name' => 'New Preset',
    'cssstyle' => 'style2',
    'linkcolor' => '#db2c2c',
    'font-family' => 's:helvetica'
),
...

Found errors? Think you can improve this documentation? Please edit this page. You can also view the history of this page.