Add Render Handler

You are here: Administrators Reference > Site Administration > Elements & Forms > Elements > Defining Render Handlers > Generic Render Handlers Overview > Add Render Handler

Add/Edit Render Handler

Access the Add/Edit Render Handler dialog from Manage Layouts (see Defining Render Handlers).

Click Add Render Handler to register a new code-based layout, or
Click the edit icon to view or change properties for render handlers already registered in CommonSpot, or
Click the edit icon . and select Edit to view or change properties for a Generic Render Handlers already registered in CommonSpot. For more information see the Generic Render Handlers Overview.

You can also access this option from the Layout or Choose Layout dialogs at the page level for elements that support custom rendering. See Elements with Support for Custom Render Handlers. See also the Elements Reference for details on customizing layout for individual elements.

For existing render handlers, this dialog displays in edit mode, as shown above, and contains the following fields:

Name - Required. Enter a unique name for the render handler.
Description - Optional. A text explanation of render handler function. Describe what the render handler does so that authors know which render handler to use. Text entered here displays in the Description column of the Manage Layouts dialog.
Rendering Type - Required. Whether the render handler is written in ColdFusion or XSL. Controls whether the Rendering Module field defaults to ColdFusion or XSL Transform modules for XSL files.
Native Code: Default. A CFML render handler.
XSL Transform: An XSL render handler.
Rendering Module/ XSL Transform - Location of the render handler module. Enter the path in the form shown above. /cs_customization/multimedia/{servicename}/renderhandlers/
Existing Modules/Transforms: Default. A dropdown displaying a list of modules currently available in the CommonSpot /sitename/renderhandlers/ directory
Explicit Module/Transform: When selected, displays a text field for entering an explicit pointer to the module. Supply a valid path name.
Properties - A group of fields that define render handler attributes.
Supports caching: If checked (default), CommonSpot saves render handler output until cache expiration and does not retrieve data for each request.
Supports HTML and XML rendering: If checked, this Element render handler applies to both HTML and XML Element renderings when the "xml=1" flag has been added to the page. Defaults to unchecked.
Invokes Display Template: When checked, displays a dropdown for calling a Display Template - an HTML module for formatting render handler code.
- Default Display Template: Pick from the dropdown to choose the display template to use by default for this render handler.
Display Menus - By default, Layout and Font & Color properties do not display as options for developers coding render handler modules. You can give developers the option of adjusting rendering based on these properties, or use Display Menus settings to provide additional options to authors with design privileges. If enabled, settings made through these options are passed to the render handler.
Layout Properties: When checked, layout option display for defining output render handling. Defaults to unchecked.
Style Properties: When checked, style setting options display for defining output render handling. Defaults to unchecked.
Preview Image: Displays an existing preview image with pathname, as shown below.
This image displays on mouseover for this render handler in the Manage Layouts dialog. Clicking Clear removes the current image. Clicking Select displays the Choose Image dialog for selecting or uploading a new preview image.

Dependencies: You can automatically load resources and libraries required by your modules once you register them in CommonSpot. This field displays any registered resources loaded by this module. See Site Administration - Resources and Libraries. If the code requests a resource by its alias, CommonSpot identifies the library that the alias resolves to. If code requests a resource that does not exist or that is not registered, CommonSpot reports an error.

Related Links

You can download PDF versions of the Content Contributor's, Administrator's, and Elements Reference documents from the support section of paperthin.com (requires login).

The following guides are available from the support site and are in the /docs/directory of your CommonSpot Server:

You can also download these other guides from the support section of paperthin.com (with login):

For technical support:

http://www.paperthin.com/support/