The sitemap module provides capability to render sitemaps for a given site using XML format standards. This module also provides the capability to submit the generated sitemap to search engines through a scheduled job for a given specified frequency.
Once sitemap is enabled for a given site, the sitemap module provides a sitemap index located in <site>/sitemap.xml linking to
different sitemap-lang.xml views that the module provides. This includes sitemaps for each available languages as well as dedicated
sitemaps for certain resources.
Each of the sitemap-lang.xml views lists all resources of type jnt:page and jmix:mainResource(which we will call sitemap resources)
for their given subnodes. Sitemap resources can be excluded by enabling No index option for that resource. In addition, sitemap
resources can also have its own dedicated sitemap-lang.xml view that lists all sitemap resources within that subnode. This list will then
get added automatically to the main sitemap.xml. This is useful for managing the size and organization of available sitemaps.
For each sitemap resource included in the sitemap-lang.xml:
- Add
<url>entry with the given URL specified in<loc>that is UTF-8 encoded and entity-escaped. - Each URL entry will have last modified date
<lastmod>in W3C format. - Default vanity URL will be used for a given sitemap resource if it exists.
- Alternate language URLs will also be included (including default language) using
<xhtml:link rel="alternate">tag.
Sitemap includes only resources that have default guest privileges in the list.
The submission of your sitemap can be done automatically by UI in "Additional" -> "Sitemap". There's cfg file
located at ${jahia.deploy.targetServerDirectory}/digital-factory-data/karaf/etc called org.jahia.modules.sitemap.config.impl.ConfigServiceImpl.cfg.
# Comma separated values
sitemap.search-engines=http://www.google.com/webmasters/tools/ping?sitemap=
# comma separated values
sitemap.included-content-types=jnt:page,jmix:mainResource,jmix:sitemap
At the moment, the configuration has 2 keys.
- List of Search engines
- List of included content types
This is a comma-separated value of the list of search engines to use by the sitemap UI submission.
This value determines how often to remove and refresh the file cache for sitemap-lang.xml contents specified in hours. Cache expiration defaults to null if not activated on the UI.
On UI, the user will specify the cache duration and "Flush Cache".
This is a comma-separated value of the list of urls to send to the search engine(s).
Note: If the value of sitemap.search-engines or sitemap.sitemap-urls is empty, the "Submit to Google" UI function will not work.
For each search engine, you will have to follow their policy. For example on Google, they ask that for the first time you manually register you sitemap using their webmaster tools (to follow what happens and have feedback in your Google environment).
The sitemap.tld has been updated functions to get the configurations. To use them, simply use JSP syntax. For example:
Search engines: ${sitemap:getSearchEngines()}
Included Content Types: ${sitemap:getIncludedContentTypes()}On Jahia >= 8.0.3 migration should happen automatically provided that you have previous version of the module installed.
If you would like to migrate on Jahia version < 8.0.3 then you can use the groovy script provided in META-INF/patches/groovy folder.
Simply copy and paste the contents of the file into groovy console in the tools section.
Note that migration will remove jnt:sitemap nodes and remove jmix:sitemap mixins from every site sitemap module is deployed on. Migration script will mark all
jnt:page and jnt:content nodes, which were not previously marked with jmix:sitemap with jseomix:sitemapResource with noIndex option set to true in
order to preserve original functionality as much as possible.
Also note that manual revision and publication of your site after migration will still be required.