Argotic Wiki & Documentation Rss Feed

New Comment on "Format agnostic consumption of syndication feeds"

stopthatastronaut — Mon, 22 Feb 2010 13:05:59 GMT

No property for link? deliberate decision due to RSS having single links and Atom supporting multiple?

New Comment on "Making remote procedure calls using the XML-RPC client"

jkergosi — Fri, 29 May 2009 15:37:55 GMT

What is this line for? client.Host = new Uri("http://bob.example.net/xmlrpcserver"); Are there programming considerations beyond pointing to the correct source and target post URIs to consider? Thanks, Jason

Updated Wiki: Home

Oppositional — Sat, 12 Jul 2008 18:11:25 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Description
A powerful and extensible .NET web content syndication framework for RSS, Atom, OPML, APML, BlogML, RSD and more. The Argotic Syndication Framework is a Microsoft .NET class library framework that enables developers to easily consume and/or generate syndicated content from within their own applications. The framework makes the reading and writing syndicated content in common formats such as RSS, Atom, OPML, APML, BlogML, and RSD very easy while still remaining extensible enough to support common/custom extensions to the syndication publishing formats. The framework includes out-of-the-box implementations of the most commonly used syndication extensions, network clients for sending and receiving peer-to-peer notification protocol messages; as well as HTTP handlers, modules, services and controls that provide rich syndication functionality to ASP.NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Argotic In Action

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

The Argotic framework would not be where it is today without all of the feedback and support from its end-users. We openly accept anyone who wants to become a contributor on this project, and encourage people to join in a variety of roles. Whether you want to write code, become a tester, or just create documentation or code examples we would be happy to have you. If you are interested in joining, please contact the project coordinator using this form.

Do You Grok Argotic? Display our network badges!

Updated Wiki: Overview of syndication extensions natively supported by the framework

Oppositional — Wed, 09 Jul 2008 23:21:44 GMT

Overview of syndication extensions natively supported by the framework

Syndication formats such as RSS or Atom are extended through the use of XML namespaces. Each extension to a syndication format involves a unique XML namespace that qualifies the elements and attributes being added to the syndication format. The framework will by default automatically retrieve the extensions that have been applied to the syndication format entities based on the declared XML namespaces.

While the framework natively supports the most common syndication extensions in use today, you may optionally create your own custom syndication extensions using the syndication resource extensibility model. All natively supported syndication extensions exist in the Argotic.Extensions assembly under the Argotic.Extensions.Core namespace, and are listed below by the name of the class that implements the syndication extension.

Syndication Extensions Implemented in the Framework

BasicGeocodingSyndicationExtension

Purpose: Extends syndication specifications to provide a means of representing latitude, longitude and other information about spatially-located things.
XML Namespace: http://www.w3.org/2003/01/geo/wgs84pos#_
XML Prefix: geo
Specification: http://www.w3.org/2003/01/geo/

BlogChannelSyndicationExtension

Purpose: Extends syndication specifications to provide meta-data common to weblogs.
XML Namespace: http://backend.userland.com/blogChannelModule
XML Prefix: blogChannel
Specification: http://backend.userland.com/blogChannelModule

CreativeCommonsSyndicationExtension

Purpose: Extends syndication specifications to provide a means of specifying which Creative Commons licenses are applicable to published content.
XML Namespace: http://backend.userland.com/creativeCommonsRssModule
XML Prefix: creativeCommons
Specification: http://backend.userland.com/creativeCommonsRssModule

DublinCoreElementSetSyndicationExtension

Purpose: Extends syndication specifications to provide a meta-data element resource description vocabulary.
XML Namespace: http://purl.org/dc/elements/1.1/
XML Prefix: dc
Specification: http://dublincore.org/documents/dces/

DublinCoreMetadataTermsSyndicationExtension

Purpose: Extends syndication specifications to provide a meta-data term resource description vocabulary.
XML Namespace: http://purl.org/dc/terms/
XML Prefix: dcterms
Specification: http://dublincore.org/documents/dcmi-terms/

FeedHistorySyndicationExtension

Purpose: Extends syndication specifications to provide a means of publishing of entries across one or more feed documents.
XML Namespace: http://purl.org/syndication/history/1.0
XML Prefix: fh
Specification: http://www.ietf.org/rfc/rfc5005.txt

FeedRankSyndicationExtension

Purpose: Extends syndication specifications to provide a means feed publishers to convey one or more numeric rankings for entries contained within feeds, each of which can be used, independently or in conjunction with the others, to establish a sorting order.
XML Namespace: http://purl.org/atompub/rank/1.0
XML Prefix: re
Specification: http://xml.coverpages.org/draft-snell-atompub-feed-index-10.txt

FeedSynchronizationSyndicationExtension

Purpose: Extends syndication specifications to enable loosely-cooperating applications to use feeds as the basis for item sharing; the bi-directional, asynchronous synchronization of new and changed items amongst two or more cross-subscribed feeds.
XML Namespace: http://feedsync.org/2007/feedsync
XML Prefix: sx
Specification: http://dev.live.com/feedsync/spec/

ITunesSyndicationExtension

Purpose: Extends syndication specifications to provide a means of describing iTunes podcasting information.
XML Namespace: http://www.itunes.com/dtds/podcast-1.0.dtd
XML Prefix: itunes
Specification: http://www.apple.com/itunes/store/podcaststechspecs.html#rss

LiveJournalSyndicationExtension

Purpose: Extends syndication specifications to provide LiveJournal specific meta-data.
XML Namespace: http://livejournal.org/rss/lj/2.0/
XML Prefix: lj
Specification: http://neugierig.org/drop/lj/rss/

PheedSyndicationExtension

Purpose: Extends syndication specifications to provide a means of describing a collection of photographs as both thumbnail and full size images.
XML Namespace: http://www.pheed.com/pheed/
XML Prefix: photo
Specification: http://www.pheed.com/pheed/

PingbackSyndicationExtension

Purpose: Extends syndication specifications to provide a means for publishers to request notification when an entity links to their content.
XML Namespace: http://madskills.com/public/xml/rss/module/pingback/
XML Prefix: pingback
Specification: http://madskills.com/public/xml/rss/module/pingback/

SimpleListSyndicationExtension

Purpose: Extends syndication specifications to provide a means of exposing ordered lists of items easier and more accessible to users.
XML Namespace: http://www.microsoft.com/schemas/rss/core/2005
XML Prefix: cf
Specification: http://msdn2.microsoft.com/en-us/xml/bb190612.aspx

SiteSummaryContentSyndicationExtension

Purpose: Extends syndication specifications to provide a means of describing content, including its format and encoding.
XML Namespace: http://purl.org/rss/1.0/modules/content/
XML Prefix: content
Specification: http://web.resource.org/rss/1.0/modules/content/

SiteSummarySlashSyndicationExtension

Purpose: Extends syndication specifications to provide a means of describing Slash-based site meta-data.
XML Namespace: http://purl.org/rss/1.0/modules/slash/
XML Prefix: slash
Specification: http://web.resource.org/rss/1.0/modules/slash/

SiteSummaryUpdateSyndicationExtension

Purpose: Extends syndication specifications to provide syndication hints to aggregators and other entities regarding how often a feed is updated.
XML Namespace: http://purl.org/rss/1.0/modules/syndication/
XML Prefix: sy
Specification: http://web.resource.org/rss/1.0/modules/syndication/

TrackbackSyndicationExtension

Purpose: Extends syndication specifications to provide a means of communicating where to send Trackback peer-to-peer notification pings.
XML Namespace: http://madskills.com/public/xml/rss/module/trackback/
XML Prefix: trackback
Specification: http://madskills.com/public/xml/rss/module/trackback/

WellFormedWebCommentsSyndicationExtension

Purpose: Extends syndication specifications to provide a means exposing comments made against feed content.
XML Namespace: http://wellformedweb.org/CommentAPI/
XML Prefix: wfw
Specification: http://wellformedweb.org/news/wfw_namespace_elements/

YahooMediaSyndicationExtension

Purpose: Extends syndication specifications to provide a means of supplementing the enclosure capabilities of feeds.
XML Namespace: http://search.yahoo.com/mrss/
XML Prefix: media
Specification: http://search.yahoo.com/mrss

Updated Wiki: Home

Oppositional — Sun, 06 Jul 2008 21:48:36 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Argotic In Action

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

Do You Grok Argotic? Display our network badges!

Updated Wiki: Home

Oppositional — Sun, 06 Jul 2008 21:47:39 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Argotic In Action

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

Do You Grok Argotic? Display our network badges!

Updated Wiki: Home

Oppositional — Fri, 27 Jun 2008 15:20:37 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Argotic In Action

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

Do You Grok Argotic? Display our network badges!

UPDATED WIKI: Home

Oppositional — Thu, 10 Apr 2008 23:36:20 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Description
The Argotic Syndication Framework is a Microsoft .NET class library framework that enables developers to easily consume and/or generate syndicated content from within their own applications. The framework makes the reading and writing syndicated content in common formats such as RSS, Atom, OPML, APML, BlogML, and RSD very easy while still remaining extensible enough to support common/custom extensions to the syndication publishing formats. The framework includes out-of-the-box implementations of the most commonly used syndication extensions, network clients for sending and receiving peer-to-peer notification protocol messages; as well as HTTP handlers, modules, services and controls that provide rich syndication functionality to ASP.NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Argotic In Action

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

Do You Grok Argotic? Display our network badges!

UPDATED WIKI: Managing provider based syndicated content

Oppositional — Wed, 26 Mar 2008 20:44:25 GMT

Managing provider based syndicated content

The example code below shows how to use the static SyndicationManager class to persist, retrieve, update and remove a simple RSS feed whose content is managed by the configured default provider. The task of managing provider-back syndicated content can be performed in a variety of application contexts, including console applications, smart clients, and ASP.NET web applications.

Guid resourceId                         = new Guid("3D586B56-1057-4b43-AD2C-9E99C58918E6");
 
// Get managed resource
ISyndicationResource managedResource    = SyndicationManager.GetResource(resourceId);
 
if (managedResource == null)
{
    RssFeed rssFeed                 = new RssFeed(new Uri(String.Format(null, "http://localhost/syndication.axd?id={0}", resourceId.ToString())), "Example RSS Feed");
    rssFeed.Channel.Description     = "An example RSS feed.";
    rssFeed.Channel.PublicationDate = new DateTime(2008, 3, 26, 9, 29, 30);
    rssFeed.Channel.LastBuildDate   = DateTime.Now;
    rssFeed.Channel.ManagingEditor  = "John Doe (john.doe@example.com)";
    rssFeed.Channel.TimeToLive      = 60;
 
    RssItem item        = new RssItem();
    item.Author         = "Sally Smith (sally.smith@example.com)";
    item.Link           = new Uri("http://localhost/2008/03/26/Simple+RSS+Item.aspx");
    item.Title          = "Simple RSS Item";
    item.Description    = "A basic RSS channel item";
 
    rssFeed.Channel.AddItem(item);
 
    // Create managed resource
    SyndicationResourceCreateStatus status  = SyndicationManager.CreateResource(resourceId, rssFeed);
    if (status != SyndicationResourceCreateStatus.Success)
    {
        // Handle creation failure
    }
}
else
{
    RssFeed feed    = null;
    if (managedResource.Format == SyndicationContentFormat.Rss)
    {
        feed    = (RssFeed)managedResource;
        foreach (RssItem item in feed.Channel.Items)
        {
            // Process current channel item
        }
 
        //  Update managed resource
        feed.Channel.Language   = new CultureInfo("en-US");
        feed.Channel.Categories.Add(new RssCategory("Channel Category"));
        feed.Channel[0].Categories.Add(new RssCategory("Item Category"));
        feed.Channel.LastBuildDate  = DateTime.Now;
 
        SyndicationManager.UpdateResource(resourceId, feed);
    }
 
    // Get all managed resources based on content format
    Collection <ISyndicationResource> managedResources  = SyndicationManager.GetResources(SyndicationContentFormat.Rss);
    foreach (ISyndicationResource resource in managedResources)
    {
        RssFeed currentFeed = resource as RssFeed;
 
        foreach (RssItem item in currentFeed.Channel.Items)
        {
            // Process current channel item of current feed
        }
    }
 
    // Remove managed resource
    SyndicationManager.DeleteResource(resourceId);
}

UPDATED WIKI: Configuring syndication resource providers within your application

Oppositional — Wed, 26 Mar 2008 20:38:41 GMT

Configuring syndication resource providers within your application

The first step is add the framework configuration sections for the features you wish to utilize within your App.config or Web.config configuration file:

<configSections>
  <!-- Syndication resources configuration section -->
  <section name="argotic.syndication" type="Argotic.Configuration.Provider.SyndicationResourceSection, Argotic.Core"/>
 
  <!-- Syndication HTTP Handler configuration section -->
  <section name="argotic.web.httpHandler" type="Argotic.Configuration.SyndicationResourceHandlerSection, Argotic.Web"/>
</configSections>

In the example above, the core argotic.syndication configuration section that most framework features are dependent upon is defined. In addition the configuration section for the syndication HTTP handler as been included.

The next step is to define the referenced configuration sections:

<!-- Configure provider(s) used to store syndicated content and indicate the default provider to use -->
<argotic.syndication defaultProvider="MySyndicationResourceProvider">
  <providers>
    <add name="MySyndicationResourceProvider" type="Argotic.Configuration.Provider.XmlSyndicationResourceProvider, Argotic.Core" applicationName="/" path="~/App_Data/Syndication" />
  </providers>
</argotic.syndication>

In the configuration section above, a single syndication resource provider is configured, in this case the XML file-based provider that is included in the framework.

<!-- Configure syndication HTTP handler (typically used by ASP.NET applications to act as a generic endpoint for managed syndicated content) -->
<argotic.web.httpHandler
  enableCaching="true"
  format="Rss"
  updatableWithin="0:15:0.0"
  validFor="0:59:0.0" 
/>

In the configuration section above, the HTTP handler has been configured to serve RSS feeds by default and has had caching enabled to improve scalability. By default the first (and sometime only) syndication resource managed by the provider for the specified default content format is served by the HTTP handler. If you wish to specify a specific managed resource, you may use the id attribute to explicitly indicate which syndication resource to retrieve from the provider.

If you choose to use the flexible HTTP handler that the framework provides, you must perform the additional step of mapping a path to the handler. This step varies depending on whether you use the classic or integrated managed pipeline mode:

Classic:
<httpHandlers>
  <add verb="GET,HEAD" path="syndication.axd" type="Argotic.Web.SyndicationResourceHandler, Argotic.Web" validate="false" />
</httpHandlers>
 
Integrated:
<handlers>
  <add name="SyndicationHandler" verb="GET,HEAD" path="syndication.axd" type="Argotic.Web.SyndicationResourceHandler, Argotic.Web" />
</handlers>

In the example above, we have specified that the syndication resource HTTP handler will be mapped to an endpoint path of syndication.axd and will accept the GET and HEAD verbs.

UPDATED WIKI: Home

Oppositional — Wed, 26 Mar 2008 20:18:14 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

Do You Grok Argotic? Display our network badges!

UPDATED WIKI: Introduction to the framework extensible provider model

Oppositional — Wed, 26 Mar 2008 19:54:24 GMT

Introduction to the framework extensible provider model

A provider is a software module that provides a uniform interface between a service and a data source. Providers abstract physical storage media, in much the same way that device drivers abstract physical hardware devices. Since the Argotic framework syndication resource management services are provider-based, storing syndicated content that implements the ISyndicationResource interface in an Oracle database rather than a Microsoft SQL Server database is as simple as plugging in a Oracle syndication resource provider. Code outside the provider layer needn't be modified, and a simple configuration change, accomplished declaratively through Web.config or App.config, connects the relevant services to the custom provider. The framework includes an XML file-based provider that can manage all of the syndication formats supported by the framework.

Thanks to the provider model, applications using the Argotic framework can be configured to store syndicated content virtually anywhere. Syndication feed data, for example, could just as easily come from a Web service as from a database. All that's required is a custom provider. Some companies will prefer to acquire custom providers from third parties. Others, however, will want to write their own, either because no suitable provider is available off the shelf, or because they wish to adapt their content syndication systems to legacy storage media (for example, existing relational databases or flat files).

Goals of the framework provider model

The Argotic framework provider model was designed with the following goals in mind:

Use the existing provider model architecture that Microsoft .NET provides.
To make syndication resource storage both flexible and extensible.
To insulate application-level code from the physical storage media where syndicated content is stored, and to isolate the changes required to use alternative media types to a single well-defined layer with minimal surface area.
To make writing custom providers as simple as possible by providing a robust and well-documented set of base classes from which developers can derive provider classes of their own.

It is expected that developers who wish to publish syndicated content using data sources for which off-the-shelf providers are not available can, with a reasonable amount of effort, write custom providers to do the job.

The SyndicationResourceProvider abstract class is simple, containing only a few basic methods and properties that are common to all syndication resource providers. Implementation-specific providers (such as the XmlSyndicationResourceProvider) inherit from this abstract base class in order to provide a uniform abstraction layer between a specific data storage implementation and the code that generates and/or manages the content being syndicated.

The provider model is intended to encapsulate the retrieval and persistence of syndicated content. It allows the developer to create supporting classes that provide multiple implementations of the encapsulated CRUD functionality. The most important aspect of the provider model is that the implementation (for example, whether data is persisted as a XML file or in a database) is abstracted from the application code. The type of the implementation-specific provider for the retrieval and persistence of syndicated content is designated in a configuration file. The syndication manager then reads in the type from the configuration file and acts as a factory to the syndicated content management code. The application developer can then use the syndication management classes in the application code. The implementation type can be swapped out in the configuration file, eliminating the need to rewrite the code to accommodate the different implementation methodology.

UPDATED WIKI: Home

Oppositional — Wed, 26 Mar 2008 19:25:20 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

Do You Grok Argotic? Display our network badges!

UPDATED WIKI: Generating portable web log content

Oppositional — Tue, 25 Mar 2008 22:26:10 GMT

How to generate Web Log Markup Language (BlogML) formatted content

Web Log Markup Language (BlogML) provides an open format derived from XML to store and restore the content of a blog. As the number of web log software platforms grows, there is a need to be able to import and export blog content in a portable, open format; and so the BlogML format was created to ease the difficulties faced when attempting to move web log content from one software platform to another.

The classes that together compose the implementation of BlogML are located in the Argotic.Syndication.Specialized namespace. The primary framework entity that you will use when working with BlogML formated syndication resources is the BlogMLDocument class. This class implements the ISyndicationResource and IExtensibleSyndicationObject interfaces, and provides an API that maps closely to the syndication specification entities as well as methods for consuming and persisting syndicated web log content. The framework will by default automatically load any syndication extensions that are present in addition to the syndicated portable web log content and attempt to handle malformed XML data.

One of the core principals of the framework is "Read flexibly, Write strictly". The framework upholds this principal by consuming syndication resources as flexibly as possible, but always generates output that strictly matches the syndication format specification. This methodology ensures you can consume syndication resources with confidence while still publishing syndicated content that strictly conforms to its format specification.

To create a new BlogML portable description of web log content, you simply instantiate a new instance of the BlogMLDocument class and utilize its properties and methods to describe the web log content you wish to syndicate. The framework API will as much as possible match the terminology used in the syndication format specification, which allows you to easily navigate the framework syndication entities.

using System.IO;
using Argotic.Syndication.Specialized;
 
BlogMLDocument document = new BlogMLDocument();
 
document.RootUrl        = new Uri("/blogs/default.aspx");
document.GeneratedOn    = new DateTime(2006, 9, 5, 18, 22, 10);
document.Title          = new BlogMLTextConstruct("BlogML 2.0 Example");
document.Subtitle       = new BlogMLTextConstruct("This is some sample blog content for BlogML 2.0");
 
BlogMLAuthor administrator      = new BlogMLAuthor();
administrator.Id                = "2100";
administrator.CreatedOn         = new DateTime(2006, 8, 10, 8, 44, 35);
administrator.LastModifiedOn    = new DateTime(2006, 9, 4, 13, 46, 38);
administrator.ApprovalStatus    = BlogMLApprovalStatus.Approved;
administrator.EmailAddress      = "someone@domain.com";
administrator.Title             = new BlogMLTextConstruct("admin");
document.Authors.Add(administrator);
 
document.ExtendedProperties.Add("CommentModeration", "Anonymous");
document.ExtendedProperties.Add("SendTrackback", "yes");
 
BlogMLCategory category1    = new BlogMLCategory();
category1.Id                = "1018";
category1.CreatedOn         = new DateTime(2006, 9, 5, 17, 54, 58);
category1.LastModifiedOn    = new DateTime(2006, 9, 5, 17, 54, 58);
category1.ApprovalStatus    = BlogMLApprovalStatus.Approved;
category1.Description       = "Sample Category 1";
category1.ParentId          = "0";
category1.Title             = new BlogMLTextConstruct("Category 1");
document.Categories.Add(category1);
 
BlogMLCategory category2    = new BlogMLCategory();
category2.Id                = "1019";
category2.CreatedOn         = new DateTime(2006, 9, 5, 17, 54, 59);
category2.LastModifiedOn    = new DateTime(2006, 9, 5, 17, 54, 59);
category2.ApprovalStatus    = BlogMLApprovalStatus.Approved;
category2.Description       = "Sample Category 2";
category2.ParentId          = "0";
category2.Title             = new BlogMLTextConstruct("Category 2");
document.Categories.Add(category2);
 
BlogMLCategory category3    = new BlogMLCategory();
category3.Id                = "1020";
category3.CreatedOn         = new DateTime(2006, 9, 5, 17, 55, 0);
category3.LastModifiedOn    = new DateTime(2006, 9, 5, 17, 55, 0);
category3.ApprovalStatus    = BlogMLApprovalStatus.NotApproved;
category3.Description       = "Sample Category 3";
category3.ParentId          = "0";
category3.Title             = new BlogMLTextConstruct("Category 3");
document.Categories.Add(category3);
 
BlogMLPost post         = new BlogMLPost();
post.Id                 = "34";
post.CreatedOn          = new DateTime(2006, 9, 5, 3, 19, 0);
post.LastModifiedOn     = new DateTime(2006, 9, 5, 3, 19, 0);
post.ApprovalStatus     = BlogMLApprovalStatus.Approved;
post.Url                = new Uri("/blogs/archive/2006/09/05/Sample-Blog-Post.aspx");
post.PostType           = BlogMLPostType.Normal;
post.Views              = "0";
post.Title              = new BlogMLTextConstruct("Sample Blog Post");
post.Content            = new BlogMLTextConstruct("<p>This is <b>HTML encoded</b> content.&nbsp;</p>", BlogMLContentType.Html);
post.Name               = new BlogMLTextConstruct("Sample Blog Post");
 
post.Categories.Add("1018");
post.Categories.Add("1020");
 
post.Authors.Add("2100");
 
BlogMLComment comment   = new BlogMLComment();
comment.Id              = "35";
comment.CreatedOn       = new DateTime(2006, 9, 5, 11, 36, 50);
comment.LastModifiedOn  = new DateTime(2006, 9, 5, 11, 36, 50);
comment.Title           = new BlogMLTextConstruct("re: Sample Blog Post");
comment.Content         = new BlogMLTextConstruct("This is a test comment.");
post.Comments.Add(comment);

The BlogML description generated in the above example represents an example of a categorized, multiple author web log and includes post comments.

UPDATED WIKI: Consuming portable web log content

Oppositional — Tue, 25 Mar 2008 22:20:09 GMT

How to consume Web Log Markup Language (BlogML) formatted content

Consuming portable web log content

The BlogMLDocument class provides two ways of consuming syndicated content that conforms to the BlogML syndication format. The first way to consume BlogML portable web log content is to use the static Create method exposed by the BlogMLDocument class, which provides a means of quickly consuming portable web log content that is available at a given Uri:

using Argotic.Syndication.Specialized;
 
BlogMLDocument document = BlogMLDocument.Create(new Uri("http://www.example.org/blog/blogML.axd"));
 
foreach (BlogMLPost post in document.Posts)
{
    if (post.ApprovalStatus == BlogMLApprovalStatus.Approved)
    {
        //  Perform some processing on the blog post
    }
}

The other way to consume BlogML formatted web log content is to use the overloaded Load method exposed by the BlogMLDocument class, which provides a means of consuming syndicated portable web log content from a variety of data sources such as IXPathNavigable, Stream, XmlReader, and Uri:

using System.IO;
using System.Xml;
using System.Xml.Xpath;
using Argotic.Syndication.Specialized;
 
BlogMLDocument document   = new BlogMLDocument();
 
using (FileStream stream = new FileStream("SampleWeblogContent.xml", FileMode.Open, FileAccess.Read))
{
    document.Load(stream);
}
 
document    = new BlogMLDocument();
using (FileStream stream = new FileStream("SampleWeblogContent.xml", FileMode.Open, FileAccess.Read))
{
    XmlReaderSettings settings  = new XmlReaderSettings();
    settings.IgnoreComments     = true;
    settings.IgnoreWhitespace   = true;
 
    using (XmlReader reader = XmlReader.Create(stream, settings))
    {
        document.Load(reader);
    }
}
 
document    = new BlogMLDocument();
using (FileStream stream = new FileStream("SampleWeblogContent.xml", FileMode.Open, FileAccess.Read))
{
    document.Load(new XPathDocument(stream));
}

Sample file that can be used with the above code example: SampleWeblogContent.xml

UPDATED WIKI: Consuming portable web log content

Oppositional — Tue, 25 Mar 2008 22:19:32 GMT

How to consume Web Log Markup Language (BlogML) formatted content

Consuming portable web log content

using Argotic.Syndication.Specialized;
 
BlogMLDocument document = BlogMLDocument.Create(new Uri("http://www.example.org/blog/blogML.axd"));
 
foreach (BlogMLPost post in document.Posts)
{
    if (post.ApprovalStatus == BlogMLApprovalStatus.Approved)
    {
        //  Perform some processing on the blog post
    }
}

using System.IO;
using System.Xml;
using System.Xml.Xpath;
using Argotic.Syndication.Specialized;
 
BlogMLDocument document   = new BlogMLDocument();
 
using (FileStream stream = new FileStream("SampleWeblogContent.xml", FileMode.Open, FileAccess.Read))
{
    document.Load(stream);
}
 
document    = new BlogMLDocument();
using (FileStream stream = new FileStream("SampleWeblogContent.xml", FileMode.Open, FileAccess.Read))
{
    XmlReaderSettings settings  = new XmlReaderSettings();
    settings.IgnoreComments     = true;
    settings.IgnoreWhitespace   = true;
 
    using (XmlReader reader = XmlReader.Create(stream, settings))
    {
        document.Load(reader);
    }
}
 
document    = new BlogMLDocument();
using (FileStream stream = new FileStream("SampleWeblogContent.xml", FileMode.Open, FileAccess.Read))
{
    document.Load(new XPathDocument(stream));
}

Sample file that can be used with the above code example: Cannot resolve link: [file:SampleWeblogContent.xml]

UPDATED WIKI: Home

Oppositional — Tue, 25 Mar 2008 21:59:51 GMT

Argotic: We speak the language so you don't have to.

ar·got·ic (ahr-got-ik)

A specialized idiomatic vocabulary peculiar to a particular class or group of people.
One of the most powerful and extensible web content syndication frameworks available to .NET developers.

Project Road Map

Argotic Syndication Framework 2008.1.0.0 Planning Center (Aranea)
Argotic Syndication Framework 2008.2.0.0 Planning Center (Loki)
Argotic Syndication Framework 2008.3.0.0 Planning Center (Metis)
Argotic Syndication Framework 2008.4.0.0 Planning Center (Gutenberg)

Argotic In The Spotlight

Getting Started With The Framework

The Basics

Overview of the framework

Consuming syndicated content

Generating syndicated content

Syndication Extensions

Overview of the framework extensibility model

Consuming syndication extension information

Consuming an extended RSS feed

Generating extended syndicated content

Generating an extended RSS feed

Network Protocols

Trackback peer-to-peer notification protocol

Sending notification pings using the Trackback client

XML-RPC communication protocol

Making remote procedure calls using the XML-RPC client

Specialized Content Formats

Attention Profiling Markup Language (APML)

Web Log Markup Language (BlogML)

Really Simple Discovery (RSD)

Framework Provider Model

Introduction to the framework extensible provider model
Configuring syndication resource providers within your application
Managing provider based syndicated content
Creating your own syndication provider

Project Contributors

Team Guides and Resources

Committed to outside contributors

Do You Grok Argotic? Display our network badges!

UPDATED WIKI: Publishing auto-discoverable web log communication service information

Oppositional — Tue, 25 Mar 2008 18:03:30 GMT

How to generate Really Simple Discovery (RSD) formatted web log communication services information

Really Simple Discovery (RSD) provides a standard means for client software find the services needed to read, edit, or communicate with web logging software. The goal of RSD is to reduce the information required to set up editing software to three well known elements: user name, password, and the web site URL. Other critical data will either be defined in the related RSD endpoint, or discoverable using the information provided.

The classes that together compose the implementation of RSD are located in the Argotic.Syndication.Specialized namespace. The primary framework entity that you will use when working with RSD formated syndication resources is the RsdDocument class. This class implements the ISyndicationResource and IExtensibleSyndicationObject interfaces, and provides an API that maps closely to the syndication specification entities as well as methods for consuming and persisting syndicated web log communication services information. The framework will by default automatically load any syndication extensions that are present in addition to the syndicated web log communication services information and attempt to handle malformed XML data.

One of the core principals of the framework is "Read flexibly, Write strictly". The framework upholds this principal by consuming syndication resources as flexibly as possible, but always generates output that strictly matches the syndication format specification. This methodology ensures you can consume syndication resources with confidence while still publishing syndicated content that strictly conforms to its format specification.

Discovery

The RSD document representing the services needed to read, edit, or communicate with web logging software can be found in the header of the web site. It is represented by a HTML element that looks like this:

<link type="application/rsd+xml" title="{Human readable label for web log communication services endpoint}" href="{Absolute URI that points to the RSD formatted web log communication services information}"/>
 
Example:
<link type="application/rsd+xml" title="RSD 1.0" href="http://www.example.com/rsd.axd"/>

Creating syndicated web log communication services information

To create a new RSD formatted description of available web log communication services, you simply instantiate a new instance of the RsdDocument class and utilize its properties and methods to describe the web log communication services you wish to syndicate. The framework API will as much as possible match the terminology used in the syndication format specification, which allows you to easily navigate the framework syndication entities.

using System.IO;
using Argotic.Syndication.Specialized;
 
RsdDocument document    = new RsdDocument();
 
document.EngineName     = "Blog Munging CMS";
document.EngineLink     = new Uri("http://www.blogmunging.com/");
document.Homepage       = new Uri("http://www.userdomain.com/");
 
document.AddInterface(new RsdApplicationInterface("MetaWeblog", new Uri("http://example.com/xml/rpc/url"), true, "123abc"));
document.AddInterface(new RsdApplicationInterface("Blogger", new Uri("http://example.com/xml/rpc/url"), false, "123abc"));
document.AddInterface(new RsdApplicationInterface("MetaWiki", new Uri("http://example.com/some/other/url"), false, "123abc"));
document.AddInterface(new RsdApplicationInterface("Antville", new Uri("http://example.com/yet/another/url"), false, "123abc"));
 
RsdApplicationInterface conversantApi   = new RsdApplicationInterface("Conversant", new Uri("http://example.com/xml/rpc/url"), false, String.Empty);
conversantApi.Documentation             = new Uri("http://www.conversant.com/docs/api/");
conversantApi.Notes                     = "Additional explanation here.";
conversantApi.Settings.Add("service-specific-setting", "a value");
conversantApi.Settings.Add("another-setting", "another value");
document.AddInterface(conversantApi);

The RSD web log communication services information generated in the above example represents an example of the typical services exposed by web logging software.

UPDATED WIKI: Publishing auto-discoverable web log communication service information

Oppositional — Tue, 25 Mar 2008 16:50:17 GMT

How to generate Really Simple DIscovery (RSD) formatted web log communication services information

Discovery

<link type="application/rsd+xml" title="{Human readable label for web log communication services endpoint}" href="{Absolute URI that points to the RSD formatted web log communication services information}"/>
 
Example:
<link type="application/rsd+xml" title="RSD 1.0" href="http://www.example.com/rsd.axd"/>

Creating syndicated web log communication services information

using System.IO;
using Argotic.Syndication.Specialized;
 
RsdDocument document    = new RsdDocument();
 
document.EngineName     = "Blog Munging CMS";
document.EngineLink     = new Uri("http://www.blogmunging.com/");
document.Homepage       = new Uri("http://www.userdomain.com/");
 
document.AddInterface(new RsdApplicationInterface("MetaWeblog", new Uri("http://example.com/xml/rpc/url"), true, "123abc"));
document.AddInterface(new RsdApplicationInterface("Blogger", new Uri("http://example.com/xml/rpc/url"), false, "123abc"));
document.AddInterface(new RsdApplicationInterface("MetaWiki", new Uri("http://example.com/some/other/url"), false, "123abc"));
document.AddInterface(new RsdApplicationInterface("Antville", new Uri("http://example.com/yet/another/url"), false, "123abc"));
 
RsdApplicationInterface conversantApi   = new RsdApplicationInterface("Conversant", new Uri("http://example.com/xml/rpc/url"), false, String.Empty);
conversantApi.Documentation             = new Uri("http://www.conversant.com/docs/api/");
conversantApi.Notes                     = "Additional explanation here.";
conversantApi.Settings.Add("service-specific-setting", "a value");
conversantApi.Settings.Add("another-setting", "another value");
document.AddInterface(conversantApi);

The RSD web log communication services information generated in the above example represents an example of the typical services exposed by web logging software.

UPDATED WIKI: Consuming web log communication services information

Oppositional — Tue, 25 Mar 2008 16:33:17 GMT

How to consume web log communication services information

Discovery

<link type="application/rsd+xml" title="{Human readable label for web log communication services endpoint}" href="{Absolute URI that points to the RSD formatted web log communication services information}"/>
 
Example:
<link type="application/rsd+xml" title="RSD 1.0" href="http://www.example.com/rsd.axd"/>

Consuming syndicated web log communication services information

The RsdDocument class provides two ways of consuming syndicated content that conforms to the RSD syndication format. The first way to consume RSD web log communication services is to use the static Create method exposed by the RsdDocument class, which provides a means of quickly consuming web log communication services information that is available at a given Uri:

using Argotic.Syndication.Specialized;
 
RsdDocument document    = RsdDocument.Create(new Uri("http://blog.oppositionallydefiant.com/rsd.axd"));
            
foreach(RsdApplicationInterface api in document.Interfaces)
{
    if (api.IsPreferred)
    {
        //  Perform some processing on the application programming interface
        break;
    }
}

The other way to consume RSD formatted web log communication services is to use the overloaded Load method exposed by the RsdDocument class, which provides a means of consuming syndicated web log communication services information from a variety of data sources such as IXPathNavigable, Stream, XmlReader, and Uri:

using System.IO;
using System.Xml;
using System.Xml.Xpath;
using Argotic.Syndication.Specialized;
 
RsdDocument document   = new RsdDocument();
 
using (FileStream stream = new FileStream("SampleRsdDocument.xml", FileMode.Open, FileAccess.Read))
{
    document.Load(stream);
}
 
document    = new RsdDocument();
using (FileStream stream = new FileStream("SampleRsdDocument.xml", FileMode.Open, FileAccess.Read))
{
    XmlReaderSettings settings  = new XmlReaderSettings();
    settings.IgnoreComments     = true;
    settings.IgnoreWhitespace   = true;
 
    using (XmlReader reader = XmlReader.Create(stream, settings))
    {
        document.Load(reader);
    }
}
 
document    = new RsdDocument();
using (FileStream stream = new FileStream("SampleRsdDocument.xml", FileMode.Open, FileAccess.Read))
{
    document.Load(new XPathDocument(stream));
}

Sample file that can be used with the above code example: SampleRsdDocument.xml