Commit 6ea2c151 authored by gbyte.co's avatar gbyte.co

Adding help section, README.TXT and a donnation link.

parent 8eb743c3
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
The above functionalities are implemented as Drupal 8 plugins and it is easy to
add support to custom entity types through implementing your own plugins.
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.
* /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
https://en.wikipedia.org/wiki/Sitemaps to learn more about this parameter.
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'.
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
......@@ -7,6 +7,14 @@
use Drupal\simple_sitemap\Simplesitemap;
use Drupal\simple_sitemap\SitemapGenerator;
/**
* Implements hook_help.
*/
function simple_sitemap_help($route_name, \Drupal\Core\Routing\RouteMatchInterface $route_match) {
return $route_name === 'help.page.simple_sitemap' ?
check_markup(file_get_contents(dirname(__FILE__) . "/README.txt")) : NULL;
}
/**
* Implements hook_form_alter.
*
......
......@@ -37,6 +37,8 @@ class SimplesitemapSettingsForm extends ConfigFormBase {
$sitemap = new Simplesitemap;
$form['simple_sitemap_settings']['#prefix'] = "<div class='description'>" .t("If you would like to say thanks and support the development of this module, a <a target='_blank' href='@url'>donation</a> is always appreciated.", array('@url' => 'https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5AFYRSBLGSC3W')) . "</div>";
$form['simple_sitemap_settings']['regenerate'] = array(
'#title' => t('Regenerate sitemap'),
'#type' => 'fieldset',
......
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