Choose Layout

You are here: Elements Reference > Custom Elements > Choose Layout

Choose Layout

For CommonSpot elements that support custom rendering (through either a render handler or display template) the element menu shows a Choose Layout option. Contributors can click this option to view all available layouts for the current element and to select, change, or add a layout.

This feature make it easy to preview and pick the best format for your content, or to quickly modify or create one that fits your needs. Each option displays with an explanatory description and a set of action options. The current default displays in bold.

The Use Default option sets the current element to use whatever Render Handler or Display Template is set as the default in Site Administration > Elements & Forms > Elements for the particular element you are working with.

NOTE: When elements are configured for theUse Default setting, changing the Default Layout in Site Administration changes ALL elements configured to Use Default. The change takes effect as soon as cache clears on the page.

The same dialog shown below is used for all elements that support a Render handler or Display Template, only the content differs based upon your customizations.
The Display Template option is available only for those elements that support a Display Template.
The Standard Rendering and Use Default options are always available even if there are no custom layouts defined.
The default setting for new elements is always Standard Rendering.

Click column heads to sort by Name or Description.

Note that CommonSpot provides two methods of customizing the rendering of element content. Both appear in the Choose Layouts listing.

Display Templates - WYSIWYG rendering templates that non-technical users can build by dropping field placeholders into a Rich Text Editor. At run time CommonSpot replaces field placeholders with element data. Note that Display Templates are currently available for Custom Elements only. See Element Display Templates in the Administrator's Reference
Render Handlers - Small ColdFusion or XSL modules written by developers that are invoked and passed the data for the element. The code renders the content using the data as it sees fit. (See Defining Render Handlers in the Administrator's Reference, and Custom Render Handlers in the Contributor's Reference.)

The layout listing grid displays the following columns:

Name: This column displays the CommonSpot name for the display template or render handler. Layouts with example images include a preview icon . Mouseover to see how Element data will display.

Description: Optional. Add a description to make selection easier.

Actions: Click the edit icon to modify a selected render handler or display template, or click Add Render Handler or Add Display Template to create a new layout for Element data. See the Administrator's Reference for details. Click the deleteicon to remove a layout record for this Element. Note that this removes the display template or render handler from this list, but does not delete the file. You cannot delete CommonSpot "factory" render handlers or display templates.

Click Save to apply the highlighted selection to the current Element or Cancel to exit without saving.

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/