sitemap 是你服務器上的一個XML文件，它告訴搜索引擎你的頁面的更新頻率和某些頁面相對于其它頁面的重要性。 這個信息會幫助搜索引擎索引你的網站。

例如，這是 Django 網站(http://www.djangoproject.com/sitemap.xml)sitemap的一部分：
 

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> 
3.  <url> 
4.   <loc>http://www.djangoproject.com/documentation/</loc> 
5.   <changefreq>weekly</changefreq> 
6.   <priority>0.5</priority> 
7.  </url> 
8.  <url> 
9.   <loc>http://www.djangoproject.com/documentation/0_90/</loc> 
10.   <changefreq>never</changefreq> 
11.   <priority>0.1</priority> 
12.  </url> 
13.  ... 
14. </urlset> 

需要了解更多有關 sitemaps 的信息, 請參見 http://www.sitemaps.org/.

Django sitemap 框架允許你用 Python 代碼來表述這些信息，從而自動創建這個XML文件。 要創建一個站點地圖，你只需要寫一個`` Sitemap`` 類，并且在URLconf中指向它。
安裝

要安裝 sitemap 應用程序, 按下面的步驟進行:

•     將 'django.contrib.sitemaps' 添加到您的 INSTALLED_APPS 設置中.
•     確保 'django.template.loaders.app_directories.load_template_source' 在您的 TEMPLATE_LOADERS 設置中。 默認情況下它在那里, 所以, 如果你已經改變了那個設置的話, 只需要改回來即可。
•     確定您已經安裝了 sites 框架.

Note

sitemap 應用程序沒有安裝任何數據庫表. 它需要加入到 INSTALLED_APPS 中的唯一原因是: 這樣 load_template_source 模板加載器可以找到默認的模板. The only reason it needs to go into INSTALLED_APPS is so the load_template_source template loader can find the default templates.
Initialization

要在您的Django站點中激活sitemap生成, 請在您的 URLconf 中添加這一行:

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

This line tells Django to build a sitemap when a client accesses /sitemap.xml . Note that the dot character in sitemap.xml is escaped with a backslash, because dots have a special meaning in regular expressions.

sitemap文件的名字無關緊要，但是它在服務器上的位置卻很重要。 搜索引擎只索引你的sitemap中當前URL級別及其以下級別的鏈接。 用一個實例來說，如果 sitemap.xml 位于你的根目錄，那么它將引用任何的URL。 然而，如果你的sitemap位于 /content/sitemap.xml ，那么它只引用以 /content/ 打頭的URL。

sitemap視圖需要一個額外的必須的參數： {'sitemaps': sitemaps} . sitemaps should be a dictionary that maps a short section label (e.g., blog or news ) to its Sitemap class (e.g., BlogSitemap or NewsSitemap ). It may also map to an instance of a Sitemap class (e.g., BlogSitemap(some_var) ).
Sitemap 類

Sitemap 類展示了一個進入地圖站點簡單的Python類片斷.例如,一個 Sitemap 類能展現所有日志入口，而另外一個能夠調度所有的日歷事件。 For example, one Sitemap class could represent all the entries of your weblog, while another could represent all of the events in your events calendar.

在最簡單的例子中，所有部分可以全部包含在一個 sitemap.xml 中，也可以使用框架來產生一個站點地圖，為每一個獨立的部分產生一個單獨的站點文件。

Sitemap 類必須是 django.contrib.sitemaps.Sitemap 的子類. 他們可以存在于您的代碼樹的任何地方。

例如假設你有一個blog系統，有一個 Entry 的model，并且你希望你的站點地圖包含所有連到你的blog入口的超鏈接。 你的 Sitemap 類很可能是這樣的：
 

1. from django.contrib.sitemaps import Sitemap 
2. from mysite.blog.models import Entry 
3.  
4. class BlogSitemap(Sitemap): 
5.   changefreq = "never" 
6.   priority = 0.5 
7.  
8.   def items(self): 
9.     return Entry.objects.filter(is_draft=False) 
10.  
11.   def lastmod(self, obj): 
12.     return obj.pub_date 

聲明一個 Sitemap 和聲明一個 Feed 看起來很類似；這都是預先設計好的。

如同 Feed 類一樣， Sitemap 成員也既可以是方法，也可以是屬性。

一個 Sitemap 類可以定義如下 方法/屬性:

    items (必需 )：提供對象列表。 框架并不關心對象的 類型 ；唯一關心的是這些對象會傳遞給 location() ， lastmod() ， changefreq() ，和 priority() 方法。

    location （可選）： 給定對象的絕對URL。 絕對URL不包含協議名稱和域名。 下面是一些例子：

•         好的: '/foo/bar/' '/foo/bar/'
•         差的: 'example.com/foo/bar/' 'example.com/foo/bar/'

    如果沒有提供 location , 框架將會在每個 items() 返回的對象上調用 get_absolute_url() 方法.

    lastmod (可選): 對象的最后修改日期, 作為一個Python datetime 對象. The object's last modification date, as a Python datetime object.

    changefreq （可選）： 對象變更的頻率。 可選的值如下（詳見Sitemaps文檔）：

•         'always'
•         'hourly'
•         'daily'
•         'weekly'
•         'monthly'
•         'yearly'
•         'never'
•     priority （可選）： 取值范圍在 0.0 and 1.0 之間，用來表明優先級。

快捷方式

sitemap框架提供了一些常用的類。 在下一部分中會看到。
FlatPageSitemap

django.contrib.sitemaps.FlatPageSitemap 類涉及到站點中所有的flat page，并在sitemap中建立一個入口。 但僅僅只包含 location 屬性，不支持 lastmod ， changefreq ，或者 priority 。

GenericSitemap

GenericSitemap 與所有的通用視圖一同工作（詳見第9章）。

你可以如下使用它，創建一個實例，并通過 info_dict 傳遞給通用視圖。 唯一的要求是字典包含 queryset 這一項。 也可以用 date_field 來指明從 queryset 中取回的對象的日期域。 這會被用作站點地圖中的 lastmod 屬性。

下面是一個使用 FlatPageSitemap and GenericSiteMap （包括前面所假定的 Entry 對象）的URLconf：
 

1. from django.conf.urls.defaults import * 
2. from django.contrib.sitemaps import FlatPageSitemap, GenericSitemap 
3. from mysite.blog.models import Entry 
4.  
5. info_dict = { 
6.   'queryset': Entry.objects.all(), 
7.   'date_field': 'pub_date', 
8. } 
9.  
10. sitemaps = { 
11.   'flatpages': FlatPageSitemap, 
12.   'blog': GenericSitemap(info_dict, priority=0.6), 
13. } 
14.  
15. urlpatterns = patterns('', 
16.   # some generic view using info_dict 
17.   # ... 
18.  
19.   # the sitemap 
20.   (r'^sitemap/.xml$', 
21.    'django.contrib.sitemaps.views.sitemap', 
22.    {'sitemaps': sitemaps}) 
23. ) 

創建一個Sitemap索引

sitemap框架同樣可以根據 sitemaps 字典中定義的單獨的sitemap文件來建立索引。 用法區別如下：

    您在您的URLconf 中使用了兩個視圖: django.contrib.sitemaps.views.index 和 django.contrib.sitemaps.views.sitemap . `` django.contrib.sitemaps.views.index`` 和`` django.contrib.sitemaps.views.sitemap``

    django.contrib.sitemaps.views.sitemap 視圖需要帶一個 section 關鍵字參數.

這里是前面的例子的相關的 URLconf 行看起來的樣子:
 

1. (r'^sitemap.xml$', 
2.  'django.contrib.sitemaps.views.index', 
3.  {'sitemaps': sitemaps}), 
4.  
5. (r'^sitemap-(?P<section>.+).xml$', 
6.  'django.contrib.sitemaps.views.sitemap', 
7.  {'sitemaps': sitemaps}) 

這將自動生成一個 sitemap.xml 文件, 它同時引用 sitemap-flatpages.xml 和 sitemap-blog.xml . Sitemap 類和 sitemaps 目錄根本沒有更改.
通知Google

當你的sitemap變化的時候，你會想通知Google，以便讓它知道對你的站點進行重新索引。 框架就提供了這樣的一個函數： django.contrib.sitemaps.ping_google() 。

ping_google() 有一個可選的參數 sitemap_url ，它應該是你的站點地圖的URL絕對地址（例如：

如果不能夠確定你的sitemap URL, ping_google() 會引發 django.contrib.sitemaps.SitemapNotFound 異常。

我們可以通過模型中的 save() 方法來調用 ping_google() ：
 

1. from django.contrib.sitemaps import ping_google 
2.  
3. class Entry(models.Model): 
4.   # ... 
5.   def save(self, *args, **kwargs): 
6.     super(Entry, self).save(*args, **kwargs) 
7.     try: 
8.       ping_google() 
9.     except Exception: 
10.       # Bare 'except' because we could get a variety 
11.       # of HTTP-related exceptions. 
12.       pass 

一個更有效的解決方案是用 cron 腳本或任務調度表來調用 ping_google() ，該方法使用Http直接請求Google服務器，從而減少每次調用 save() 時占用的網絡帶寬。 The function makes an HTTP request to Google's servers, so you may not want to introduce that network overhead each time you call save() .

Finally, if 'django.contrib.sitemaps' is in your INSTALLED_APPS , then your manage.py will include a new command, ping_google . This is useful for command-line access to pinging. For example:
 

1. python manage.py ping_google /sitemap.xml