https://github.com/wiredviews/xperience-rss-feeds
RSS Feed Integration for ASP.NET Core based Kentico Xperience 13.0 applications using Content Tree Routing
https://github.com/wiredviews/xperience-rss-feeds
Last synced: over 1 year ago
JSON representation
RSS Feed Integration for ASP.NET Core based Kentico Xperience 13.0 applications using Content Tree Routing
- Host: GitHub
- URL: https://github.com/wiredviews/xperience-rss-feeds
- Owner: wiredviews
- License: mit
- Created: 2022-01-22T20:59:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-21T00:16:09.000Z (over 4 years ago)
- Last Synced: 2025-01-22T12:49:00.599Z (over 1 year ago)
- Language: C#
- Homepage:
- Size: 314 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Xperience RSS Feeds
[](https://www.nuget.org/packages/XperienceCommunity.RSSFeeds)
RSS Feed Integration for ASP.NET Core based Kentico Xperience 13.0 applications using Content Tree Routing
## Dependencies
This package is compatible with ASP.NET Core 3.1+ and is designed to be used with ASP.NET Core applications integrated with Kentico Xperience 13.0.
## How to Use?
1. [Import the Page Type definition](https://docs.xperience.io/deploying-websites/exporting-and-importing-sites/importing-a-site-or-objects) included in this repository, for the version of the package your are installing, into your Administration application:
Example: [./src/XperienceCommunity.RSSFeeds.Import.v1.0.0.zip](./src/XperienceCommunity.RSSFeeds.Import.v1.0.0.zip)
1. Install the NuGet package in your ASP.NET Core project
```bash
dotnet add package XperienceCommunity.RSSFeeds
```
1. Register the package's types with the `IServiceCollection`
```csharp
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddRSSFeeds();
}
}
```
1. Create a new Page (anywhere) in the Content Tree for your RSS Feed and populate the required fields:
1. Optional: Create your own custom `IRSSFeedItemsRetriever` implementation:
```csharp
public class CustomRSSFeedItemsRetriever : IRSSFeedItemsRetriever
{
// ...
public async Task> RetrieveAsync(RSSFeedPage feedPage, CancellationToken token)
{
// ...
}
}
```
Then register it with the `IServicesCollection`:
```csharp
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddRSSFeeds();
}
}
```
## How Does It Work?
Kentico Xperience handles routing for the RSS feed using [Content Tree Routing](https://docs.xperience.io/developing-websites/implementing-routing/content-tree-based-routing).
This library provides a Controller and Page Type to connect the Content Tree Route to a dynamically generated RSS Feed.
You can create as many RSS Feed Pages as you need and select different Page Types for each of them if you want to host feeds for different content. The URL of the RSS Feed Page is the URL of the RSS Feed.
It also provides a default implementation of `IRSSFeedItemsRetriever` which uses the `DocumentPageTitle`, `DocumentPageDescription` and `DocumentPageKeywords` fields of retrieved pages to populate the RSS Feed.
The benefit of using these fields is that no SQL `UNION`s need performed to get all the necessary data if multiple Page Types are specified for the RSS Feed.
Below is an example of this metadata populated for a Page:
And the resulting RSS Feed:
If the `RSSFeedController` is called from outside Xperience's routing or if the RSS Feed Page has no selected Page Types, the URL will return a 404.
### Auto Populating `DocumentPageTitle`, `DocumentPageDescription` and `DocumentPageKeywords`
Populating the `TreeNode` fields used by this package can be additional work for Content Managers, especially when
the values they want in these fields already exist in the Page Type custom fields for each Page Type.
Fortunately this can be easily resolved by using Document Global Events in a custom Module class:
```csharp
[assembly: RegisterModule(typeof(TreeNodeEventsModule))]
namespace CMSApp
{
public class TreeNodeEventsModule : Module
{
public TreeNodeEventsModule() : base(nameof(TreeNodeEventsModule)) { }
protected override void OnInit()
{
base.OnInit();
DocumentEvents.Insert.Before += Insert_Before;
DocumentEvents.Update.Before += Update_Before;
}
private void Update_Before(object sender, DocumentEventArgs e)
{
e.Node.SetValue("DocumentPageTitle", ...);
e.Node.SetValue("DocumentPageDescription", ...);
e.Node.SetValue("DocumentPageKeywords", ...);
}
private void Insert_Before(object sender, DocumentEventArgs e)
{
e.Node.SetValue("DocumentPageTitle", ...);
e.Node.SetValue("DocumentPageDescription", ...);
e.Node.SetValue("DocumentPageKeywords", ...);
}
}
}
```
### Customizing Feed Item Creation
If you need to populate more of the fields for the RSS Feed Items (like Author), use something other than `DocumentLastPublished` to order the results populating the Feed, or populate the Feed items from specific database columns, then implement your own `IRSSFeedItemsRetriever` using whatever `DocumentQuery` fits your needs.
You can also use the `RSSFeedPage` parameter to populate different content for the same Page Types in different parts of the Content Tree.
## Contributions
If you discover a problem, please [open an issue](https://github.com/wiredviews/xperience-rss-feeds/issues/new).
If you would like contribute to the code or documentation, please [open a pull request](https://github.com/wiredviews/xperience-rss-feeds/compare).
## References
- [RssSyndication project on GitHub](https://github.com/shawnwildermuth/RssSyndication)
### Kentico Xperience
- [Kentico Xperience Content Tree Routing docs](https://docs.xperience.io/developing-websites/implementing-routing/content-tree-based-routing)