Changes between Version 14 and Version 15 of GoogleSitemapPlugin


Ignore:
Timestamp:
May 27, 2010 4:58:48 PM (4 years ago)
Author:
martin_s
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GoogleSitemapPlugin

    v14 v15  
    33 
    44== Description == 
    5 This plugin will handle requests of the URL /sitemap.xml and will produce XML suitable for submission to the [https://www.google.com/webmasters/sitemaps/docs/en/about.html Google sitemap] service. The sitemap is a way to describe your site's content other than depending on a crawler that follows every link. It's suitable for dynamic sites with lots of different URLs for basically the same content. 
     5This plugin will produce a site maps XML file suitable for submission to the [https://www.google.com/webmasters/sitemaps/docs/en/about.html Google sitemap] service. The sitemap is a way to describe your site's content other than depending on a crawler that follows every link. It's suitable for dynamic sites with lots of different URLs for basically the same content. 
    66 
    77The maintainer-ship of this plugin for Trac 0.11+ was taken over by [wiki:martin_s] in May 2010. The new Trac 0.11 version was written from scratch, mainly because of great API changes between the Trac versions. 
    8 This wiki page is not yet fully updated to reflect the (sometimes missing) features of the new version. 
     8This wiki now describes only the 0.11 (and newer branches in the future). The old [GoogleSitemapPlugin?version=10 description for the 0.10 branch] is also available. 
    99 
    10 The plugin will notify Google by sending a PING request to their site whenever content on your trac has changed (Trac 0.10 version only). For now, wiki pages are supported in the sitemap, but tickets will eventually follow. 
    11  
    12 == Requirements == 
    13 The plugin was tested with Python 2.4 but should work with 2.3 as well. It uses API extensions of trac 0.10, so it wouldn't run with older versions of trac. Furthermore, you need '''setuptools''' to install and run the extension. 
    14  
    15 If the [http://trac.edgewall.org/wiki/WebAdmin webadmin plugin] is installed, this plugin will register a page to configure it. 
     10The plugin can be configured to notify Google by sending a PING request to their site when content on your trac has changed (Trac 0.10 version only). 
     11For now, wiki pages and tickets are supported in the sitemap. Other things like source code and pages produced by other plugins could also be included if requested. 
    1612 
    1713== Installation == 
     
    2117}}} 
    2218 
    23 Activate the plugin in your trac environment by adding this line to the section [component] of trac.ini 
     19or use `easy_install` either on the downloaded source code or the SVN URL: 
    2420{{{ 
    25 sitemap.* = enabled 
     21easy_install <downloaded zip file or dir> 
     22# or 
     23easy_install http://trac-hacks.org/svn/googlesitemapplugin/0.11 
    2624}}} 
    2725 
    28 Restart your webserver. 
     26Activate the plugin and, optionally, the automatic notification in your Trac environment by adding this line to the section [component] of `<your trac installation dir>/conf/trac.ini` or use the IniAdminPlugin: 
     27{{{ 
     28tracgooglesitemap.plugin = enabled 
     29tracgooglesitemap.notify = enabled   # optional, notifies Google to reload the sitemap when content has changed 
     30}}} 
     31 
     32Restart your web- or trac-server. 
    2933 
    3034== Bugs/Feature Requests ==  
    3135 
    32 See [query:status!=closed&component=GoogleSitemapPlugin&order=priority existing bugs and feature requests], and feel free to create a [/newticket?component=GoogleSitemapPlugin&owner=martin_s new ticket]. 
     36See [query:status!=closed&component=GoogleSitemapPlugin&order=priority existing bugs and feature requests], and feel free to create a [/newticket?component=GoogleSitemapPlugin&owner=martin_s&version=0.11 new ticket]. 
    3337 
    34 == Download and Source == 
     38== Download == 
    3539 
    36  Trac 0.10:: 
    37   The project has been recently reactivated, since the original source code location has been switched off. In future, source will be on trac hacks SVN. Meanwhile, there's a trac.10 compatible egg available as an attachment  
    38   [attachment:sitemap-0.1dev_r18-py2.5.egg.tar.gz here]. Place it in the Trac {{{plugins}}} directory, e.g. {{{/usr/share/trac/plugins}}}. Visit http://svn.software-consultant.net/browser/sitemap-plugin/trunk to browse the  
    39   source code. 
     40Download the zipped source from [download:googlesitemapplugin here]. 
     41 
     42== Source == 
     43 
     44You can check out GoogleMapMacro for Trac 0.11 from [http://trac-hacks.org/svn/googlesitemapplugin/0.11 here] using Subversion, or [source:googlesitemapplugin/0.11 browse the source] with Trac. 
    4045 
    4146== Example == 
     
    4651#!xml 
    4752<?xml version="1.0" encoding="UTF-8"?> 
    48 <urlset xmlns="http://www.google.com/schemas/sitemap/0.84"> 
     53<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" 
     54        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     55        xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"> 
    4956<url> 
    50 <loc>http://localhost/wiki/ImageTest</loc> 
    51 <lastmod>2006-11-07T15:37:07Z</lastmod> 
    52 <changefreq>daily</changefreq> 
     57   <loc>http://<your trac url>/<trac project>/wiki/WikiStart</loc> 
     58   <lastmod>2010-11-07T15:37:07Z</lastmod> 
     59   <changefreq>daily</changefreq> 
     60</url> 
     61<url> 
     62   <loc>http://<your trac url>/<trac project>/wiki/SomePage</loc> 
     63   <lastmod>2010-11-07T16:22:35Z</lastmod> 
     64   <changefreq>daily</changefreq> 
    5365</url> 
    5466</urlset>