MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_NextPart_01C70060.731EFEA0" This document is a Single File Web Page, also known as a Web Archive file. If you are seeing this message, your browser or editor doesn't support Web Archive files. Please download a browser that supports Web Archive, such as Microsoft Internet Explorer. ------=_NextPart_01C70060.731EFEA0 Content-Location: file:///C:/51525E52/Help.SyndicationGenerator.htm Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset="us-ascii" Syndication Generator for Windows® SharePoint® Services Help File

Syndication Generator for Windows® SharePoint® Services

Copyright © 2004-2006 BluedogLimited.com

Published November 4, 2006=

All rights reserved.

 

This is the User’s Guide for the Syndication Gen= erator for Windows® SharePoint® Services v2.0.0.12 and is designed to compliment the dropdown help available within the Syndication GeneratorR= 17;s property tool pane.

Table of Contents

Table of Contents 1<= o:p>

Overview. 2<= o:p>

Features = 2<= o:p>

User Guide. <= /span>2<= o:p>

Syndication Generator Properties 2<= o:p>

Using the property tool pane. 2<= o:p>

Locked properties 3<= o:p>

List of all properties 3<= o:p>

SmartSyndication™ - Easy syndication of a list 4<= o:p>

SmartSyndication™ mapping behavior 5<= o:p>

Turning off SmartSyndication™.. 6<= o:p>

Enclosures – the key to RSS broadcasting. 6<= o:p>

SmartSyndication™ Example - An item from a Links list 6<= o:p>

SmartSyndication™ Example - An item with an enclosure. 7<= o:p>

An Alternate View of the RSS feed. 8<= o:p>

Default Alternative View. 8<= o:p>

Accessing the Alternate View. 9<= o:p>

Viewing the Alternate View on mobile devices 9<= o:p>

Creating and applying your own stylesheets 9<= o:p>

Default stylesheet 9<= o:p>

Sample stylesheet 10<= o:p>

Aggregation service. <= /span>10<= o:p>

Operating characteristics 11<= o:p>

Aggregation service status categories 12<= o:p>

Viewing aggregation service status 12<= o:p>

Feeds which require authentication. 12<= o:p>

Step by Step Examples 13<= o:p>

How to quickly get an RSS feed up and running. 13<= o:p>

How to specify a column for either <title> or <description>. 14<= o:p>

How to setup a filter for your feed. 14<= o:p>

How to add a copyright notice to your feed using XSL 15<= o:p>

Optimizing performance. 16<= o:p>

Place the Syndication Generator on a page with few (or no other) web parts = 16<= o:p>

Place the Syndication Generator on a ghosted page. 16<= o:p>

Reduce the maximum number of items retrieved. 16<= o:p>

Security. 17<= o:p>

Localization. 17<= o:p>

References = 17<= o:p>

Acknowledgements = 17<= o:p>

 

Overview

The Syndication Generator for Windows® SharePoint&= reg; Services is web part based RSS generator.&= nbsp; In a matter of seconds, you can easily produce an RSS 2.0 feed based= off of your existing SharePoint lists.  <= /span>

 

The Syndication Generator also offers aggregation capabilities which allow you to easily capture and redistribute other RSS f= eeds along side your own feed. 

 

Once the Syndication Generator is installed, all configuration changes are made by navigating to the web part’s proper= ty tool pane.  Simplicity and eas= e of use is the name of the syndication game with the Syndication Generator.

 

Features

The Syndication Generator is feature rich and is desig= ned to provide as much operability as possible.

 

Syndication Gene= rator Properties

The Syndication Generator web part contains several configurable properties that are visible from within the property tool pane= and can also be set in the Web Part definition (.dwp) file for the web part.

 

Using the property tool pane

The Syndication Generator’s properties are group= ed into five major categories.  <= /p>

 

Property category

Description=

Channel

General feed characteristics=

Item

Describe how individual items are presented

Mapping

Map custom titles, descriptions, filters and display forms.

Alternate View

Apply XSL transforms to the rss feed

Aggregation

Retrieve rss data from other locations

 

 

The category sections can be collapsed and expanded by clicking on either the category title or the expand/collapse images. 

 

Once a category section has been expanded (as shown in= Figure 1), extensive property descriptions and help are available.  Simply click on the maximize arrow,, to view the property descriptions. 

 

Figure 1

 

If a property is required, the description will list t= he property as Re= quired (highlighted by the red arrow).

 

Locked properties

The administrator can lock properties so they cannot be changed.  Locked properties wi= ll have a small lock image placed next time the property title and the input f= ield will be disabled (see the blue arrow in the figure above).

 

List of all properties

The following tables lists all properties and their characteristics – friendly and dwp names, whether or not they are Required,= their type, and default value.

 

Display= Name

DWP Pro= perty

Require= d

Type

Default= value

 

AlternateViewContentT= ype

 

String, computed value based on AlternateViewTransform

 

Active

ChannelActive

 

Boolean

True

Aggregated RSS feeds

AggregatedFeeds

 

String, semi-colon delimited=

 

Alternate view available

AlternateViewAllowed

 

Boolean

True

Cache refresh interval (min)=

ChannelTimeToLive

 

Integer

180

Channel image

ChannelImageLink

 

String, url

 

Copyright information

ChannelCopyright

 

String

 

Custom display form mapping<= /p>

 

DisplayFormMapping

 

String, semi-colon delimited name value pairs<= o:p>

 

Description

 

ChannelDescription

Yes

String

 

Exchange primary and alternate views

AlternateViewExchanged

 

Boolean

False

Headline mode

ItemHeadlineMode

 

Boolean

False

Identifier

ChannelIdentifier

Yes

String

 

Include author or editor information

ItemIncludeAuthor

 

Boolean

False

Information link

ChannelLink

Yes

String

 

Items per feed

AggregatedItemsPerFeed

 

Integer

3

List field to item description mapping

ListToItemDescriptionMapping=

 

String, semi-colon delimited name value pairs<= o:p>

 

List field to item title mapping

ListToItemTitleMapping

 

String, semi-colon delimited name value pairs<= o:p>

 

List filter mapping

ListFilterMapping

 

String, semi-colon delimited name value pairs<= o:p>

 

Managing editor

 

ChannelManagingEditor

 

String

 

Maximum items per list

 

ChannelMaximumItemsPerList

 

Integer

10

Retrieve items in folders

ItemRetrieveRecursively

 

Boolean

False

Syndicated lists

ChannelSyndicatedLists

Yes

String, semi-colon delimited=

 

Time stamp

ItemUseModifiedTimeStamp

 

Boolean

True

Title

ChannelTitle

Yes

String

 

Xsl stylesheet

AlternateViewXsl

 

String

See Default stylesheet

 

SmartSyndication= ™ - Easy syndication of a list

The SmartSyndication™ feature allows lists to be rapidly syndicated with no additional configuration. Lists which can be automatically syndicated include:

 

 

When browsing the list catalog, lists which qualify for SmartSyndication™ are marked with “[ListTy= pe]” as shown in Figure = 2.

 

Figure 2

 

SmartSyndication™ mapping behavior<= /h4>

SmartSyndication™ automatically maps appropriate= list columns to the <title> and = = <d= escription= > elements of an RSS feed.

 

Another feature of SmartSyndication™ is the auto= matic referencing of either document or image urls wi= thin the <l= ink= > element.  Depending on the RSS reader used to consume the feed, <link= > elements may be used to retrieve the item when the user double-clicks on the item within the reader itself.

 

The table below outlines the SmartSyndication™ m= apping behavior...

 

List type

<title>

<description>

<link>

<enclosure>

Announcements

 

Title

 

Body

 

default form

 

 

Discussion Boards

Subject

Text

default form

 

Document Libraries

 

Title

 

Document name

Document url

Yes

 

Events

Title

Description

default form

 

Issues

Title

Comment

default form

 

Links

 

Url friendly name

 

Notes

Url address

 

Picture Library

Title

Description

Picture url

Yes

Tasks

Title

Description

default url

 

 

Note: To preserve the location of where the actual item exists within your site, all RSS items will have a “PermaLink” which references the actual item within the SharePoint list.

 

Turning off SmartSyndication™

If the automatic mapping does not suite your needs, yo= u can easily adjust the published content by setting any of the Mapping Propertie= s:

 

 

Note: If any of the above mappings are specified for a given li= st, SmartSyndication™ is deactivated for that list.

 

Enclosures – the key to RSS broadcasting

When a list is syndicated with the SmartSyndication= 482; feature, the Syndication Generator will add <e= nclosure= > tags for files found in Document and Picture libraries.  Enclosure tags describe the file location, mime type, and length.  Enclosure tags may be used by RSS aggregators to determine which fil= es to download to the subscriber’s machine. 

 

Enclosure tags are added for the following file types:=