Для того, чтобы установить карту сайта в ваше приложение, следуйте нижеприведённой инструкции:

Для активации генератора карты сайта добавьте следующую строку в файл привязок URL:

 (r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps})

Эта строка указывает Django, что необходимо построить карту сайта, когда клиент запросит /sitemap.xml.

Имя для файла содержащего карту сайта не имеет значения, но вот расположение этого файла имеет. Поисковые движки всегда индексируют ссылки в вашей карте относительно текущего уровня URL и ниже. Например, если sitemap.xml находится в корневом каталоге сайта, он может ссылаться на любой URL вашего сайта. Однако, если карта сайта находится по URL /content/sitemap.xml, он может ссылаться на URL, начинающийся с /content/.

Представление для карты сайта принимает дополнительный обязательный аргумент: {'sitemaps': sitemaps}. Значение sitemaps должно быть словарём, который совпадает с сокращённой меткой (т.е. blog или news) для своего класса Sitemap (т.е. BlogSitemap или NewsSitemap). Значение может также совпадать с экземпляром класса Sitemap (т.е., с BlogSitemap(some_var)).

Класс Sitemap — это обычный Python класс, который представляет «раздел» элементов вашей карты сайта. Например, один класс Sitemap может представлять все записи вашего блога, в то время как другой класс представляет все события вашего календаря.

В простейшем случае все эти разделы объединяются в единый sitemap.xml. Также есть возможность использовать среду для генерации индекса карты сайта, который будет ссылаться на отдельные файлы карт, один файл на карту.

Классы Sitemap должны подключать django.contrib.sitemaps.Sitemap и могут располагаться в любом месте вашего кода.

Например, предположим, что у вас есть система ведения блогов, использующая модель Entry. И вы желаете, чтобы карта сайта включала все ссылки на каждую запись блога. Вот так может выглядеть ваш класс Sitemap:

from django.contrib.sitemaps import Sitemap
from mysite.blog.models import Entry

class BlogSitemap(Sitemap):
    changefreq = "never"
    priority = 0.5

    def items(self):
        return Entry.objects.filter(is_draft=False)

    def lastmod(self, obj):
        return obj.pub_date

Объявление Sitemap должна выглядеть подобно декларации класса Feed, таков дизайн Django.

Подобно классам Feed, члены класса Sitemap могут быть как методами, так и атрибутами. Подробности были описаны в разделе «Более сложная трансляция».

Класс Sitemap может определять следующие методы или атрибуты:

Среда генерации карты сайта поставляется с рядом удобных классов пригодных для решения общих задач. Они будут описаны дальше в этой главе.

from django.conf.urls.defaults import *
from django.contrib.sitemaps import FlatPageSitemap, GenericSitemap
from mysite.blog.models import Entry

info_dict = {
    'queryset': Entry.objects.all(),
    'date_field': 'pub_date',
}

sitemaps = {
    'flatpages': FlatPageSitemap,
    'blog': GenericSitemap(info_dict, priority=0.6),
}

urlpatterns = patterns('',
    # some generic view using info_dict
    # ...

    # the sitemap
    (r'^sitemap.xml$',
     'django.contrib.sitemaps.views.sitemap',
     {'sitemaps': sitemaps})
)

Среда генерации карты сайта также имеет возможность создавать индекс для карты сайта, который ссылается на отдельные файлы с картами сайта, по одному на каждую секцию определённою в словаре sitemaps. Отличия:

Вот так изменится предыдущий пример:

(r'^sitemap.xml$',
 'django.contrib.sitemaps.views.index',
 {'sitemaps': sitemaps}),

(r'^sitemap-(?P<section>.+).xml$',
 'django.contrib.sitemaps.views.sitemap',
 {'sitemaps': sitemaps})

Это автоматически создаст файл sitemap.xml, который будет ссылаться на sitemap-flatpages.xml и sitemap-blog.xml. Классы Sitemap и словарь sitemaps не изменятся.

Вы можете организовать уведомление Google об изменениях в карте сайта, чтобы они знали, что надо произвести повторную индексацию вашего сайта. Среда предоставляет функцию для этого — django.contrib.sitemaps.ping_google().

Функция ping_google() принимает необязательный аргумент sitemap_url, который должен содержать абсолютный URL для карты сайта (т.е. /sitemap.xml). Если этот аргумент опущен, функция попытается найти карту сайта через файл привязок.

Функция ping_google() вызывает исключение django.contrib.sitemaps.SitemapNotFound, если она не может определить URL для карты сайта.

Ниже показан полезный способ вызова ping_google() из метода save() модели:

from django.contrib.sitemaps import ping_google

class Entry(models.Model):
    # ...
    def save(self):
        super(Entry, self).save()
        try:
            ping_google()
        except Exception:
            # Простое исключение, так как мы можем получить целый
            # набор исключений, относящихся к HTTP.
            pass

Однако, более эффективным решением будет вызов ping_google() из скрипта cron или из другого периодического процесса. Функция выполняет HTTP запрос к серверам Google и вам может не понравится расход пропускной способности сети при каждом вызове save().