=== Kocuj Sitemap ===
Contributors: domko
Donate link: http://kocujsitemap.wpplugin.kocuj.pl
Tags: sitemap, menus, menus list, pages, pages list, posts, posts list
Requires at least: 2.8.0
Tested up to: 3.6
Stable tag: 1.1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Plugin for creating a sitemap and placing it in article or anywhere else. It provides also sitemap caching for better performance.

== Description ==

This plugin adds shortcode `[KocujSitemap]` which will place a sitemap.
This is automatically generated into cache to avoid any delay during the website loading.

This shortcode has some optional parameters:
* class - this class will be added to block element which contains the entire sitemap
* title - this value will be placed as title of the main site

For example, if you will add:
`[KocujSitemap class="new_class" title="NEW TITLE"]`
then sitemap will be in block element with class `new_class` and the title of the link to the main site will be `NEW TITLE`.

You can also use global function anywhere in your PHP code. This function is defined as:
function kocujsitemap_show_sitemap($title = '', $class = '')
where `title` and `class` are the same parameters as in the shortcode.
For example, if you will add:
kocujsitemap_show_sitemap('NEW TITLE', 'new_class')
then sitemap will be in block element with class `new_class` and the title of the link to the main site will be `NEW TITLE`.

A developer of another plugin or simply a theme can also set filters which will change some behaviour of the plugin. There are the following filters available:
* kocujsitemap_defaultclass - default class which will be used by plugin when there will be no shortcode parameter `class` used
* kocujsitemap_defaultmenus - default menus which will be used by plugin when the settings field `menus list` will be empty (only for WordPress 3.0 and newer)
* kocujsitemap_defaulttitle - default title which will be used by plugin when there will be no shortcode parameter `title` used
* kocujsitemap_firstclass - class which will be used by plugin when there will be first position on sitemap list
* kocujsitemap_linktitle - filter for modifications of links titles in sitemap
* kocujsitemap_menuelement - filter one element from menu selected for displaying in sitemap - returned value will be added to item

== Installation ==

This section describes how to install the plugin and get it working.

1. Upload all files to the `/wp-content/plugins/kocuj-sitemap` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Configure in `Sitemap` option in administration panel
4. Add shortcode `[KocujSitemap]` in the selected page or post where you want to show your sitemap

== Changelog ==

= 1.1.0 =
* Add plugin help to administration panel.
* Check and correct any problems with readme.txt for correct displaying information on wordpress.org repository.

= 1.0.0 =
* First version of plugin.
