Cyclone3 Skin

Creating sitemap

From Cyclone3 Wiki


Create sitemap in Cyclone3 XULadmin

Sitemap is the basic structure of your web. Each sitemap item is assigned a unique URL such as example.tld/contact, example.tld/company/about-us etc. You can create it in Cyclone3 XULadmin, as it is considered a part of site content.

To create a sitemap, log into XULadmin with admin account or other account with unlimited permissions. Don't forget to choose right language when creating multilanguage site because sitemap is separate for each language mutation. Rollout the Administration part on the left, right-click on Sitemap node and choose New item. Then enter the name of desired part of your site (e.g. About us, Projects, Gallery, Contact, etc..) and repeat as needed.

You should immediately see your item in the listing (if not, right-click on Sitemap node and choose Reload). Notice two other rows next to the name of sitemap items with eye and crossed circle sign. Eye icon stands for visibility: If you don't want the sitemap item to be shown in sitemap listings for various reasons, you can simply uncheck this row. The item will remain available trough it's URL address. The crossed circle stands for status: enabled/disabled. Use it if you want to temporarily disable part of your site. In addition to invisible item, it will be inaccessible by any means until you decide to enable it again.

Sitemap structure is often multi-level. It means that some items may involve subitems and they may involve deeper subitems etc... This can be easily done by right-clicking on desired parent item and choosing New item the same way as for root sitemap items. Arrow on the left side of item name rolls out a list of child items.

Nice feature is that you can change the order of the items. It can be done by right clicking on item and choosing Move up or Move down. Also you should set one of the items as default - it will be the landing page of your site when visitor browse site's root domain.

Assigning service type to sitemap item

But how to 'tell' Cyclone3 what content should be displayed under particular item? This is done by assigning a service type. Right click on the item and choose Edit. Under service type dropdown menu you can choose from types defined in type.conf. These can be types like 'article list' for blog posts listing, 'contact' to display contact form, 'image category list' for galleries list etc...

Configuration keys

In most cases, you should also define particular articles or article categories to list, galleries, images, users... You can 'tell' Cyclone3 which item/category to show trough configuration key. Configuration keys are listed in the large field under service type dropdown.

The most typical usage of configuration key is to create an ordinary 'static page' (e.g. 'About us' section - a HTML page with content which is not intended to be frequently changed or being irrelevant after a time). The easiest way to achieve this is to use 'article view' type with defined configuration key. In this case, the configuration key will be a specific article, defined trough it's unique ID number. Just create an article, edit an sitemap item, choose the 'article' service type (predefined in example.tld) and click on the small list icon in configuration key with description 'ID of article'. Then you can easily navigate to your test article, select it and save the sitemap item. Go on this item on your page (in example.tld, you should see items from sitemap in right menu) and see the result.

Remember this is not the only usage of configuration keys. It's a strong tool that gives you great flexibility in website development. They're useful also to give a limited control over the site to it's editors, who doesn't need to bother designers to edit code for minor changes.

More about using and defining configuration keys can be found here: Add a configuration key to servicetype

Other sitemap related tips

  • You can link sitemap pages from article editor. This is important when you later decide to edit sitemap name - you won't need to change every mention of the page. Also it's more comfortable to select it from menu than to copy paste URL. Give this tip to content editors of your site.
  • When you need to link to one page more than one time (e.g. from main navigation and from footer), avoid making multiple items with the same service type (and/or configuration keys), but rather use redirect service type. You don't want to have two pages like http://example.tld/contact and http://example.tld/footer/contact with the same content. This is mostly recommended by search engines.