Ektron Reference |
Large amounts of content can be an organizational nightmare, and it takes a far-reaching categorization model to allow content to be efficiently repurposed, searched for, and organized on a site. Ektron’s taxonomy, a one-to-many relationship model, follows natural and organic methods all the way down to the content level, enabling an intuitive organization scheme that reflects how people think.
Click the following link to see a video introduction to taxonomy in Ektron: http://documentation.ektron.com/video/taxonomy/taxonomy.html.
Ektron’s taxonomy is a content-level categorization system that uses one-to-many relationships to create a scalable organization of content. Content is categorized in the database by how it relates to multiple categories, allowing it to be accessed in multiple ways for multiple purposes. The hierarchy of the content is arranged from the general to the specific, and there may be multiple “routes” that define the content at the end of the hierarchy.
This type of categorization lets you create a navigation structure (independent of the folder structure) that matches the way different site visitors want to find what they are looking for.
For example, Arnold Schwarzenegger can be thought of as an actor, Mr. Olympia or as a California governor. Taxonomy creates a one-to-many relationship with any content about Schwarzenegger and auto-generates navigation which can support all of the approaches to accessing any content about him. Site visitors can find the content whichever way that they think about it.
Ektron’s taxonomy system plays key roles in more than just organizing content. Ektron’s URL Aliasing is able to auto-generate human readable and SEO-friendly addresses based on the taxonomic structure of the page. Because it is uBreadcrumbssing the various ways that people relate to the content to determine the alias, search engines will find it based on multiple terms as well.
A taxonomy directory control can automatically create the navigation on your Web site. When the content is tagged, it automatically shows up in the correct section of the site. The author doesn’t need to know where the content is going to show up, the taxonomy tagging will determine that. If you are managing large amounts of information, this use of taxonomy is especially powerful.
Taxonomy can also improve search functionality.
When working with content, you can place a listing of categories (a taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure.) on a Web page. When that page displays, the taxonomy’s categories appear, followed by all published items in the taxonomy.
To help site visitors find your Web site’s content via a taxonomy, your developer places a Directory server control on a Web page. It looks something like this.
See Also: Directory Server Control
There is no limit to the number of category levels you can assign to a taxonomy.
Also, a taxonomy can link to all content in a folder, so the display is based on folder structure. Alternatively, you can assign content items from various folders to a taxonomy.
To illustrate the benefits of a content-based taxonomy, assume your Web site is for a college. Several items relating to the graduate school are organized under major departments: Admissions, Academics, Faculty, Library, and so on. You can
It helps to design a taxonomy on paper before creating it in Ektron. This can let you determine relationships among the kinds of information before you try to implement the taxonomy.
As an example, here is a hierarchy of some content in the Ektron sample site. The top level item is the taxonomy. All levels below it are categories.
Next, review the site content and decide which content items and folders to assign to which taxonomy categories. Some categories may map directly to a folders. Other categories may refer to content from several folders. After you determine how content and folders will be assigned to taxonomy categories, sign on to Ektron and set up those relationships.
Prerequisite: Only administrators or users to whom the Taxonomy-Administrator role is assigned see the Content > Taxonomy option See Also: Defining Roles
See Also: Creating a Taxonomy in a Multi-Language Environment
To display the taxonomy image, use Ektron’s API.site root/developer/taxonomy/taxonomy_image.aspx
.
Without a Category Link, if a site visitor clicks a taxonomy category, the results appear on the same page.
Enter a path to a destination page relative to your site root folder. For example, aboutus.aspx.
When a site visitor clicks this taxonomy/category, he is directed to http://your-URL/siteroot/aboutus.aspx
.
You could also direct the user to a content ID, such as aboutus.aspx?id=62
.
For example
If you add content ID 406 to the English 'Press Releases' taxonomy, Spanish content ID 406 is added to the Spanish 'Press Releases' taxonomy.
Conversely, if you delete content ID 406 from the Spanish 'Press Releases' taxonomy, content ID 406 is removed from the English 'Press Releases' taxonomy.
As another example
If you add content ID 407 to the English 'Press Releases' taxonomy, the Spanish 'Press Releases' taxonomy is not affected, since content ID 407 does not exist in Spanish.
Conversely, if you delete content ID 407 from the English 'Press Releases' taxonomy, the Spanish 'Press Releases' taxonomy is not affected, since content ID 407 does not exist in Spanish.
See Also: Working with Taxonomies in a Multi-Language System
Uncheck this box to block categories from appearing as part of this taxonomy. For example, you have not finished creating content for a category.
If you uncheck this box, this node and its child nodes are indicated by a gray background in the Workarea (see image below).
The gray background also appears when users work with this taxonomy/category on the Edit Content screen’s Category tab.
This setting does not prevent you from assigning taxonomies/categories in the Workarea.
NOTE: By default, a new taxonomy’s configuration is content. Also, this field only appears for a taxonomy. It does not appear for categories, which are below the taxonomy.
Assigning a Taxonomy Configuration
Custom Properties tab—Let you extend the taxonomy's functionality by creating custom fields to capture additional information.See Also: Assigning Custom Properties to a Taxonomy
NOTE: You can also assign a Taxonomy to content using the Edit Content in Folder screen’s Category tab.
Taxonomy categories are designed to help site visitors find content. To provide a taxonomy-based search, your developer places a Directory server control on a Web page.
By default, when a user clicks a hyperlink on such a Web page, it uses the template assigned to the linked content (as illustrated below). See Also: Working with Templates
To display the linked content in a different template:
NOTE: Any category below the root level can inherit its parent’s taxonomy template. Use the Inherit checkbox to do this.
You may need a developer’s help with the rest of these steps.
siteroot/workarea/template/taxonomy/taxonomy.ekml
.If the property displays an EkMLEktron Markup Language file, open that file. Its path may be listed in the property. If the .ekml file’s path is blank, it is workarea/template/taxonomy/
.
[$HyperLink]<br/>[$Teaser]
<a href="[$TemplateQuickLink]">[$Title]</a><br/>[$Teaser]
The content selected from this Directory server control will now use the template assigned to the taxonomy/category.
There are 3 taxonomy configurations (that is, types).
Content—Associate this taxonomy with content. When this configuration is selected
User—Associate this taxonomy with Ektron or membership users. You select users for this taxonomy on the Assign Items to Taxonomy screen.
Group—This taxonomy‘s categories can be assigned to community groups from the Category tab of the Edit Community Group screen.
If you do not check this box, users can only view taxonomy/category assignments on the Category tab.
Whether or not this box is checked, you can assign taxonomy categories to community groups via the View All Categories of Taxonomy screen.
When editing content, if you choose the Category tab, you see Taxonomy categories that may be applied to this content. The number to the right of any taxonomy/category is the total items assigned to it.
The number includes individual items plus all items in any assigned folders. So, for example, if one content item and one folder are assigned to a category, and the folder has 5 items, the category’s number is six.
The table below summarizes information about assigning a taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure./category to content, users or community groups.
To assign a taxonomy category to |
Available methods |
Prerequisites |
For more information, see |
Content NOTE: Regardless of the method you use to assign a taxonomy to content, the result is the same. |
from the Edit Content in Folder screen |
|
|
from the Content Tab > Taxonomy screen |
Must be member of administrators group or Taxonomy administrator |
||
Ektron Users |
from the Assign Item(s) to Taxonomy screen
|
Taxonomy’s Configuration > User check box is checked | |
Membership Users |
|
Taxonomy’s Configuration > User check box is checked | Assigning a Taxonomy/Category to a Membership User |
Community Group |
|
Taxonomy’s Configuration > Group check box is checked | Assigning a Taxonomy/Category to a Community Group |
Ektron lets content authors assign a taxonomy category to content. They do this by navigating to a content block, clicking its Category tab, opening a taxonomy, and checking the correct level.
However, all taxonomies may not be available to every content item. Use a folder property's Taxonomy tab to determine which taxonomies may be assigned to content in a folder.
For example, a folder’s content consists of restaurants, and you want to restrict users to the Restaurant taxonomy—users cannot assign other categories to that folder’s content.
To make a taxonomy available to a folder:
From now on, users editing content in this folder can assign categories from the selected taxonomies.
Unlike many folder properties, Taxonomy settings are not inherited from a parent folder by default. But you can cause them to be inherited if that is appropriate. If you are not working on the root folder and the appropriate set of Taxonomies is applied to a folder’s parent folder, go to the folder’s properties screen and check the Inherit parent configuration checkbox.
In folder properties, you can require all content to be assigned at least one taxonomy category. If you do, when content in that folder is saved, Ektron verifies that at least one taxonomy category is assigned. If none is found, the user must assign a taxonomy category before saving the content.
To set a folder-level requirement for content to be assigned a taxonomy category:
Prerequisites:
or
Search for the user or community group to assign to the taxonomy or category.
NOTE: Folder content appears below the folder list (see below). Also, only content in the selected language appears.
Prerequisites:
NOTE: If you assign a folder, a relationship is established between the folder’s content and the taxonomy category. The folder is only a convenience for creating this relationship.
Because there is no relationship between a folder and a taxonomy category, if you delete the folder from the taxonomy, the taxonomy category is still applied to the folder's content.
You can assign a folder to a taxonomy, thereby displaying published content in the folder when the page is viewed. As content is added to or deleted from the folder, the taxonomy on the Web page changes dynamically.
For example, you have a “Top News Stories” folder, in which newer news items are frequently added, and old ones are deleted. The taxonomy only shows the latest news items. The updating of the content is handled by the taxonomy automatically.
WARNING! If you move content from a folder to which a taxonomy category is assigned, the category remains with the content in the new folder. If the new folder also has a taxonomy category assigned, the new category is also applied to the moved content.
To assign a folder to a taxonomy category:
WARNING! Only checked folders are assigned to the taxonomy/category. Checking a parent folder has no effect on its child folders.
Prerequisite: You can perform this procedure only if a taxonomy’s Configuration > Group check box is checked. See Also: Assigning a Taxonomy Configuration
You can assign a taxonomy/category to a community group from either a Community Web site or the Workarea.
Members of the administrators group or taxonomy administrators can assign taxonomy categories to community groups via the View All Categories of Taxonomy screen. See Also: Defining Roles
You can assign a taxonomy/category to a membership user from a Community Web site or the Workarea.
Prerequisite: The taxonomy’s Configuration > User box is checked.
Prerequisite: Members of the administrators group or taxonomy administrators can assign taxonomy categories to community group Members via the View All Categories of Taxonomy screen. See Also: Defining Roles
Prerequisite: Members of the administrators group or taxonomy administrators can assign taxonomy categories to Ektron users via the View All Categories of Taxonomy screen. See Also: Defining Roles
The View All Taxonomies screen displays all taxonomiesa content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure. currently in Ektron. The language pull down lets you filter the list by a language. To work with any taxonomy, select it. When you do, it appears within the View All Categories of Taxonomy screen.
The View All Categories of Taxonomy screen exposes all categories in a selected taxonomy. Use this screen to perform tasks on a taxonomy or one of its categories, such as adding new categories, assigning content to a category, and changing the order of items.
To access the View All Categories of Taxonomy screen:
Prerequisite: Only administrators or users assigend to the Taxonomy Administrator role see the Content > Taxonomies option. See Also: Defining Roles
For a description of these fields, see Taxonomy Field Descriptions
You can move any taxonomy category to any other taxonomy or category. There are 2 ways to do this.
There are 2 ways to delete a taxonomy or category.
NOTE: After you delete a taxonomy, it can no longer be assigned to content and folders. Further, existing links to content (via the Category tab) are deleted. And, if a taxonomy was assigned to a folder (via the Folder Properties screen), it is no longer assigned.
See Also: Deleting a Taxonomy in a Multi-Language Environment
NOTE: Only administrators or users to whom the Taxonomy Administrator role has been assigned see the Content > Taxonomies option. See Also: Defining Roles
NOTE: The delete button does not appear if the language selector is set to All.
Follow these steps to add a category to a taxonomy, or to add a subcategory to a category.
Prerequisite: Only administrators or users to whom the Taxonomy Administrator role has been assigned see the Content > Taxonomies option.See Also: Defining Roles
Prerequisite: Only administrators or users to whom the Taxonomy Administrator role has been assigned see the Content > Taxonomies option.See Also: Defining Roles
Prerequisite: Only administrators or users to whom the Taxonomy Administrator role has been assigned see the Content > Taxonomies option.See Also: Defining Roles
If you assign a content folder to a taxonomy category, the internal relationship is between the folder’s content and a taxonomy category. A folder is merely a convenience for creating this relationship. There is no data connection between a folder and a taxonomy category.
Therefore, if you delete a content folder from a taxonomy category, all content in that folder remains assigned to it. To remove the folder’s content from the category, see Removing Content from a Taxonomy/Category.
However, after deleting a content folder, the connection between the folder and taxonomy category is broken. So, content subsequently added to the folder is not assigned to the taxonomy.
NOTE: To remove all folders, check the box in the title bar.
Prerequisite: Only administrators or users to whom the Taxonomy Administrator role has been assigned see the Content > Taxonomies option.See Also: Defining Roles
You can reorder (that is, change the sequence of) the categories below a taxonomy or one of its categories. Reordered subcategories appear only within the Ektron Workarea.
To reorder the categories assigned to a taxonomy or category:
See Also: Adding a Category to a Taxonomy/Category
You can reorder (that is, change the sequence of) content within a category. Reordered content appears within the Ektron Workarea and can appear on your Web site of the Directory server control’s ItemSortOrder
property is set to taxonomy_item_display_order
.
To reorder the content assigned to a category:
Prerequisite: Only administrators or users to whom the Taxonomy Administrator role has been assigned see the Content > Taxonomies option.See Also: Defining Roles
You can export any taxonomy as an xml file. Then, you can reuse it or send it to someone else, who would import it to bring a copy of it onto their computer.
You can use the Export/Import feature like a “save as” feature. For example, you want to create a taxonomy that is similar to an existing one but has a few differences. The easiest way to do this is to export an existing one, import it under a new name, and edit it.
<ArrayOfTaxonomyData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <TaxonomyData> <TaxonomyId>959</TaxonomyId> <TaxonomyName>Bob Taxonomy</TaxonomyName> <TaxonomyLanguage>1033</TaxonomyLanguage> <TaxonomyLanguageName>English (U.S.)</TaxonomyLanguageName> <TaxonomyDescription>Sample</TaxonomyDescription> <Taxonomy> <TaxonomyData> <TaxonomyId>960</TaxonomyId> <TaxonomyName>Subnode</TaxonomyName> <TaxonomyLanguage>1033</TaxonomyLanguage> <TaxonomyLanguageName>English (U.S.)</TaxonomyLanguageName> <TaxonomyDescription /> <Taxonomy /> </TaxonomyData> </Taxonomy> </TaxonomyData> </ArrayOfTaxonomyData>
Exporting a taxonomy means saving it as an .xml file on your computer or network drive. To export a taxonomy:
NOTE: Alternatively, you can enter or paste the xml into the XML box.
NOTE: If you assign a name that is already given to a taxonomy, Ektron appends a number to the title, beginning with 1.
Custom properties let you extend the functionality of taxonomiesa content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure. by creating custom fields to capture additional information. Custom properties act like metadata for taxonomies and categories.
For example, your organization manages a nationwide chain of retail stores. You create a Sales Region taxonomy, where each category represents a different geographic region. Sample categories are northeast, southeast, midwest (as shown below).
You could create a custom taxonomy property named Regional Manager
and use that to create a list of regional managers.
Next, access each region, click the Custom Properties tab, and apply a manager to the region.
Prerequisite: Only members of the Administrator User Group or those assigned to the taxonomy administrator role can work with custom taxonomy properties.
To create a custom taxonomy property:
Name—Enter the custom property name. The name identifies the custom property on the Edit Taxonomy screen's Custom Properties tab.
Editable—Check this box to allow the user who is applying this custom property to choose a value or edit the default value.
Uncheck the box if the user cannot choose or edit the value. In this case, he is only applying the property. If a property is not editable and has several values (type string: select from list
or boolean
), only the first or selected value is applied to the property.
Example of an Editable Custom Property
Assume you manage an auto parts stores and want a custom taxonomy property to indicate if a car can be repaired at a facility. You create a property named Repair Services Available, and make it boolean and editable. Then, the person applying that custom property to a taxonomy category can choose Yes or No to indicate if repair services are available.
Enabled—Check this box if this property can be applied to taxonomy categories. If you uncheck this box, this property does not appear on the Edit Taxonomy screen's Custom Properties tab.
Data Type—
Display Type/Value—If the Data Type is String, Numeric or DateTime, you have 2 choices.
NOTE: If the Data Type is boolean, select either Yes or No.
In the top field, insert a value then click Add. When you do, the value moves to the lower field. Continue until all values are entered.
If you want to edit the order of the values, use the up/down arrows (circled above).
NOTE: If Editable is checked and you insert several values, the user applying the custom property can choose the value. If Editable is not checked, the first value is applied to the custom property.
Follow these steps to edit a custom taxonomy property.
For descriptions of these fields, see Taxonomy .
NOTE: You cannot edit the ID, Language, CMS Object Type, Data Type, or Display Type fields. If you need to change these fields, delete the custom property and create a new one.
If you delete a custom taxonomy property
Follow these steps to delete a custom taxonomy property.
From the Edit Custom Property screen, you can change the order in which the values appear on the Custom Properties tab.
Follow these steps to set the order of values in a custom taxonomy property.
Like most Ektron objects, custom taxonomy properties have a language attribute. Each taxonomy also has a language. You can only apply custom properties to a taxonomy if their languages match.
When creating a custom property, you select its language. See Also: Creating Custom Taxonomy Properties This section describes how to save a custom taxonomy property in a different language. The new version uses the same ID number as the original language version. You can change the following fields from the original.
For descriptions of these fields, see Taxonomy .
After you create the new language version, it is no longer linked to the original. For example, if you edit or delete the original language version, that does not affect the new version.
Follow these steps explain to create a custom taxonomy property in another language.
IMPORTANT: The Taxonomy Search described in this section uses the deprecated Web Search server control. The search does not use the Templated Search server controls, which replaced the Web Search server control in Release 8.5.
When your Web developer places a Directory server control on a Web page, he can use the Enable Search property to include a Search box with the taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure. display (circled below). See Also: EnableSearch (Boolean)Set to True if you want a search box (shown below) to appear above this taxonomy display. A site visitor can use the search to find content within a taxonomy/category that includes terms of interest. To suppress the search box, set to False.
The box helps site visitors find content by returning only items that include a search phrase and are assigned to a selected category.
When placing a Directory server control, your Web developer defines a Taxonomy ID number. The ID determines the top level of the taxonomy that appears below the Search box, to the right of Breadcrumb. Below that are categories directly below that Taxonomy.
To use the search, a site visitor enters a search term and clicks the Directory radio button (above the Search box). The screen may return links in 2 areas below Breadcrumb.
As illustrated below, within the Editor category, one category (eWebEditPro) includes content with the word library. And, one content block (The best Microsoft Word content processing) includes library.
This section explains how taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure. is supported in a multi-language environment.
When you create a new taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure., you select a language. At that point, a version of that taxonomy is created for each enabled language.
For example, you create a taxonomy in English, and French and Spanish are also enabled (in the Settings > Language Settings screen). Ektron now has versions of that taxonomy in English, French, and Spanish. The ID of each taxonomy is the same, but the language ID is different. You do not need to use all language versions. And, if you add categories to one language taxonomy, those categories are automatically added to the other language versions of that taxonomy.
The Synchronize Languages field on the taxonomy properties screen determines if all language versions are linked. If that field is checked and you assign content to the English taxonomy, content with the same id in the other languages is assigned to the French and Spanish versions.
If you enable a new Workarea language, a version of every taxonomy is automatically created in that language.
If you disable a language, all of its taxonomies are deleted.
See Also: Working with Multi-Language Content
Initially, all related-language versions of a taxonomy inherit properties from the original language version. For example, if you create a taxonomy in English and French is also enabled, the French Taxonomy description is the same as the English one, as are the taxonomy image, taxonomy template, value of Display? checkbox, and so on.
However, after the initial creation of the multiple-language versions, changes to taxonomy properties affect the current language only -- they do not affect the related-language versions.
Ektron supports multiple language versions of content. When applying content to a taxonomy category, you can only apply content whose language matches the taxonomy language. If that content exists in other languages, the related-language version is also applied to the related-language taxonomy if the Synchronize Languages field is checked on the Taxonomy Properties screen.
So, to continue the above example, assume there is a taxonomy in English and you apply content item ID=30, Sample Content Block to one of its categories. If that taxonomy exists in German, the content block titled Ektron Server Kontrollen (also ID=30) is applied to the corresponding category in the related German taxonomy.
If there is no corresponding German content, nothing is applied to the German taxonomy category.
If there are several language-related versions of a taxonomy and you select one of them then edit a folder’s taxonomy properties, content in the related language inherits the taxonomy folder properties.
For example, assume I select English, then edit a folder’s taxonomy properties and apply taxonomy categories. If I later edit French content in that folder, the corresponding French taxonomy’s categories are available to be assigned via the Category tab.
Further, the value of the At least one category is Required check box is also inherited. This means that if a category must be applied to English content, it is also required for French content.
When you assign a folder to a taxonomy category, you indicate that all folder content is assigned to that node. Ektron folders are language-neutral, so the folder is also applied to the corresponding taxonomy category in every language. However, only folder content that matches the taxonomy’s language is assigned to the taxonomy category.
So, for example, a folder has 3 content blocks.
Language |
Content in folder in this language |
English |
|
German |
|
If you apply that folder to a taxonomy, the English version of the taxonomy has 3 content blocks assigned, but the German version only gets one content block (ID 100).
If content is later added to the folder, new English content is assigned to the English taxonomy, and new German content is assigned to the German taxonomy.
NOTE: If you apply a folder to a taxonomy, numbers on the View Taxonomy screen indicate how many content items are applied to it. Unless you have the same number of content items in each language, this number is different for every language.
If you remove a folder from its assignment to a taxonomy category, the content in that folder is still applied. So, you must also remove all of its content, as described in Removing Content from a Multi-Language Taxonomy.
If you have a community or social networking Web site, you can assign users and community groups to a taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure.. This allows site visitors to search for users and groups by category.
To enable a taxonomy-based search of users and community groups, a developer uses the following server controls on your site.
See Also:
The Directory server control lets you customize the behavior of the taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure. feature. You place this control on any Web form to display a taxonomy. For more information about the site visitor experience with Taxonomy, see Taxonomy .
NOTE: To display a taxonomy on a PageBuilder page, use the Taxonomy Summary—Displays content assigned to a taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure. category. See Also: Taxonomy , Directory Server Control widget.
To minimize taxonomy’s impact on the performance of your production server, follow these guidelines.
TaxonomyDepth
property above 1. Changing this value dramatically slows down your production server’s performance. However, you can increase depth on your staging server for testing purposes.The following are Ektron-specific server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. properties. You can find information about native .NET properties such as font, height, width and border style in Visual Studio® help.
Define the Ektron folder ID where content is stored when an item is added to the taxonomy via the Add Asset link or the Add Content link. To enable adding content items via the Directory server control, you must use an EkML file with the [$AddAsset]
and [$AddArticle]
variables. See Also: taxonomy.ekml
Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.
The number of seconds that the server control’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.
WARNING! If the EnablePaging
property is set to True, the CacheInterval
property is disabled.
If desired, enter a relative or absolute path to an Xslt that determines the display of the page.
WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.
By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, Fill is automatically called during the Page Render event. You might do this if you need to set or change a property on the control in code-behind and have it render with your changes shown.
Gets or sets the QueryString parameter to read a content ID dynamically.
Set to true to enable Ajax searches. When enabled, the MaxResults
property determines the maximum number of results per page.
This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of items while controlling the amount of screen space. The MaxNumber property limits the number of items displayed. If you set this property to True, and the number of items exceeds MaxNumber, navigation aids appear below the last item, allowing the visitor to go to the next screen. See example below.
So, for example, if a taxonomy has 9 items and MaxResults
is set to 3, the screen displays only the first 3 items. When the site visitor clicks [Next], he sees items 4, 5 and 6, and so on.
WARNING! If the EnablePaging
property is set to True, the CacheInterval
property is disabled.
Set to True if you want a search box (shown below) to appear above this taxonomy display. A site visitor can use the search to find content within a taxonomy/category that includes terms of interest. To suppress the search box, set to False.
Set this property to True if you want the following information for each content in the list. Returns Content View Count, Content Rating, Content Rating Average. Create your own XSLT styles to display this data.
WARNING! This property only provides reliable data when the Business Analytics Feature is on. Business Analytics.
Hides or displays the output of the control in design time and run time.
Choose whether to display icons next to the taxonomy’s links.
This property only works when ecmSummary or ecmTeaser are used in the DisplayXslt
property. When the [$ImageIcon]
variable is used in an EkML file and that file is assigned to the MarkupLanguage
property, this property acts as True.
Set a language for viewing content; shows results in design-time (in Visual Studio) and at run-time (in a browser).
Determines the type of window that appears when you click a link in the server control.
Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml
. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Output with Ektron Markup Language
See Also: taxonomy.ekml
WARNING! If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored. If the EkML file contains the [$ImageIcon]
variable, the IncludeIcons
property acts as True.
Enter the maximum number of items to appear in the initial display of this server control. If you set this value to zero (0), the maximum is 50. To let site visitors view more than the maximum but limit the amount of space being occupied, enter the maximum number of results per page here. Then, set the EnablePaging
property to True. If you do and more than the number of MaxResults
are available, navigation aids appear below the last item to help the site visitor view additional items. See example below.
Specify the sort order of results. Choices are:
You can specify the direction of the items with the SortDirection
property.
Set to true
if this control needs to preserve the URL parameters on the page. For example, if a server control displays a list of content items, the URL parameter passes to the control the template names and id
values that the template expects. Set to false
if the server control does not need to pass the URL parameters to the server control. The default value is false
.
Set to True to include child folders of the parent folder.
When set to True, a check box appears in the Show All check box.
Indicates if the number of taxonomy items appears next to each category when displayed in the Web site. (See example below.) Default value is false.
Select the direction of the ItemSortOrder
property. Choose Ascending or Descending.
Enter the number of columns in which this taxonomy/category will appear on the page.
Enter the number of taxonomy levels to retrieve below each taxonomy/category if you are accessing a taxonomy’s XML using code-behind. For example, if the taxonomy is Businesses > Restaurants > Pizza, and you set Taxonomy Depth to 2, only Business and Restaurants are available in code-behind. This setting has no effect on the display generated by the Directory server control, which always displays only one level below the current. To retrieve all categories for a taxonomy recursively, enter -1. The default value is 1.
IMPORTANT: For a live site, leave this value at 1. Increasing this value can slow down your live Web server. However, for testing on a staging server, you can increase the depth.
Enter the ID number of the taxonomy or category to appear in this server control. If you don’t know the number, click the button and navigate to the taxonomy or category.
Enter the number of columns in which this taxonomy/category items (articles) will appear on the page.
Lets a developer specify a server control’s tag.
Ektron Documentation at www.ektron.com
|
Ektron 8.5
|
© 2012 Ektron, Inc., 1–866–4–EKTRON |