Commit e1987985 authored by gbyte.co's avatar gbyte.co

Altering README.txt.

parent 8136913f
......@@ -31,30 +31,34 @@ To learn about XML sitemaps, see https://en.wikipedia.org/wiki/Sitemaps.
INSTALLATION
----------
------------
See https://www.drupal.org/documentation/install/modules-themes/modules-8
for instructions on how to install or update Drupal modules.
CONFIGURATION
----------
-------------
The module permission 'administer sitemap settings' can be configured under
/admin/people/permissions.
Initially only the home page is indexed in the sitemap. To include content into
the sitemap, visit the corresponding entity type edit pages, e.g.
the sitemap, visit the corresponding entity bundle edit pages, e.g.
* /admin/structure/types/manage/[content type] for nodes,
* /admin/structure/taxonomy/manage/[taxonomy vocabulary] for taxonomy terms,
* /admin/structure/menu/manage/[menu] for menu items,
* /admin/config/people/accounts for users
When including an entity type into the sitemap, the priority setting can be set
which will set the 'priority' parameter for all entities of that type. See
When including an entity bundle into the sitemap, the priority setting can be
set which will set the 'priority' parameter for all entities of that type. See
https://en.wikipedia.org/wiki/Sitemaps to learn more about this parameter.
Inclusion and priority settings of bundles can be overridden on a per-entity
basis. Just head over to a bundle instance edit form (node/1/edit) and override
the bundle settings there. ATM this only works for nodes and taxonomy terms.
If you wish for the sitemap to reflect the new configuration instantly, check
'Regenerate sitemap after clicking save'. This setting only appears if a change
in the settings has been detected.
......@@ -70,7 +74,7 @@ Here the module can be configured and the sitemap can be manually regenerated.
USAGE
----------
-----
The sitemap is accessible to the whole world under /sitemap.xml.
......@@ -83,6 +87,26 @@ The sitemap can be also generated via drush: Use the command
'drush simple_sitemap-generate'.
EXTENDING THE MODULE
--------------------
It is possible to hook into link generation by implementing
hook_simple_sitemap_links_alter(&$links){} in a custom module and altering the
link array.
Need to support a non-core entity type? In case you would like to support an
entity type provided by a contrib module:
* Create a feature request in simple_sitemap's issue queue and submit a plugin
(as patch), or wait until a patch is submitted by the community or a
maintainer.
* As soon as a patch is found working, create an issue in the contrib module's
queue and submit a slightly altered patch created against that module.
* Link the contrib module's issue on the simple_sitemap issue created earlier.
HOW CAN YOU CONTRIBUTE?
-----------------------
......
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