MINOR: updated documentation with content from wiki. Fixed syntax error in comments which threw apidocs off

This commit is contained in:
Will Rossiter 2011-04-26 21:17:49 +12:00
parent ef019199c4
commit c62538a860
3 changed files with 28 additions and 7 deletions

View File

@ -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

View File

@ -2,8 +2,7 @@
## Maintainer Contact
* Will Rossiter (Nickname: <wrossiter, willr>)
<will@silverstripe.com>
* Will Rossiter (Nickname: wrossiter, willr) <will@silverstripe.com>
## 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();

View File

@ -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>
*