Changes between Version 21 and Version 22 of GoogleSitemapPlugin


Ignore:
Timestamp:
Aug 6, 2015, 1:00:05 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • GoogleSitemapPlugin

    v21 v22  
    11[[PageOutline(2-5,Contents,pullout)]]
    2 = Google sitemap generator =
    32
    4 == Description ==
    5 This 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.
     3= Google sitemap generator
    64
    7 The 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 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.
     5== Description
     6
     7This plugin produces a site map 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 is suitable for dynamic sites with lots of different URLs for basically the same content.
    98
    109The 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).
    … …  
    1312'''Fork:''' I have made a small [https://github.com/trac-hacks/trac-googlesitemapplugin fork on GitHub] with some improvements/fixes. Feel free to [https://github.com/trac-hacks/trac-googlesitemapplugin/issues suggest new].
    1413
    15 == Installation ==
     14The 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 the API changes between the Trac versions.
     15This wiki now describes only the Trac 0.11 (and newer branches in the future). The old [./GoogleSitemapPlugin?version=10 description for the 0.10 branch] is also available.
     16
     17== Bugs/Feature Requests
     18
     19See [query:status!=closed&component=GoogleSitemapPlugin&order=priority existing bugs and feature requests], and feel free to create a [/newticket?component=GoogleSitemapPlugin&version=0.11 new ticket].
     20
     21[[TicketQuery(component=GoogleSitemapPlugin&group=type,format=progress)]]
     22
     23== Download
     24
     25Download the zipped source from [download:googlesitemapplugin here].
     26
     27== Source
     28
     29You 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.
     30
     31== Installation
     32
    1633Download the source code into a directory of your choice, open a command line terminal and run this command:
    17 {{{
     34{{{#!sh
    1835python setup.py install
    1936}}}
    2037
    2138or use `easy_install` either on the downloaded source code or the SVN URL:
    22 {{{
     39{{{#!sh
    2340easy_install <downloaded zip file or dir>
    2441# or
    … …  
    2643}}}
    2744
    28 Activate 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:
    29 {{{
     45Activate the plugin and, optionally, the automatic notification in your Trac environment by adding this line to the section [components] of `<your trac installation dir>/conf/trac.ini` or use the IniAdminPlugin:
     46{{{#!ini
     47[components]
    3048tracgooglesitemap.plugin = enabled
    3149tracgooglesitemap.notify = enabled   # optional, notifies Google to reload the sitemap when content has changed
    … …  
    3452Restart your web- or trac-server.
    3553
    36 == Configuration ==
     54== Configuration
     55
    3756The following options are supported. They must be placed under a `[googlesitemap]` section in the configuration file.
    3857
    39     sitemappath:: Path of the sitemap relative to the main URL. Default: '`sitemap.xml`'.
    40     ignore_users:: Do not include wiki pages created by the listed users. Default: `trac` (excludes all standard Trac wiki pages).
    41     ignore_wikis:: Do not include the following wikis. The wildcards '`*`' and '`?`' are allowed and have there usual meaning.
    42     list_realms::  Which realms (i.e. `wiki` or `ticket`) to list. Default: `wiki,ticket`.
    43     change_frequency:: Change frequency for all entries. Valid values: always, hourly, daily, weekly, monthly, yearly, never. Disabled if empty (default).
    44     compress_sitemap:: Compress sitemap, either by using HTTP gzip `content-encoding` if the client supports it (Googlebot does) or by requesting the sitemap with a trailing `.gz`.
    45     compression_level:: Compression level used: 0 (low/fast) to 9 (high/slow). Default: 6.
     58 sitemappath:: Path of the sitemap relative to the main URL. Default: `sitemap.xml`.
     59 ignore_users:: Do not include wiki pages created by the listed users. Default: `trac` (excludes all standard Trac wiki pages).
     60 ignore_wikis:: Do not include the following wikis. The wildcards '`*`' and '`?`' are allowed and have there usual meaning.
     61 list_realms::  Which realms (i.e. `wiki` or `ticket`) to list. Default: `wiki,ticket`.
     62 change_frequency:: Change frequency for all entries. Valid values: always, hourly, daily, weekly, monthly, yearly, never. Disabled if empty (default).
     63 compress_sitemap:: Compress sitemap, either by using HTTP gzip `content-encoding` if the client supports it (Googlebot does) or by requesting the sitemap with a trailing `.gz`.
     64 compression_level:: Compression level used: 0 (low/fast) to 9 (high/slow). Default: 6.
    4665
    4766The notifier can be told on which action Google should be notified about the sitemap change:
    4867
    49     notifyon:: List of actions on which Google should be notified. The action names are based on the Trac permissions needed to execute the actions.
     68 notifyon:: List of actions on which Google should be notified. The action names are based on the Trac permissions needed to execute the actions.
    5069               Supported actions are: TICKET_CREATE, TICKET_DELETE, TICKET_MODIFY, WIKI_CREATE, WIKI_DELETE, WIKI_VERSION_DELETE, WIKI_MODIFY, WIKI_RENAME.
    5170               By default Google will be notified when a ticket or wiki is created or modified, but not when it is deleted.
    5271               Default: TICKET_CREATE, TICKET_MODIFY, WIKI_CREATE, WIKI_VERSION_DELETE, WIKI_MODIFY, WIKI_RENAME.
    5372
    54 
    55 
    56 == Bugs/Feature Requests ==
    57 
    58 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&version=0.11 new ticket].
    59 
    60 == Download ==
    61 
    62 Download the zipped source from [download:googlesitemapplugin here].
    63 
    64 == Source ==
    65 
    66 You 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.
    67 
    68 == Example ==
     73== Example
    6974
    7075This is how a sitemap XML could look like:
    7176
    72 {{{
    73 #!xml
     77{{{#!xml
    7478<?xml version="1.0" encoding="UTF-8"?>
    7579<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
    … …  
    9195More about the document format can be found [https://www.google.com/webmasters/sitemaps/docs/en/protocol.html here].
    9296
    93 == Recent Changes ==
     97== Recent Changes
    9498
    9599[[ChangeLog(googlesitemapplugin, 3)]]
    96100
    97 == Author/Contributors ==
     101== Author/Contributors
    98102
    99103'''Author:''' [wiki:martin_s] (Trac 0.11), [wiki:datenimperator] (Trac 0.10) [[BR]]
    100 '''Maintainer:''' [wiki:martin_s] [[BR]]
     104'''Maintainer:''' [[Maintainer]] [[BR]]
    101105'''Contributors:'''