Ektron CMS400.Net Reference
The RSS summary function is used to create an XML list of content summaries formatted for RSS Syndication.
Shown here is the format of the RSS summary function:
<% ecmRssSummary |
“Folder”, "OrderBy, Asc/Desc", |
%> |
A list and description of the attributes are shown in this table:
Attribute |
Description |
Options |
Folder |
This is the folder the summary information will come from. |
Any folder |
Recursive |
Allow the tag to get summary info from the child folders. |
0 = Not Recursive 1 = Recursive |
OrderBy, ASC/DESC |
Order the hyperlinks by: |
“Title” “DateModified” “DateCreated” “Startdate” “AuthorFname” “AuthorLname” |
Order the hyperlinks in ascending or descending order. |
“Title,asc” “Title,desc” |
|
MaxNumber |
Maximum number of summaries returned. |
0 = Unlimited |
Shown below is an example of the ecmRssSummary function in an ASP Web page.
<TR> <TD> <% ecmRssSummary "\CMS400Developer\", 0, "Title,asc", 0 %> </TD> </TR> |
The previous example has the following properties:
Displays summaries from the \CMS400Developer\ folder.
Not recursive.
The results will be displayed in ascending order by title.
Unlimited results will be shown.
Here is how an RSS summary appears when viewed without an RSS reader on a web page.
<?xml version=”1.0” ?> - <rss xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0"> - <channel> <title>example listsummary</title> <link>http://localhost/CMS400Developer/developer/ListSummary/RSS.aspx?show=true</link> <description /> - <item> <title>eWebEditPro+XML V4.2 supports the vision of create content once, reuse many times</title> <link>http://192.168.0.82/CMS400Developer/Developer/ListSummary/pr.aspx?id=290</link> - <description> - <![CDATA[ <p>Ektrons XML Authoring Tool Makes it Easier to Create Structured, Validated Content to Support an Organizations Information and Content Management Strategies</p> ]]> </description> <author>Application Administrator</author> <pubDate>3/7/2006 2:00:46 PM</pubDate> </item> - <item> <title>Ektron Offers a Visual Development Environment for Rapid CMS Integration and Deployment</title> <link>http://192.168.0.82/CMS400Developer/Developer/ListSummary/pr.aspx?id=282</link> - <description> - <![CDATA[<p>Ektron leverages strong capabilities of Visual Studio to give developers a truly visual environment for integrating CMS components into Web templates</p> ]]> </description> <author>Application Administrator</author> <pubDate>3/7/2006 2:02:19 PM</pubDate> </item> - <item> <title>Ektron Announces Winner of All-Stars Customer Competition</title> <link>http://192.168.0.82/CMS400Developer/Developer/ListSummary/pr.aspx?id=292</link> - <description> - <![CDATA[ <p><em>-- All-Stars competition identifies the most innovative and effective implementations of Ektrons Web solutions and tools --&Lt.;/em></p> ]]> </description> <author>Application Administrator</author> <pubDate>3/6/2006 10:51:52 AM</pubDate> </item> </channel> </rss> |
Listed below are all the different attributes and descriptions about them.
In this attribute, you will need to specify which content folder you will want to get all the summaries from. There are two options for this attribute:
Value |
Description |
““ |
By leaving the value blank, all the summaries from the root content folder will be displayed. |
“\Folder Path |
You can specify a specific folder to display the summaries from by inserting the folder path |
When you setup the search to be recursive, you are allowing the search to search all the subfolders associated with the starting folder you had specified. You have two options for this attribute:
Value |
Description |
1 |
Recursive - summaries in the starting folder’s subfolders will also be displayed. |
0 |
Non-recursive - only summaries in the starting folder will be displayed. |
This attribute will sort the summary results by different options. There are five different ways to sort the summaries:
Value |
Summaries sorted by |
Title |
title |
DateModified |
date modified |
Date Created |
date created |
Startdate |
The Start Date assigned to the content block when created. |
AuthorFname |
author’s first names |
AuthorLname |
author’s last name |
This attribute is an addition to the previous OrderBy attribute. By default, the list of the summaries are descending, meaning they will follow the path of A-B-C, or 1-2-3. When set to ascending, they will order by Z-Y-X or 3-2-1.You will have the option to re arrange these to display either in ascending or descending order.
To do this, add the following to the OrderBy attribute:
Value |
Description |
asc, 1 |
This will order the Summaries in an ascending order |
desc, 0 |
This will order the Summaries in a descending order. This is the default setting. |
By using the ascending/descending option, you will have the option to set the order of content blocks from most recent to oldest, or vice versa. As well as ordering the list by the user’s first names or last names in ascending or descending order.
This attribute determines how many summaries appear on a page. Enter the number of summaries to be displayed. To display all summaries, enter 0 (zero) and you will display unlimited results.