Skip to content
Sitemaps management module
Branch: dev
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
NuGet
VirtoCommerce.SitemapsModule.Core
VirtoCommerce.SitemapsModule.Data
VirtoCommerce.SitemapsModule.Test
VirtoCommerce.SitemapsModule.Web
.gitattributes
.gitignore
CommonAssemblyInfo.cs
Jenkinsfile
LICENSE
README.md
VirtoCommerce.SitemapsModule.sln

README.md

VirtoCommerce.Sitemaps

VirtoCommerce.Sitemaps module represents sitemaps management system.

Use cases

  • Add a sitemap for a store sitemaps-1

  • Add a sitemap items (categories, products, vendors, custom sitemap items, etc.) to a sitemap sitemaps-2 sitemaps-3

And after that:

  • Download a zip package with pregenerated sitemap XML files and place its content to store website manually
  • Get the sitemaps schema and generate sitemap index file and sitemap files on-the-fly by API call (recommended for small stores, where the number of catalog items/vendors is less than 500)
  • Get the sitemaps schema and pregenerate sitemap XML files by scheduled recurring job (recommended for big stores since catalog/vendor search is a long-term process and sitemaps generation may require tens of minutes)

API calls

// Get a collection of sitemap location URLs

[GET] api/sitemaps/schema?storeId=...
// Get a stream contains a sitemap file XML data

[GET] api/sitemaps/generate?storeId=...&baseUrl=...&sitemapUrl=...

Documentation

User guide: Sitemaps

Installation

Installing the module:

Settings

General settings

  • Records limit (default value: 10000) - sets the maximum number of URLs record per sitemap file
  • Filename separator (default value: --) - sets the sitemap location separator in case of sitemap items number exceeds the Records limit parameter value (i.e.: "products.xml" -> "products--1.xml" and "products--2.xml")
  • Search bunch size (default value: 1000) - this parameter is using in long-term search processes (i.e. catalog search) to divide search requests and sets the search request bunch size parameter
  • Export/Import description (default value: Export/Import sitemaps with all sitemap items) - sets the description for platform export/import process

Category links

  • Category page priority (default value: 0.7) - sets the value of the sitemap <priority> parameter of catalog categories pages
  • Category page update frequency (default value: weekly) - sets the value of the sitemap <changefreq> parameter of catalog categories pages

Product links

  • Product page priority (default value: 1.0) - sets the value of the sitemap <priority> parameter of catalog products pages
  • Product page update frequency (default value: daily) - sets the value of the sitemap <changefreq> parameter of catalog products pages

License

Copyright (c) Virtosoftware Ltd. All rights reserved.

Licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://virtocommerce.com/opensourcelicense

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

You can’t perform that action at this time.