= Google sitemap generator =

== Description ==
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.

The plugin will notify Google by sending a PING request to their site whenever content on your trac has changed. For now, wiki pages are supported in the sitemap, but tickets will eventually follow.

== Requirements ==
The plugin was tested with Python 2.3 but should work with 2.4 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.

If the [http://trac.edgewall.org/wiki/WebAdmin webadmin plugin] is installed, this plugin will register a page to configure it. ''Please note that (as of today 2006-11-09) this does not work, the admin page is not finished yet.''

== Installation ==
Download the source code into a directory of your choice, open a command line terminal and run this command:
{{{
python setup.py install
}}}

Activate the plugin in your trac environment by adding this line to the section [component] of trac.ini
{{{
sitemap.* = enabled
}}}

Restart your webserver.

== Bugs/Feature Requests == 

Existing bugs and feature requests for GoogleSitemapPlugin are 
[report:9?COMPONENT=GoogleSitemapPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=GoogleSitemapPlugin&owner=datenimperator new ticket].

== Download ==

Download the zipped source from [download:googlesitemapplugin here].

== Source ==

You can check out GoogleSitemapPlugin from [http://svn.voidblog.de/sitemap-plugin/trunk here] using Subversion. Visit http://voidblog.de/browser/sitemap-plugin to browse the source code.

== Example ==

This is how a sitemap XML could look like:

{{{
#!xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.google.com/schemas/sitemap/0.84">
<url>
<loc>http://localhost/wiki/ImageTest</loc>
<lastmod>2006-11-07T15:37:07Z</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
}}}

More about the document format can be found [https://www.google.com/webmasters/sitemaps/docs/en/protocol.html here].

== Recent Changes ==

[[ChangeLog(googlesitemapplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:datenimperator] [[BR]]
'''Contributors:'''