X-Git-Url: http://www.aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fmodules%2Fcontrib%2Fsimple_sitemap%2FREADME.md;fp=web%2Fmodules%2Fcontrib%2Fsimple_sitemap%2FREADME.md;h=8fa99602ed5fb48dfb6a0efe6f5ff0678ed139d8;hb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;hp=0000000000000000000000000000000000000000;hpb=57c063afa3f66b07c4bbddc2d6129a96d90f0aad;p=yaffs-website

diff --git a/web/modules/contrib/simple_sitemap/README.md b/web/modules/contrib/simple_sitemap/README.md
new file mode 100644
index 000000000..8fa99602e
--- /dev/null
+++ b/web/modules/contrib/simple_sitemap/README.md
@@ -0,0 +1,122 @@
+CONTENTS OF THIS FILE
+---------------------
+
+ * Introduction
+ * Installation
+ * Configuration
+ * Usage
+ * Extending the module
+ * 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 most of Drupal's
+content entity types including:
+
+ * nodes
+ * taxonomy terms
+ * menu links
+ * users
+ * ...
+
+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.
+
+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 /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.
+
+ * /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
+ * ...
+
+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
+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 (e.g. node/1/edit) to
+override its sitemap settings.
+
+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
+-----
+
+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'.
+
+
+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.
+
+
+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
+ * Sam Becker (Sam152) - https://www.drupal.org/u/sam152