<commit_before>The sitemap module for Zend Framework 2
==============

INSTALL
=======

The recommended way to install is through composer.

```json
{
    "require": {
        "enlitepro/enlite-sitemap": "1.0.*"
    }
}
```

USAGE
=====

Add `EnliteSitemap` to your `config/application.config.php` to enable module.

Static urls you can added to the navigation in section "sitemap".

For dynamic urls you need:

1. Add implementation EnliteSitemap\Navigation\DynamicPagesInterface to any service. This service
must be available for get with help the service locator.
2. Add a key of the service to

```php
[
    'EnliteSitemap' => [
            'common' => [
                'dynamic_pages' => [
                    'YouService'
                ],
            ],
        ],
]
```

Configure
=========

For example config:

```php
[
    'EnliteSitemap' => [
            'common' => [
                // The name site map or site map index (if some files)
                'index_file' => 'sitemap.xml',
                // The name of site map. Use when a site map is some files
                'non_index_file' => 'sitemap%d.xml',
                'public_path' => 'public',
                'limit_url_in_file' => 50000,
                'dynamic_pages' => [],
            ],
            // URL for all links in site map
            'url' => [
                'host' => 'my.site.com',
                'port' => 80,
                'scheme' => 'http',
            ]
        ],
]
```<commit_msg>Add a notice to readme<commit_after>The sitemap module for Zend Framework 2
==============

INSTALL
=======

The recommended way to install is through composer.

```json
{
    "require": {
        "enlitepro/enlite-sitemap": "1.0.*"
    }
}
```

USAGE
=====

Add `EnliteSitemap` to your `config/application.config.php` to enable module.

Static urls you can added to the navigation in section "sitemap".

For dynamic urls you need:

1. Add implementation EnliteSitemap\Navigation\DynamicPagesInterface to any service. This service
must be available for get with help the service locator.
2. Add a key of the service to

```php
[
    'EnliteSitemap' => [
            'common' => [
                'dynamic_pages' => [
                    'YouService'
                ],
            ],
        ],
]
```

Configure
=========

For example config:

```php
[
    'EnliteSitemap' => [
            'common' => [
                // The name site map or site map index (if some files)
                'index_file' => 'sitemap.xml',
                // The name of site map. Use when a site map is some files
                'non_index_file' => 'sitemap%d.xml',
                'public_path' => 'public',
                'limit_url_in_file' => 50000,
                'dynamic_pages' => [],
            ],
            // URL for all links in site map
            'url' => [
                'host' => 'my.site.com',
                'port' => 80,
                'scheme' => 'http',
            ]
        ],
]
```

Notice
======

For create Zend\Navigation\Page\Mvc, we recommend use
EnliteSitemap\Service\SitemapService::factoryMVCPage()
{'fraction_non_alphanumeric': 0.13753213367609254, 'fraction_numerical': 0.007712082262210797, 'mean_word_length': 1.7769848349687778, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 31, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 4}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4241807', 'n_tokens_mistral': 983, 'n_tokens_neox': 905, 'n_words': 274}