User Guide Cancel

Use optional regions in templates

Last updated on Apr 27, 2021

Use optional regions in templates in Dreamweaver when you want to set conditions for displaying content in a document.

An optional region is a region in a template that users can set to show or to hide in a template-based document. Use an optional region when you want to set conditions for displaying content in a document.

When you insert an optional region, you can either set specific values for a template parameter or define conditional statements (If...else statements) for template regions. Use simple true/false operations, or define more complex conditional statements and expressions. You can later modify the optional region if necessary. Based on the conditions you define, template users can edit the parameters in template-based documents they create and control whether the optional region is displayed.

You can link multiple optional regions to a named parameter. In the template-based document, both regions will show or hide as a unit. For example, you can show a “closeout” image and sales price text area for a sale item.

Insert an optional region

Use an optional region to control content that may or may not be displayed in a template-based document. There are two types of optional regions:

Non-editable optional regions, which enable template users to show and hide specially marked regions without enabling them to edit the content.
The template tab of an optional region is preceded by the word if. Based on the condition set in the template, a template user can define whether the region is viewable in pages they create.
Editable optional regions, which enable template users to set whether the region shows or hides, and enable users to edit content in the region.
For example, if the optional region includes an image or text, the template user can set whether the content is displayed, as well as make edits to the content if desired. An editable region is controlled by a conditional statement.

Insert a non-editable optional region

In the Document window, select the element you want to set as an optional region.
Do one of the following:
- Select Insert > Template > Optional Region.
- In the Common category of the Insert panel, select Templates from the drop-down list, then select Optional Region.
Enter a name for the optional region, click the Advanced tab if you want to set values for the optional region, and then click OK.

Insert an editable optional region

In the Document window, place the insertion point where you want to insert the optional region.

Note:

You cannot wrap a selection to create an editable optional region. Insert the region, then insert the content in the region.
Do one of the following:
- Select Insert > Template > Editable Optional Region.
- In the Templates category of the Insert panel, select Editable Optional Region.
Enter a name for the optional region, click the Advanced tab if you want to set values for the optional region, and click OK.

Set values for an optional region

You can edit optional region settings after you’ve inserted the region in a template. For example, you can change whether the default setting for the content is to be displayed or not, to link a parameter to an existing optional region, or to modify a template expression.

Create template parameters and define conditional statements (If...else statements) for template regions. You can use simple true/false operations, or define more complex conditional statements and expressions.

In the Advanced tab you can link multiple optional regions to a named parameter. In the template-based document, both regions will show or hide as a unit. For example, you can show a “closeout” image and sales price text area for a sale item.

You can also use the Advanced tab to write a template expression that evaluates a value for the optional region and shows it or hides it based on the value.

In the Document window, do one of the following:
- In Design view, click the template tab of the optional region you want to modify.
- In Design view, place the insertion point in the template region; then in the tag selector at the bottom of the Document window, select the template tag, <mmtemplate:if>.
- In Code view, click the comment tag of the template region you want to modify.
In the Property inspector (Window > Properties), click Edit.
In the Basics tab, enter a name for the parameter in the Name box.
Select the Show By Default checkbox to set the selected region to show in the document. Deselect the checkbox to set the default value to false.

Note:

To set a different value for the parameter, in Code view locate the parameter in the section of the document and edit the value.
(Optional) Click the Advanced tab, then set the following options:
- If you want to link optional region parameters, click the Advanced tab, select Use Parameter, then from the pop‑up menu select the existing parameter you want to link the selected content to.
- If you want to write a template expression to control the display of an optional region, click the Advanced tab, select Enter Expression, then enter the expression in the box.
Note:

Dreamweaver inserts double-quotation marks around the text you enter.
Click OK.

When you use the Optional Region template object, Dreamweaver inserts template comments in the code. A template parameter is defined in the head section, as in the following example:

At the location where the optional region is inserted, code similar to the code below appears:
```

```
```
 
<p><img src="/images/airfare_on.gif" width="85" height="22"> </p> 

```
You can access and edit template parameters in the template-based document.

Get help faster and easier

New user?