www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/simple_sitemap/README.md

   1 CONTENTS OF THIS FILE
   2 ---------------------
   3
   4  * Introduction
   5  * Installation
   6  * Configuration
   7  * Usage
   8  * Extending the module
   9  * How Can You Contribute?
  10  * Maintainers
  11
  12
  13 INTRODUCTION
  14 ------------
  15
  16 Author and maintainer: Pawel Ginalski (gbyte.co) https://www.drupal.org/u/gbyte.co
  17
  18 The module generates a multilingual XML sitemap which adheres to Google's new
  19 hreflang standard. Out of the box the sitemap is able to index most of Drupal's
  20 content entity types including:
  21
  22  * nodes
  23  * taxonomy terms
  24  * menu links
  25  * users
  26  * ...
  27
  28 Contributed entity types like commerce products or media entities can be indexed
  29 as well. On top of that custom links can be added to the sitemap.
  30
  31 To learn about XML sitemaps, see https://en.wikipedia.org/wiki/Sitemaps.
  32
  33
  34 INSTALLATION
  35 ------------
  36
  37 See https://www.drupal.org/documentation/install/modules-themes/modules-8
  38 for instructions on how to install or update Drupal modules.
  39
  40
  41 CONFIGURATION
  42 -------------
  43
  44 The module permission 'administer sitemap settings' can be configured under
  45 /admin/people/permissions.
  46
  47 Initially only the home page is indexed in the sitemap. To include content into
  48 the sitemap, visit /admin/config/search/simplesitemap/entities to enable support
  49 for entity types of your choosing. Entity types which feature bundles can then
  50 be configured on a per-bundle basis, e.g.
  51
  52  * /admin/structure/types/manage/[content type] for nodes
  53  * /admin/structure/taxonomy/manage/[taxonomy vocabulary] for taxonomy terms
  54  * /admin/structure/menu/manage/[menu] for menu items
  55  * ...
  56
  57 When including an entity type or bundle into the sitemap, the priority setting
  58 can be set which will set the 'priority' parameter for all entities of that
  59 type. See https://en.wikipedia.org/wiki/Sitemaps to learn more about this
  60 parameter.
  61
  62 Inclusion and priority settings of bundles can be overridden on a per-entity
  63 basis. Just head over to a bundle instance edit form (e.g. node/1/edit) to
  64 override its sitemap settings.
  65
  66 If you wish for the sitemap to reflect the new configuration instantly, check
  67 'Regenerate sitemap after clicking save'. This setting only appears if a change
  68 in the settings has been detected.
  69
  70 As the sitemap is accessible to anonymous users, bear in mind that only links
  71 will be included which are accessible to anonymous users.
  72
  73 To include custom links into the sitemap, visit
  74 /admin/config/search/simplesitemap/custom.
  75
  76 The settings page can be found under admin/config/search/simplesitemap.
  77 Here the module can be configured and the sitemap can be manually regenerated.
  78
  79
  80 USAGE
  81 -----
  82
  83 The sitemap is accessible to the whole world under /sitemap.xml.
  84
  85 If the cron generation is turned on, the sitemap will be regenerated on every
  86 cron run.
  87
  88 A manual generation is possible on admin/config/search/simplesitemap.
  89
  90 The sitemap can be also generated via drush: Use the command
  91 'drush simple_sitemap-generate'.
  92
  93
  94 EXTENDING THE MODULE
  95 --------------------
  96
  97 It is possible to hook into link generation by implementing
  98 hook_simple_sitemap_links_alter(&$links){} in a custom module and altering the
  99 link array.
 100
 101
 102 HOW CAN YOU CONTRIBUTE?
 103 -----------------------
 104
 105  * Report any bugs, feature or support requests in the issue tracker, if
 106    possible help out by submitting patches.
 107    http://drupal.org/project/issues/simple_sitemap
 108
 109  * Do you know a non-English language? Help translating the module.
 110    https://localize.drupal.org/translate/projects/simple_sitemap
 111
 112  * If you would like to say thanks and support the development of this module, a
 113    donation is always appreciated.
 114    https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5AFYRSBLGSC3W
 115
 116
 117 MAINTAINERS
 118 -----------
 119
 120 Current maintainers:
 121  * Pawel Ginalski (gbyte.co) - https://www.drupal.org/u/gbyte.co
 122  * Sam Becker (Sam152) - https://www.drupal.org/u/sam152