Commit 09d8c9d7 authored by gbyte.co's avatar gbyte.co

Fix documentation

parent 2de27ef6
......@@ -70,13 +70,13 @@ If you wish for the sitemap to reflect the new configuration instantly, check
'Regenerate sitemaps after clicking save'. This setting only appears if a change
in the settings has been detected.
As the sitemap is accessible to anonymous users, bear in mind that only links
As the sitemaps are accessible to anonymous users, bear in mind that only links
will be included which are accessible to anonymous users. There are no access
checks for links added through the module's hooks (see below).
### CUSTOM LINKS ###
To include custom links into the sitemap, visit
To include custom links into a sitemap, visit
/admin/config/search/simplesitemap/custom.
### SETTINGS ###
......@@ -128,7 +128,6 @@ programmatic sitemap generation. These include:
* setBundleSettings
* getBundleSettings
* removeBundleSettings
* supplementDefaultSettings
* setEntityInstanceSettings
* getEntityInstanceSettings
* removeEntityInstanceSettings
......@@ -164,9 +163,9 @@ $generator
->saveSetting('remove_duplicates', TRUE)
->enableEntityType('node')
->setVariants(['default', 'test'])
->setBundleSettings('node', 'page', ['index' => TRUE, 'priority' = 0.5])
->setBundleSettings('node', 'page', ['index' => TRUE, 'priority' => 0.5])
->removeCustomLinks()
->addCustomLink('/some/view/page', ['priority' = 0.5])
->addCustomLink('/some/view/page', ['priority' => 0.5])
->generateSitemap();
```
......@@ -189,13 +188,13 @@ use of `hook_simple_sitemap_attributes_alter(&$attributes){}` and
`hook_simple_sitemap_index_attributes_alter(&$index_attributes){}`.
Altering URL generators is possible through
the use of `hook_simple_sitemap_url_generators_alter(&$generators){}`.
the use of `hook_simple_sitemap_url_generators_alter(&$url_generators){}`.
Altering sitemap generators is possible through
the use of `hook_simple_sitemap_sitemap_generators_alter(&$generators){}`.
the use of `hook_simple_sitemap_sitemap_generators_alter(&$sitemap_generators){}`.
Altering sitemap types is possible through
the use of `hook_simple_sitemap_sitemap_types_alter(&$generators){}`.
the use of `hook_simple_sitemap_sitemap_types_alter(&$sitemap_types){}`.
### WRITING PLUGINS ###
......
name: 'Simple XML Sitemap'
type: module
description: 'Creates a standard conform hreflang XML sitemap of the site content and provides a framework for developing other sitemap types.'
description: 'Generates standard conform hreflang XML sitemaps of the site content and provides a framework for developing other sitemap types.'
configure: simple_sitemap.settings
package: SEO
core: 8.x
......@@ -224,16 +224,15 @@ class Simplesitemap {
}
/**
* Returns the whole sitemap, a requested sitemap chunk,
* or the sitemap index file.
* Returns a sitemap variant, its index, or its requested chunk.
*
* @param int $delta
*
* @return string|false
* If no sitemap delta is provided, either a sitemap index is returned, or the
* whole sitemap variant, if the amount of links does not exceed the max
* links setting. If a sitemap delta is provided, a sitemap chunk is returned.
* Returns false if the sitemap is not retrievable from the database.
* If no chunk delta is provided, either the sitemap variant is returned,
* or its index in case of a chunked sitemap.
* If a chunk delta is provided, the relevant chunk is returned.
* Returns false if the sitemap variant is not retrievable from the database.
*/
public function getSitemap($delta = NULL) {
$chunk_info = $this->fetchSitemapVariantInfo();
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment