EkML Templates

Ektron, Inc. provides an EkML basic template for each control. These templates are located in [webroot]/Workarea/Templates. At the top of each template is a list of variables that can be used with that control.

WARNING! You should save the template under another name and use that template. This prevents your file from being overwritten when upgrades occur.

NOTE: If you install the Developer site, .ekml template files reside in various project folders. These files exemplify using the .ekml with a specific server control.

collection.ekml

This file defines which items and information are included when displaying content item information in a collection using the Collection server control.

collection.ekml variables

collection.ekml Variables

[$CollectionDescription]—Display the collection’s description. [$CollectionDescription]
[$CollectionTitle]—Display the collection’s title. [$CollectionTitle]
[$Comment]—Displays the content’s comment information. [$Comment]
[$ContentId] —Displays the content item’s ID. [$ContentId]
[$DateCreated]—Display the date the content was created. [$DateCreated]
[$DateModified]—Display the date the content was last modified. [$DateModified]
[$EditorFirstName]—Display the last editor’s first name for a content item. [$EditorFirstName]
[$EditorLastName]—Display the last editor’s last name for a content item. [$EditorLastName]
[$FolderId]—Display the folder ID of a content item. [$FolderId]
[$Html]—Display the HTML contained in the content item. [$Html]
[$HyperLink]—Adds a hyperlink using the title of the content block as the text. [$HyperLink]
[$Image]—Displays the path for the image defined in a content item’s Metadata. When wrapped in <img src=””/> tag, the image appears. For example: <img src=”[$Image]”/> See: [$Image]
[$ImageIcon]—Displays an image icon for the content item. For example, if the content item is HTML, the () icon appears. [$ImageIcon]
[$ImageThumbnail]—Displays the path for the image’s thumbnail defined in a content item’s Metadata. When wrapped in <img src=””/> tag, a thumbnail version of the image appears. For example: <img src=”[$ImageThumbnail]”/>. See: [$ImageThumbnail]
[$Index]—Serialize the content items in a numbered list. [$Index]
[$ItemCount]—The total number of items in a list. [$ItemCount]
[$Language]—Display the language ID for the content item. [$Language]
[$LinkTarget]—When added to an <a href=””> tag’s target=”” attribute, this variable reads the server control’s LinkTarget property and uses its setting. [$LinkTarget]
[$QuickLink]—This property displays the Quicklink information for the content item. When wrapped in an <a href=””> tag, you can create a Hyperlink. [$QuickLink]
[$SERVER_NAME]—Displays the server name. For example, If this variable is applied to
http://www.example.com/demo.aspx, the return is www.example.com. [$SERVER_NAME]
[$ShowBubble(width)]—This is similar to [$ShowBubble]. It calls the <ekbubbleinfo> tags and lets you set the width of the bubble. [$ShowBubble(width,height)]
[$ShowBubble]—Calls the <ekbubbleinfo> tags and places the information contained within those tags in a pop-up bubble. [$ShowBubble]
[$ShowContent(‘htmltagid’)]—Calls the <ekcontentinfo> tags an places the information in those tags within the specified HTML tag ID. Replace the 'htmltagid' with the ID of the tag. [$ShowContent(‘htmltagid’)]
[$Status]—Displays the status of a content item. [$Status]
[$Teaser]—Display the content item’s summary information. If the item is an HTML form, this variable is not supported with this ekml file. [$Teaser]
[$Title]—Displays the content item’s title. [$Title]
[$UrlEncode(‘str’)]—Encodes the string information. This variable can be used to encode another EkML variable and place it in an email. [$UrlEncode(‘str’)]
[$UrlParam(‘paramname’)]—Displays the value of a query string’s parameter. For example, if the query string is ?id=27 and the variable is [$UrlParam(‘id’)], 27 appears. [$UrlParam(‘paramname’)]

[$CollectionDescription]

Display the collection’s description.

<ekmarkup>
<ekoutput>      <h3><b>[$CollectionTitle]</b></h3><p/>[$CollectionDescription]<br/>
    <table width="100%"  border="0">
      <ekrepeat>
        <tr>
          <td>
            [$Index]. [$HyperLink]
          </td>
        </tr>
      </ekrepeat>
    </table>
  </ekoutput>
</ekmarkup>

[$CollectionTitle]

Display the collection’s title.

<ekmarkup>
  <ekoutput>
    <h3><b>[$CollectionTitle]</b></h3>
    <table width="100%"  border="0">
      <ekrepeat>
        <tr>
          <td>
            [$Index]. [$HyperLink]
          </td>
        </tr>
      </ekrepeat>
    </table>
  </ekoutput>
</ekmarkup>

contentlist.ekml

This file defines which items and information are included when displaying content item information in a content list using the ContentList server control.

listsummary.ekml

This file defines which items and information are included when displaying content item information in a list summary using the ListSummary server control. For an example of using this file with a ListSummary server control, see the Ektron demo example: http://<your site>/CMS400Developer/Developer/ListSummary/TemplateMarkup.aspx.

ListSummary.ekml variables

ListSummary.ekml Variables

[$Comment]—Displays the content’s comment information. [$Comment]
[$ContentId] —Displays the content item’s ID. [$ContentId]
[$DateCreated]—Display the date the content was created. [$DateCreated]
[$DateModified]—Display the date the content was last modified. [$DateModified]
[$EditorFirstName]—Display the last editor’s first name for a content item. [$EditorFirstName]
[$EditorLastName]—Display the last editor’s last name for a content item. [$EditorLastName]
[$FolderDescription]—Displays the folder’s description. $FolderDescription
[$FolderId]—Display the folder ID of a content item. [$FolderId]
[$FolderName]—Displays the folder’s name. [$FolderName]
[$Html]—Display the HTML contained in the content item. [$Html]
[$HyperLink]—Adds a hyperlink using the title of the content block as the text. [$HyperLink]
[$Image]—Displays the path for the image defined in a content item’s Metadata. When wrapped in <img src=””/> tag, the image appears. For example: <img src=”[$Image]”/>[$Image]
[$ImageIcon]—Displays an image icon for the content item. For example, if the content item is HTML, the () icon appears. [$ImageIcon]
[$ImageThumbnail]—Displays the path for the image’s thumbnail defined in a content item’s Metadata. When wrapped in <img src=””/> tag, a thumbnail version of the image appears. For example: <img src=”[$ImageThumbnail]”/>[$ImageThumbnail]
[$Index]—Serialize the content items in a numbered list. [$Index]
[$ItemCount]—The total number of items in a list. [$ItemCount]
[$Language]—Display the language ID for the content item. [$Language]
[$LinkTarget]—When added to an <a href=””> tag’s target=”” attribute, this variable reads the server control’s LinkTarget property and uses its setting. [$LinkTarget]
[$QuickLink]—This property displays the Quicklink information for the content item. When wrapped in an <a href=””> tag, you can create a Hyperlink. [$QuickLink]
[$SERVER_NAME]—Displays the server name. For example, If this variable is applied to http://www.example.com/demo.aspx, the return is www.example.com. [$SERVER_NAME]
[$ShowBubble(width)]—This is similar to [$ShowBubble]. It calls the <ekbubbleinfo> tags and lets you set the width of the bubble. [$ShowBubble(width,height)]
[$ShowBubble]—Calls the <ekbubbleinfo> tags and places the information contained within those tags in a pop-up bubble. [$ShowBubble]
[$ShowContent(‘htmltagid’)]—Calls the <ekcontentinfo> tags an places the information in those tags within the specified HTML tag ID. Replace the 'htmltagid' with the ID of the tag. [$ShowContent(‘htmltagid’)]
[$Status] —Displays the status of a content item. [$Status]
[$Teaser]—Displays the content item’s summary information. If the item is an HTML form, this variable is not supported with this ekml file. [$Teaser]
[$Title]—Displays the content item’s title. [$Title]
[$UrlEncode(‘str’)]—Encodes the string information. This variable can be used to encode another EkML variable and place it in an email. [$UrlEncode(‘str’)]
[$UrlParam(‘paramname’)]—Displays the value of a QueryString’s parameter. For example, if the QueryString is ?id=27 and the variable is [$UrlParam(‘id’)], 27 appears. [$UrlParam(‘paramname’)]

[$FolderDescription]

$FolderDescription

Displays the folder’s description.

<ekmarkup>
  <ekoutput>
    <h3><b>[$FolderName]</b></h3><p/>[$FolderDescription]<br/>
    <table width="100%"  border="0">
      <ekrepeat>
        <tr>
          <td>
            [$Index]. [$HyperLink]
          </td>
        </tr>
      </ekrepeat>
    </table>
  </ekoutput>
</ekmarkup>

[$FolderName]

Displays the folder’s name.

<ekmarkup>
  <ekoutput>
    <h3><b>[$FolderName]</b></h3><p/>[$FolderDescription]<br/>
    <table width="100%"  border="0">
      <ekrepeat>
        <tr>
          <td>
            [$Index]. [$HyperLink]
          </td>
        </tr>
      </ekrepeat>
    </table>
  </ekoutput>
</ekmarkup>

map.ekml

The map.ekml file defines which items and information are included when using the Map server control. Unlike most other .ekml files, the map.emkl has some variables that cannot be changed or moved around.

The file’s variables appear in 3 <tr></tr> table rows. These rows are located below the main table. In the first 2 table rows, you can modify a tag’s style information only. In the third, you can change the style information and the order of the variables to create different layouts for your page. It is recommended you hide the first 2 table rows if you are not changing their style information. For example:

When using the map.ekml file remember these 3 rules.

Do not change any of the IDs.
You can change any tag’s style information.
You can move the variables in the third table row around to create different layouts. For example, you can display these sections horizontally or vertically.

__Map

Displays the map section of the Map server control.

Search Txt result pane

Search Txt Result Pane

Displays the results pane from the search.

__RouteInfoPane

The panel that displays driving directions from the starting address to the arrival address.

messageboard.ekml

This file defines which items and information are included when displaying message information for a message board using the MessageBoard server control.

messageboard.ekml variables

messageboard.ekml Variables

[$AddCommentBox]—Displays the Add Comment text box and button for a message board. [$AddCommentBox]
[$ApproveMessageLink]—Display an Approve link to approve comments when message board moderation is active. [$ApproveMessageLink]
[$Avatar]—Display the profile image of the member who entered the comments on the message board. [$Avatar]
[$DateCreated]—Display the date the content was created. [$DateCreated]
[$DateModified]—Display the date the content was last modified. [$DateModified]
[$DeleteMessageLink]—Displays the Delete link for a comment on the message board. Only Administrators, the person who left the message or the person who owns the board. [$DeleteMessageLink]
[$DisplayName]—Displays the display name of the member who left the message. [$DisplayName]
[$EmailAddress]—Displays the email address of the member who left the message on the board. [$EmailAddress]
[$FirstName]—Display the first name of the person who left the comment on the message board. [$FirstName]
[$LastName]—Display the last name of the person who left the comment on the message board. [$LastName]
[$MessageText]—Displays the message on a message board. [$MessageText]
[$NumberComments]—Displays the number of comments posted to a message board. [$NumberComments]
[$UserName]—Display the Username of a user who left a comment on a message board. [$UserName]

[$AddCommentBox]

Displays the Add Comment text box and button for a message board.

<ekoutput>
  <div class="ContributionForm">
    <h4>[$NumberComments] Comments</h4>
    <ul>
      <ekrepeat>
        <li class="ekMessagePost">
          <div class="avatar">[$Avatar]</div>
          <div class="message">
            <div class="metaData">
              <span class="username">[$UserName]</span>
              <span class="time">[$DateCreated]</span>
            </div>
            <p>[$MessageText]</p>
            <ul class="commands">
              <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
              <li class="ekApproveMessage">[$ApproveMessageLink]</li>
            </ul>
          </div>
        </li>
      </ekrepeat>
    </ul>
[$AddCommentBox]
                                
  </div>
</ekoutput>

[$ApproveMessageLink]

Displays the Approve link for the message. This link is used to approve the message for display when the Moderate property is set to true. Only Administrators, the person who left the message, or the person who owns the board can see this link.

<ekoutput>
  <div class="ContributionForm">
    <h4>[$NumberComments] Comments</h4>
    <ul>
      <ekrepeat>
        <li class="ekMessagePost">
          <div class="avatar">[$Avatar]</div>
          <div class="message">
            <div class="metaData">
              <span class="username">[$UserName]</span>
              <span class="time">[$DateCreated]</span>
            </div>
            <p>[$MessageText]</p>
            <ul class="commands">
              <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
              <li class="ekApproveMessage">[$ApproveMessageLink]</li>
            </ul>
          </div>
        </li>
      </ekrepeat>
    </ul>
    [$AddCommentBox]
  </div>
</ekoutput>

[$Avatar]

Display the profile image of the member who entered the comments on the message board.

<ekoutput>
  <div class="ContributionForm">
    <h4>[$NumberComments] Comments</h4>
    <ul>
      <ekrepeat>
        <li class="ekMessagePost">
          <div class="avatar">[$Avatar]</div>
          <div class="message">
            <div class="metaData">
              <span class="username">[$UserName]</span>
              <span class="time">[$DateCreated]</span>
            </div>
            <p>[$MessageText]</p>
            <ul class="commands">
              <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
              <li class="ekApproveMessage">[$ApproveMessageLink]</li>
            </ul>
          </div>
        </li>
      </ekrepeat>
    </ul>
    [$AddCommentBox]
  </div>
</ekoutput>

[$DeleteMessageLink]

Displays the Delete link for a comment on the message board. Only Administrators, the person who left the message or the person who owns the board.

<ekoutput>
  <div class="ContributionForm">
    <h4>[$NumberComments] Comments</h4>
    <ul>
      <ekrepeat>
        <li class="ekMessagePost">
          <div class="avatar">[$Avatar]</div>
          <div class="message">
            <div class="metaData">
              <span class="username">[$UserName]</span>
              <span class="time">[$DateCreated]</span>
            </div>
            <p>[$MessageText]</p>
            <ul class="commands">
              <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
              <li class="ekApproveMessage">[$ApproveMessageLink]</li>
            </ul>
          </div>
        </li>
      </ekrepeat>
    </ul>
    [$AddCommentBox]
  </div>
</ekoutput>

[$DisplayName]

Displays the display name of the member who left the message.

<ekoutput>
  <div class="ContributionForm">
    <h4>[$NumberComments] Comments</h4>
    <ul>
      <ekrepeat>
        <li class="ekMessagePost">
          <div class="avatar">[$Avatar]</div>
          <div class="message">
            <div class="metaData">
              <span class="username">[$DisplayName]</span>
              <span class="time">[$DateCreated]</span>
            </div>
            <p>[$MessageText]</p>
            <ul class="commands">
              <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
              <li class="ekApproveMessage">[$ApproveMessageLink]</li>
            </ul>
          </div>
        </li>
      </ekrepeat>
    </ul>
    [$AddCommentBox]
  </div>
</ekoutput>

[$EmailAddress]

Displays the email address of the member who left the message on the board. To create a hyperlinked email, wrap the [$EmailAddress] variable in a <a> tag with the mailto: variable. For example:

<a href="Mailto:[$EmailAddress]">[$EmailAddress]</a>

<ekoutput>
  <div class="ContributionForm">
    <h4>[$NumberComments] Comments</h4>
    <ul>
      <ekrepeat>
        <li class="ekMessagePost">
          <div class="avatar">[$Avatar]</div>
          <div class="message">
            <div class="metaData">
              <span class="username">[$UserName]&#160;&#160;<a href="Mailto:[$EmailAddress]">[$EmailAddress]</a>
            </span>
              <span class="time">[$DateCreated]</span>
            </div>
            <p>[$MessageText]</p>
            <ul class="commands">
              <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
              <li class="ekApproveMessage">[$ApproveMessageLink]</li>
            </ul>
          </div>
        </li>
      </ekrepeat>
    </ul>
    [$AddCommentBox]
  </div>
</ekoutput>

[$FirstName]

Displays the first name of the user who left a comment on a message board.

<ekoutput>
    <div class="ContributionForm">
      <h4>[$NumberComments] Comments</h4>
      <ul>
        <ekrepeat>
          <li class="ekMessagePost">
            <div class="avatar">[$Avatar]</div>
            <div class="message">
              <div class="metaData">
                <span class="username">[$FirstName] [$LastName]</span>
                <span class="time">[$DateCreated]</span>
              </div>
              <p>[$MessageText]</p>
              <ul class="commands">
                <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
                <li class="ekApproveMessage">[$ApproveMessageLink]</li>
              </ul>
            </div>
          </li>
        </ekrepeat>
      </ul>
      [$AddCommentBox]
    </div>
  </ekoutput>

[$LastName]

Displays the last name of the user who left a comment on a message board.

<ekoutput>
    <div class="ContributionForm">
      <h4>[$NumberComments] Comments</h4>
      <ul>
        <ekrepeat>
          <li class="ekMessagePost">
            <div class="avatar">[$Avatar]</div>
            <div class="message">
              <div class="metaData">
                <span class="username">[$FirstName] [$LastName]</span>
                <span class="time">[$DateCreated]</span>
              </div>
              <p>[$MessageText]</p>
              <ul class="commands">
                <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
                <li class="ekApproveMessage">[$ApproveMessageLink]</li>
              </ul>
            </div>
          </li>
        </ekrepeat>
      </ul>
      [$AddCommentBox]
    </div>
  </ekoutput>

[$MessageText]

Displays the text of a message on a message board.

<ekoutput>
    <div class="ContributionForm">
      <h4>[$NumberComments] Comments</h4>
      <ul>
        <ekrepeat>
          <li class="ekMessagePost">
            <div class="avatar">[$Avatar]</div>
            <div class="message">
              <div class="metaData">
                <span class="username">[$UserName]</span>
                <span class="time">[$DateCreated]</span>
              </div>
              <p>[$MessageText]</p>
              <ul class="commands">
                <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
                <li class="ekApproveMessage">[$ApproveMessageLink]</li>
              </ul>
            </div>
          </li>
        </ekrepeat>
      </ul>
      [$AddCommentBox]
    </div>
  </ekoutput>

[$NumberComments]

Displays the number of comments posted on the message board.

<ekoutput>
  <div class="ContributionForm">
    <h4>[$NumberComments] Comments</h4>
    <ul>
      <ekrepeat>
        <li class="ekMessagePost">
          <div class="avatar">[$Avatar]</div>
          <div class="message">
            <div class="metaData">
              <span class="username">[$UserName]</span>
              <span class="time">[$DateCreated]</span>
            </div>
            <p>[$MessageText]</p>
            <ul class="commands">
              <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
              <li class="ekApproveMessage">[$ApproveMessageLink]</li>
            </ul>
          </div>
        </li>
      </ekrepeat>
    </ul>
    [$AddCommentBox]
  </div>
</ekoutput>

[$UserName]

Display the Username of a user who left a comment on a message board.

<ekoutput>
    <div class="ContributionForm">
      <h4>[$NumberComments] Comments</h4>
      <ul>
        <ekrepeat>
          <li class="ekMessagePost">
            <div class="avatar">[$Avatar]</div>
            <div class="message">
              <div class="metaData">
                <span class="username">[$UserName]</span>
                <span class="time">[$DateCreated]</span>
              </div>
              <p>[$MessageText]</p>
              <ul class="commands">
                <li class="ekDeleteMessage">[$DeleteMessageLink]</li>
                <li class="ekApproveMessage">[$ApproveMessageLink]</li>
              </ul>
            </div>
          </li>
        </ekrepeat>
      </ul>
      [$AddCommentBox]
    </div>
  </ekoutput>

metadatalist.ekml

This file defines which items and information are included when displaying content item information for a metadata list using the MetadataList server control.

metadatlist.ekml variables

metadatlist.ekml Variables

[$Comment]—Displays the content’s comment information. [$Comment]
[$ContentId] —Displays the content item’s ID. [$ContentId]
[$DateCreated]—Display the date the content was created. [$DateCreated]
[$DateModified]—Display the date the content was last modified. [$DateModified]
[$EditorFirstName]—Display the last editor’s first name for a content item. [$EditorFirstName]
[$EditorLastName]—Display the last editor’s last name for a content item. [$EditorLastName]
[$FolderId] —Display the folder ID of a content item. [$FolderId]
[$Html]—Display the HTML contained in the content item. [$Html]
[$HyperLink]—Adds a hyperlink using the title of the content block as the text. [$HyperLink]
[$Image]—Displays the path for the image defined in a content item’s Metadata. When wrapped in <img src=””/> tag, the image appears. [$Image]
[$ImageIcon]—Displays an image icon for the content item. For example, if the content item is HTML, the () icon appears. [$ImageIcon]
[$ImageThumbnail]—Displays the path for the image’s thumbnail defined in a content item’s Metadata. [$ImageThumbnail]
[$Index]—Serialize the content items in a numbered list. [$Index]
[$ItemCount]—The total number of items in a list. [$ItemCount]
[$Language]—Display the language ID for the content item. [$Language]
[$LinkTarget]—When added to an <a href=””> tag’s target=”” attribute, this variable reads the server control’s LinkTarget property and uses its setting. [$LinkTarget]
[$QuickLink]—This property displays the Quicklink information for the content item. When wrapped in an <a href=””> tag, you can create a Hyperlink. [$QuickLink]
[$SERVER_NAME]—Displays the server name. For example, If this variable is applied to http://www.example.com/demo.aspx, the return is www.example.com. [$SERVER_NAME]
[$ShowBubble(width)]—This is similar to [$ShowBubble]. It calls the <ekbubbleinfo> tags and lets you set the width of the bubble. [$ShowBubble(width,height)]
[$ShowBubble]—Calls the <ekbubbleinfo> tags and places the information contained within those tags in a pop-up bubble. [$ShowBubble]
[$ShowContent(‘htmltagid’)]—Calls the <ekcontentinfo> tags an places the information in those tags within the specified HTML tag ID. Replace the 'htmltagid' with the ID of the tag. [$ShowContent(‘htmltagid’)]
[$Status]—Displays the status of a content item. [$Status]
[$Teaser]—Display the content item’s summary information. If the item is an HTML form, this variable is not supported with this ekml file. [$Teaser]
[$Title]—Displays the content item’s title. [$Title]
[$UrlEncode(‘str’)]—Encodes the string information. This variable can be used to encode another EkML variable and place it in an email. [$UrlEncode(‘str’)]
[$UrlParam(‘paramname’)]—Displays the value of a QueryString’s parameter. For example, if the QueryString is ?id=27 and the variable is [$UrlParam(‘id’)], 27 appears. [$UrlParam(‘paramname’)]

taxonomy.ekml

This file defines which items and information are included when displaying taxonomy item information using the Directory server control. Similar to maps.ekml, the taxonomy.ekml works differently than other .ekml files.

The Directory server control produces multiple areas where content or functionality is defined. To specify these areas in a template, you would call the <ekoutput> tag with the mode attribute equaling the area you want to define. For example, in the Directory server control, you can define information in the breadcrumb area of the server control by using <ekoutput mode=”breadcrumb”>.

Additional descriptions and commenting in the taxonomy.ekml file will assist you with learning about EkML with taxonomy. This file is located in <web root>/CMS400Developer/Workarea/template/taxonomy/taxonomy.ekml.

Taxonomy <ekoutput> modes

The following <ekoutput modes=””> are used with the taxonomy.ekml template.

EkML Tag	Description
`<ekoutput mode=”breadcrumb”>`	Defines the display of the breadcrumb portion of the taxonomy. Within these tags you can define: `<bctitle>`—title for the breadcrumbs `<bcrootlink>`—root link text `<bcseparator>`—separator used to between breadcrumbs in the breadcrumb trail `<bchyperlink>`—hyperlinks in the breadcrumb trail `<bcactivelink>`—the current active breadcrumb item
`<ekoutput mode=”category”>`	Defines how the category information appears. Within these tags you can define: `<ekcolrepeat>` takes the category links and spreads them over the amount of columns that are defined in the Directory server control's `TaxonomyCol` property. This tag must appear within `<ekrepeat>` tags.
`<ekoutput mode=”categorybacklink”>`	Defines information about the link that moves the category up one level. This can be a text link or an image link. In this mode, you need to define the following tags: <ekactivebacklink> </ekactivebacklink>—between these tags, define what appears when a user is in a sub category. Add the [$categorybacklink] variable between these tags and an clickable image appears that allows a user to navigate one level up. <ekdisablebacklink> </ekdisablebacklink>—between these tags, define what happens when a user is at the top level category. Add the [$categorybacklink] variable between these tags with an <a> tag have users navigate to another location. For example: `<a href="http://www.example.com" target="_blank">[$categorybacklink]</a>` See Also: [$categorybacklink]
`<ekoutput mode=”article_search”>`	Defines how the search results from the taxonomy are displayed.
`<ekoutput mode=”article”>`	Defines the display of an individual content item in your taxonomy.
`<ekoutput mode=”view”>`	This section defines the overall output view of the Taxonomy. It denotes the locations of the Search box, Breadcrumb, Category and Articles.

taxonomy.ekml variables

taxonomy.ekml Variables

[$AddArticle]—Adds a link that allows a logged in user to add HTML content to Ektron. [$AddArticle]
[$AddAsset]—Adds a link that allows a logged in user to add assets to Ektron. [$AddAsset]
[$categorybacklink]—When placed between <ekactivebacklink> tags, this variable adds a clickable image that allows a user to navigate up one category level. When placed between <ekdisablebacklink> tags and in the text area of an <a> tag, this variable adds a clickable image that allows a user to navigate to another URL once they reach the top level category. [$categorybacklink]
[$CategoryID]—The ID of a taxonomy’s category.
[$ContentByteSize]—Displays the content item’s size in KB. Works only with taxonomy search. <ekoutput mode=”article_search”>[$ContentByteSize]
[$ContentId]—Displays the content item’s ID. [$ContentId]
[$DateCreated]—Display the date the content was created. [$DateCreated]
[$DateModified]—Display the date the content was last modified. [$DateModified]
[$EditorFirstName]—Display the last editor’s first name for a content item. [$EditorFirstName]
[$EditorLastName]—Display the last editor’s last name for a content item. [$EditorLastName]
[$FolderId] —Display the folder ID of a content item. [$FolderId]
[$Html]—Display the HTML contained in the content item. [$Html]
[$HyperLink]—Adds a hyperlink using the title of the content block as the text. [$HyperLink]
[$ImageIcon]—Displays an image icon for the content item type. For example, if the content item is HTML, the () icon appears. [$ImageIcon]
[$Index]—Serialize the content items in a numbered list. [$Index]
[$ItemCount]—The total number of items in a list. [$ItemCount]
[$Language]—Display the language ID for the content item. [$Language]
[$LinkTarget]—When added to an <a href=””> tag’s target=”” attribute, this variable reads the server control’s LinkTarget property and uses its setting. [$LinkTarget]
[$PagingCurrentEndIndex]—The end count number of the items
on the page. For example, if you are displaying items 11—20 on a page, this variable represents the number 20. Works only with taxonomy search. <ekoutput mode=”article_search”>[$PagingCurrentEndIndex]
[$PagingCurrentStartIndex]—The numerical record of the first item on a page. For example, if you are displaying items 1 through 10 out of 50 total items on a page, this variable represents the number 1. Works only with taxonomy search. <ekoutput mode=”article_search”>[$PagingCurrentStartIndex]
[$QuickLink]—This property displays the Quicklink information for the content item. When wrapped in an <a href=””> tag, you can create a Hyperlink. [$QuickLink]
[$SearchDuration]—Displays the amount of time, in seconds, it has taken to execute the search. Works only with taxonomy search. <ekoutput mode=”article_search”>[$SearchDuration]
[$SearchSummary]—Creates a summary from information stored in the indexing service for each item in the search results. Works only with taxonomy search. <ekoutput mode=”article_search”>[$SearchSummary]
[$SearchText]—Displays the text for which a user is searching. This information is same as what a user entered in the search text box. Works only with taxonomy search. <ekoutput mode=”article_search”>[$SearchText]
[$SERVER_NAME]—Displays the server name. For example, If this variable is applied to http://www.example.com/demo.aspx, the return is www.example.com. [$SERVER_NAME]
[$ShowAllcategory]—Adds to the Taxonomy search screen a checkbox that lets the user decide whether to display categories that have no items. [$ShowAllcategory]
[$ShowBubble]—Calls the <ekbubbleinfo> tags and places the information contained within those tags in a pop-up bubble. [$ShowBubble]
[$ShowBubble(width)]—This is similar to [$ShowBubble]. It calls the <ekbubbleinfo> tags and lets you set the width of the bubble.
[$ShowBubble(width,height)]
[$ShowBubble(width,height)]—This is similar to [$ShowBubble]. It calls the <ekbubbleinfo> tags and lets you set the width and height of the bubble. [$ShowBubble(width,height)]
[$ShowContent(‘htmltagid’)]—Calls the <ekcontentinfo> tags an places the information in those tags within the specified HTML tag ID. Replace the 'htmltagid' with the ID of the tag. [$ShowContent(‘htmltagid’)]
[$Status]—Displays the status of a content item. [$Status]
[$Teaser]—Display the content item’s summary information. If the item is an HTML form, this variable is not supported with this ekml file. [$Teaser]
[$TemplateQuickLink]—This property displays the Template Quicklink information assigned to the taxonomy item in the Workarea. When wrapped in an <a href=””> tag, you can create a Hyperlink. [$TemplateQuickLink]
[$Title]—Displays the content item’s title. [$Title]
[$UrlEncode(‘str’)]—Encodes the string information. This variable can be used to encode another EkML variable and place it in an email. [$UrlEncode(‘str’)]
[$UrlParam(‘paramname’)]—Displays the value of a QueryString’s parameter. For example, if the QueryString is ?id=27 and the variable is [$UrlParam(‘id’)]code, 27 appears.[$UrlParam(‘paramname’)]

[$AddArticle]

This variable adds a link that allows a user to add HTML content to Ektron. Clicking the link opens an editor. When the content is added, it’s automatically added to the taxonomy category associated with the Directory server control. When you allow users to add content using this variable, you should set the AddItemFolderID property in the Directory server control to the folder ID where the content will be stored. This variable should not be added between the <ekrepeat></ekrepeat> tags.

<tr>
  <td>
    [$AddArticle]
  </td>
</tr>

[$AddAsset]

This variable adds a link that allows a user to add assets to Ektron via a drag and drop box. When the asset is added, it’s automatically added to the taxonomy category associated with the Directory server control. When you allow users to add assets using this variable, you should set the AddItemFolderID property in the Directory server control to the folder ID where the asset will be stored. This variable should not be added between the <ekrepeat></ekrepeat> tags.

<tr>
  <td>
    [$AddAsset]
  </td>
</tr>

[$TemplateQuickLink]

This variable displays the Template Quicklink information assigned to the taxonomy item in the Workarea. When wrapped in an <a href=””> tag, you can create a Hyperlink.

<ekmarkup>
  <ekoutput>
    <table width="100%"  border="0">
      <ekrepeat>
      <tr>
        <td>
         <a href="[$TemplateQuickLink]">[Title]</a><br/>[$Teaser]
        </td>
      </tr>
      </ekrepeat>
    </table>
  </ekoutput>
</ekmarkup>

[$categorybacklink]

When placed between <ekactivebacklink> tags, this variable adds a clickable image that allows a user to navigate up one category level.

When placed between <ekdisablebacklink> tags and in the text area of an <a> tag, this variable adds a clickable image that allows a user to navigate to another URL once they reach the top level category.

<ekoutput mode="categorybacklink">
  <ekactivebacklink>
    [$categorybacklink]
  </ekactivebacklink>
    <ekdisablebacklink>
    <a href="http://www.example.com" target="_blank">[$categorybacklink]</a>
    </ekdisablebacklink>
</ekoutput>

websearch.ekml

This file defines which items and information are included when displaying search results using the WebSearch server control.

NOTE: The WebSearch server control is deprecated as of Release 8.5. Instead of the Web search control, you should convert to templated search

The websearch.ekml template needs 2 <ekoutput> nodes.

The first <ekoutput> node formats the results of non-image searches
The second <ekoutput> node formats results that include images

websearch.ekml variables

websearch.ekml Variables

[$ContentByteSize]—Displays the size of the content item. [$ContentByteSize]
[$ContentId]—Display the content ID number assigned to the content. [$ContentId]
[$DateModified]—Display the date the content was last modified. [$DateModified]
[$EditorFirstName]—Display the last editor’s first name for a content item. [$EditorFirstName]
[$EditorLastName]—Display the last editor’s last name for a content item. [$EditorLastName]
[$Image]—Displays the path for the image defined in a content item’s Metadata. When wrapped in <img src=””/> tag, the image appears. [$Image]
[$ImageIcon]—Used in non-image searches to display an image icon for the content item. For example, if the content item is HTML, the () icon appears. [$ImageIcon]
[$ImageThumbnail]—Displays the path for the image’s thumbnail defined in a content item’s Metadata. [$ImageThumbnail]
[$ItemCount]—Displays the total number of results produced by the search. [$ItemCount]
[$LinkTarget]—When added to an <a href=””> tag’s target=”” attribute, this variable reads the server control’s LinkTarget property and uses its setting. [$LinkTarget]
[$PagingCurrentEndIndex]—The end count number of the items on the page. For example, if you are displaying items 11—20 on a page, this variable represents the number 20. [$PagingCurrentEndIndex]
[$PagingCurrentStartIndex]—The numerical record of the first item on a page. For example, if you are displaying items 1 through 10 out of 50 total items on a page, this variable represents the number 1. [$PagingCurrentStartIndex]
[$QuickLink]—This property displays the Quicklink information for the content item. When wrapped in an <a href=””> tag, you can create a Hyperlink. [$QuickLink]
[$SearchDuration]—Displays the amount of time, in seconds, it has taken to execute the search. [$SearchDuration]
[$SearchSummary]—Creates an abstract for each item in the search results. [$SearchSummary]
NOTE: The Adobe IFilter, which is used to generate the abstract, is only supported in Tier 1 languages (English, French, German, and Japanese). If your Web site uses other languages, the abstract may not be legible. In such a case, you should suppress the abstract from the search results.
[$SearchText]—Displays the text for which a user is searching. This information is same as what a user entered in the search text box. [$SearchText]
[$ShortDateModified]—Displays the date the content was modified. To display the date and time a content item was modified, use [$DateModified]. [$ShortDateModified]
[$Title]—Displays the content item’s title. [$Title]

[$SearchSummary]

Gets the first 300 characters from the body content and creates an abstract.

For content items that do not get indexed, such as images, the SearchSummary uses the image’s title, summary, and metadata information.

[$ContentByteSize]

Display the size of the content item in the results list.

[$PagingCurrentEndIndex]

The numerical record of the last item on a page. For example, if you are displaying items 1 through 10 out of 50 total items on a page, this variable represents the number 10.

This variable is typically used in the following context: