Browse files

MINOR: updated documentation with content from wiki. Fixed syntax err…

…or in comments which threw apidocs off
  • Loading branch information...
wilr committed Apr 26, 2011
1 parent ef01919 commit c62538a86018b5650c728e19aa2045379b0e0a64
Showing with 28 additions and 7 deletions.
  1. +1 −1 LICENSE
  2. +26 −5
  3. +1 −1 code/GoogleSitemap.php
@@ -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
@@ -2,18 +2,39 @@
## Maintainer Contact
- * Will Rossiter (Nickname: <wrossiter, willr>)
- <>
+ * Will Rossiter (Nickname: wrossiter, willr) <>
## Requirements
* SilverStripe 2.4
## Documentation
- *
+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:
- * See
+See 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();
@@ -11,7 +11,7 @@
* sitemap whenever the GoogleBot visits your website.
* Enabling notification of Google after every publish (in your _config.php):
- * <example
+ * <example>
* GoogleSitemap::enable_google_notificaton();
* </example>

0 comments on commit c62538a

Please sign in to comment.