User Guide

Configuring the eeSiteKit Sitemap

eeSiteKit comes with a default sitemap template that will produce a simple two-column sitemap like this one.

Before you get started, write down a list of all your website’s Channel Short Names as you’ll need those handy (or you can do what we do, we take a quick screen shot of the list so we can drag it around on our desk top; see our list below):

Site Name ›  Admin ›  Channel Administration ›  Channel Management

Channels List

  1. Once you have your list of Channels, click on the Templates tab and open up the template “kit_display/sitemap”.
  2. About halfway down in the template code you will see five sample embed tags that look like this:
    3. {embed='kit_language/{embed:site_language}' template='kit_system/engine_sitemap' weblog='CHANNEL_NAME'}

  3. Being careful not to delete the single quotes, replace the words ‘CHANNEL_NAME’ with the short name of one of your Channels as we have in this example below:
    4. {embed='kit_language/{embed:site_language}' template='kit_system/engine_sitemap' weblog='about-us'}

  4. Each embed tag dynamically handles the landing page and/or category links for a whole Channel; building your dynamic site directory. You’ll want to set up one embed tag like this for each Channel of your site you want added to your sitemap. You can have as few or as many as you like/need for your site. If you have a Channel that you want left out of the sitemap, don’t create a tag for it. Also, be sure and remove any leftover default tags once you’ve listed all your Channels. Below is an example of the tags used for the site directory in this website’s sitemap:
  5. When all you embed tags are created/edited, click Update
    6. 
	<div class="subcolumns">
		<div class="c50l">
			<div class="subcl">{!-- left content block --}
				<ul>
					<li class='home-landing'><a href='&123;global_url}' &123;if segment_1 == ''}class='selected'&123;/if}>{embed:lang_home}</a></li>
					{embed='kit_language/{embed:site_language}' template='kit_system/engine_sitemap' weblog='features'}
					{embed='kit_language/{embed:site_language}' template='kit_system/engine_sitemap' weblog='products'}
				</ul>
			</div>{!-- END SUBCL --}
		</div>{!-- END C50L --}
		<div class="c50r">
			<div class="subcr">{!-- right content block --}
				<ul>
					{embed='kit_language/{embed:site_language}' template='kit_system/engine_sitemap' weblog='user-guide'}
					{embed='kit_language/{embed:site_language}' template='kit_system/engine_sitemap' weblog='about-us'}
				</ul>
			</div>{!-- END SUBCR --}
		</div>{!-- END C50CR --}
	</div>{!-- END SUBCOLUMNS --}

Cut and Paste this code example into your favorite text editor and it won't look so squished. We ran out of space here for this example.

  6. Tip: If you want the weblog links of your site directory displayed in a different order, just change the order of the tags in the “directory” template, and the order will be changed in your display.

If you are using the “Pages” module to achieve custom URIs for some of the content in your site, you’ll need to consider how those pages will work (or not) in your sitemap. We don’t have specific recommendations for this at this time.