From c62538a86018b5650c728e19aa2045379b0e0a64 Mon Sep 17 00:00:00 2001 From: Will Rossiter Date: Tue, 26 Apr 2011 21:17:49 +1200 Subject: [PATCH] MINOR: updated documentation with content from wiki. Fixed syntax error in comments which threw apidocs off --- LICENSE | 2 +- README.md | 31 ++++++++++++++++++++++++++----- code/GoogleSitemap.php | 2 +- 3 files changed, 28 insertions(+), 7 deletions(-) diff --git a/LICENSE b/LICENSE index e6bcfb1..0a01933 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -* Copyright (c) 2008, Silverstripe Ltd. +* Copyright (c) 2011, Silverstripe Ltd. * All rights reserved. * * Redistribution and use in source and binary forms, with or without diff --git a/README.md b/README.md index 9d42b85..fc399fb 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ ## Maintainer Contact - * Will Rossiter (Nickname: ) - + * Will Rossiter (Nickname: wrossiter, willr) ## Requirements @@ -11,9 +10,31 @@ ## Documentation - * http://doc.silverstripe.com/doku.php?id=modules:googlesitemaps +SilverStripe provides support for the Google Sitemaps XML system, enabling +Google and other search engines to see all pages on your site. This helps +your SilverStripe website rank well in search engines, and to encourage the +information on your site to be discovered by Google quickly. -## Installation Instructions +Therefore, all Silverstripe websites contain a special controller which can +be visited: http://yoursite.com/sitemap.xml - * See http://doc.silverstripe.org/modules#installation +See http://en.wikipedia.org/wiki/Sitemaps for info on this format +In addition, whenever you publish a new or republish an existing page, +SilverStripe automatically informs Google of the change, encouraging a Google +to take notice. If you install the SilverStripe Google Analytics module, you +can see if Google has updated your page as a result. + +By default, SilverStripe informs Google that the importance of a page depends +on its position of in the sitemap. "Top level" pages are most important, and +the deeper a page is nested, the less important it is. (For each level, +Importance drops from 1.0, to 0.9, to 0.8, and so on, until 0.1 is reached). + +In the CMS, in the "Content/GoogleSitemap" tab, you can set the page importance +manually, including requesting to have the page excluded from the google sitemap. + +### Setup automatic pinging + + GoogleSitemap::enable_google_notificaton(); + + diff --git a/code/GoogleSitemap.php b/code/GoogleSitemap.php index 9ca7712..8f61704 100644 --- a/code/GoogleSitemap.php +++ b/code/GoogleSitemap.php @@ -11,7 +11,7 @@ * sitemap whenever the GoogleBot visits your website. * * Enabling notification of Google after every publish (in your _config.php): - * * GoogleSitemap::enable_google_notificaton(); * *