README.md 5.3 KB
Newer Older
1 2 3 4 5 6 7
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Configuration
 * Usage
8
 * Extending the module
9 10 11 12 13 14 15 16 17 18
 * How Can You Contribute?
 * Maintainers


INTRODUCTION
------------

Author and maintainer: Pawel Ginalski (gbyte.co) https://www.drupal.org/u/gbyte.co

The module generates a multilingual XML sitemap which adheres to Google's new
19 20
hreflang standard. Out of the box the sitemap is able to index most of Drupal's
content entity types including:
21 22 23 24 25

 * nodes
 * taxonomy terms
 * menu links
 * users
26 27 28 29
 * ...

Contributed entity types like commerce products or media entities can be indexed
as well. On top of that custom links can be added to the sitemap.
30 31 32 33 34

To learn about XML sitemaps, see https://en.wikipedia.org/wiki/Sitemaps.


INSTALLATION
gbyte.co's avatar
gbyte.co committed
35
------------
36 37 38 39 40 41

See https://www.drupal.org/documentation/install/modules-themes/modules-8
for instructions on how to install or update Drupal modules.


CONFIGURATION
gbyte.co's avatar
gbyte.co committed
42
-------------
43 44 45 46 47

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
48 49 50
the sitemap, visit /admin/config/search/simplesitemap/entities to enable support
for entity types of your choosing. Entity types which feature bundles can then
be configured on a per-bundle basis, e.g.
51

52 53 54 55
 * /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
 * ...
56

57 58
When including an entity type or bundle into the sitemap, the priority setting
can be set which will set the 'priority' parameter for all entities of that
gbyte.co's avatar
gbyte.co committed
59 60 61
type. Same goes for the 'changefreq' setting. All Images referenced by the
entities can be indexed as well. See https://en.wikipedia.org/wiki/Sitemaps to
learn more about these parameters.
62

63
Inclusion settings of bundles can be overridden on a per-entity
64 65
basis. Just head over to a bundle instance edit form (e.g. node/1/edit) to
override its sitemap settings.
gbyte.co's avatar
gbyte.co committed
66

67 68 69 70 71
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.

As the sitemap is accessible to anonymous users, bear in mind that only links
gbyte.co's avatar
gbyte.co committed
72 73
will be included which are accessible to anonymous users. There are no access
checks for links added through the module's hooks (see below).
74 75 76 77 78 79 80 81 82

To include custom links into the sitemap, visit
/admin/config/search/simplesitemap/custom.

The settings page can be found under admin/config/search/simplesitemap.
Here the module can be configured and the sitemap can be manually regenerated.


USAGE
gbyte.co's avatar
gbyte.co committed
83
-----
84 85 86

The sitemap is accessible to the whole world under /sitemap.xml.

gbyte.co's avatar
gbyte.co committed
87 88 89
If the cron generation is turned on, the sitemap will be regenerated according
to the 'Sitemap generation interval' setting ranging from 'On every cron run' to
'Once a week'.
90 91 92 93 94 95 96

A manual generation is possible on admin/config/search/simplesitemap.

The sitemap can be also generated via drush: Use the command
'drush simple_sitemap-generate'.


gbyte.co's avatar
gbyte.co committed
97 98 99 100 101
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
gbyte.co's avatar
gbyte.co committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
link array shortly before it is transformed to XML.

Adding arbitrary links is possible through the use of
hook_simple_sitemap_arbitrary_links_alter(&$arbitrary_links){}. There are no
checks performed on these links (i.e. if they are internal/valid/accessible)
and parameters like priority/lastmod/changefreq have to be added manually.

Altering sitemap attributes and sitemap index attributes is possible through the
use of hook_simple_sitemap_attributes_alter(&$attributes){} and
hook_simple_sitemap_index_attributes_alter(&$index_attributes){}.

There are API methods for altering stored inclusion settings, status queries and
programmatic sitemap generation. These include:

 * getSetting()
 * saveSetting()
 * getSitemap()
 * generateSitemap()
 * getGeneratedAgo()
 * enableEntityType()
 * disableEntityType()
 * setBundleSettings()
 * getBundleSettings()
 * setEntityInstanceSettings()
 * getEntityInstanceSettings()
 * removeEntityInstanceSettings()
 * bundleIsIndexed()
 * entityTypeIsEnabled()
 * addCustomLink()
 * getCustomLinks()
 * getCustomLink()
 * removeCustomLink()
 * removeCustomLinks()

These service methods can be chained like so:

\Drupal::service('simple_sitemap.generator')
  ->saveSetting('remove_duplicates', TRUE)
  ->enableEntityType('node')
  ->setBundleSettings('node', 'page', ['index' => TRUE, 'priority' = 0.5])
  ->removeCustomLinks()
  ->addCustomLink('/some/view/page', ['priority' = 0.5])
  ->generateSitemap();
gbyte.co's avatar
gbyte.co committed
145 146


147 148 149
HOW CAN YOU CONTRIBUTE?
-----------------------

150 151
 * Report any bugs, feature or support requests in the issue tracker, if
   possible help out by submitting patches.
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
   http://drupal.org/project/issues/simple_sitemap

 * Do you know a non-English language? Help translating the module.
   https://localize.drupal.org/translate/projects/simple_sitemap

 * If you would like to say thanks and support the development of this module, a
   donation is always appreciated.
   https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5AFYRSBLGSC3W


MAINTAINERS
-----------

Current maintainers:
 * Pawel Ginalski (gbyte.co) - https://www.drupal.org/u/gbyte.co