README.txt 3.42 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Configuration
 * Usage
 * 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
hreflang standard. Out of the box the sitemap is able to index the following
content:

 * nodes
 * taxonomy terms
 * menu links
 * users
 * custom links
26 27
 * commerce products
 * possibly other contributed entities
28 29 30 31 32

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


INSTALLATION
gbyte.co's avatar
gbyte.co committed
33
------------
34 35 36 37 38 39

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
40
-------------
41 42 43 44 45

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
gbyte.co's avatar
gbyte.co committed
46
the sitemap, visit the corresponding entity bundle edit pages, e.g.
47 48 49 50 51 52

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

gbyte.co's avatar
gbyte.co committed
53 54
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
55 56
https://en.wikipedia.org/wiki/Sitemaps to learn more about this parameter.

gbyte.co's avatar
gbyte.co committed
57 58
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
59
the bundle settings there.
gbyte.co's avatar
gbyte.co committed
60

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
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
will be included which are accessible to anonymous users.

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
76
-----
77 78 79 80 81 82 83 84 85 86 87 88

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

If the cron generation is turned on, the sitemap will be regenerated on every
cron run.

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
89 90 91 92 93 94 95 96
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.


97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
HOW CAN YOU CONTRIBUTE?
-----------------------

 * Report any bugs, feature or support requests in the issue tracker, if possible
   help out by submitting patches.
   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