<commit_before>Sitemap Component
=================

[![Build Status](https://travis-ci.org/nilportugues/sitemap-component.png)](https://travis-ci.org/nilportugues/sitemap-component) [![Coverage Status](https://img.shields.io/coveralls/nilportugues/sitemap-component.svg)](https://coveralls.io/r/nilportugues/sitemap-component) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nilportugues/sitemap-component/badges/quality-score.png)](https://scrutinizer-ci.com/g/nilportugues/sitemap-component/) [![Latest Stable Version](https://poser.pugx.org/sonrisa/sitemap-component/v/stable.svg)](https://packagist.org/packages/sonrisa/sitemap-component) [![Total Downloads](https://poser.pugx.org/sonrisa/sitemap-component/downloads.svg)](https://packagist.org/packages/sonrisa/sitemap-component) [![License](https://poser.pugx.org/sonrisa/sitemap-component/license.svg)](https://packagist.org/packages/sonrisa/sitemap-component) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/b065a032-4ab2-4feb-a88c-d7a8423e1cf7/mini.png)](https://insight.sensiolabs.com/projects/b065a032-4ab2-4feb-a88c-d7a8423e1cf7)

Builds sitemaps for pages, images and media files and provides a class to submit them to search engines.

* [1.Installation](#block1)
* [2. Features](#block2)
* [3. Automatic sitemap submission](#block3)
* [4. Usage](#block4) 
    * [4.1. Submit to search engines](#block4.1)
    * [4.2. Build a Sitemap Index](#block4.2)
      * [Creation](#block4.2.1)
      * [Output](#block4.2.2)
    * [4.3. Build a simple Sitemap](#block4.3)
      * [Creation](#block4.3.1)
      * [Output](#block4.3.2)
    * [4.4. Build a Sitemap with Images](#block4.4)
      * [Creation](#block4.4.1)
      * [Output](#block4.4.2)
    * [4.5. Build a Sitemap with Videos](#block4.5)
      * [Creation](#block4.5.1)
      * [Output](#block4.5.2)
    * [4.6. Build a Media Sitemap (mRSS feed as a Sitemap)](#block4.6)
      * [Creation](#block4.6.1)
      * [Output](#block4.6.2)
    * [4.7 - Build a Sitemap for News](#block4.7)
      * [Creation](#block4.7.1)
      * [Output](#block4.7.2)
* [5. Fully tested](#block5)
* [6. Author](#block6)

---

<a name="block1"></a>
## 1.Installation
Add the following to your `composer.json` file :

```js
{
    "require": {
        "nilportugues/sitemap":"3.0.0"
    }
}
```

---

<a name="block2"></a>
## 2. Features
This component builds sitemaps supported by the main search engines, Google and Bing, in xml and gzip formats.

The **Sitemap Component** is able of building the following types of sitemaps:

#### Sitemap Index
A sitemap that serves as a index containing references to other sitemap.xml files. 
More documentation can be found [here](https://support.google.com/webmasters/answer/71453?hl=en).
<commit_msg>Removed references to sonrisa namespace.<commit_after>Sitemap Component
=================

[![Build Status](https://travis-ci.org/nilportugues/sitemap-component.png)](https://travis-ci.org/nilportugues/sitemap-component) [![Coverage Status](https://img.shields.io/coveralls/nilportugues/sitemap-component.svg)](https://coveralls.io/r/nilportugues/sitemap-component) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nilportugues/sitemap-component/badges/quality-score.png)](https://scrutinizer-ci.com/g/nilportugues/sitemap-component/) [![Latest Stable Version](https://poser.pugx.org/nilportugues/sitemap-component/v/stable.svg)](https://packagist.org/packages/nilportugues/sitemap-component) [![Total Downloads](https://poser.pugx.org/nilportugues/sitemap-component/downloads.svg)](https://packagist.org/packages/nilportugues/sitemap-component) [![License](https://poser.pugx.org/nilportugues/sitemap-component/license.svg)](https://packagist.org/packages/nilportugues/sitemap-component) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/b065a032-4ab2-4feb-a88c-d7a8423e1cf7/mini.png)](https://insight.sensiolabs.com/projects/b065a032-4ab2-4feb-a88c-d7a8423e1cf7)

Builds sitemaps for pages, images and media files and provides a class to submit them to search engines.

* [1.Installation](#block1)
* [2. Features](#block2)
* [3. Automatic sitemap submission](#block3)
* [4. Usage](#block4) 
    * [4.1. Submit to search engines](#block4.1)
    * [4.2. Build a Sitemap Index](#block4.2)
      * [Creation](#block4.2.1)
      * [Output](#block4.2.2)
    * [4.3. Build a simple Sitemap](#block4.3)
      * [Creation](#block4.3.1)
      * [Output](#block4.3.2)
    * [4.4. Build a Sitemap with Images](#block4.4)
      * [Creation](#block4.4.1)
      * [Output](#block4.4.2)
    * [4.5. Build a Sitemap with Videos](#block4.5)
      * [Creation](#block4.5.1)
      * [Output](#block4.5.2)
    * [4.6. Build a Media Sitemap (mRSS feed as a Sitemap)](#block4.6)
      * [Creation](#block4.6.1)
      * [Output](#block4.6.2)
    * [4.7 - Build a Sitemap for News](#block4.7)
      * [Creation](#block4.7.1)
      * [Output](#block4.7.2)
* [5. Fully tested](#block5)
* [6. Author](#block6)

---

<a name="block1"></a>
## 1.Installation
Add the following to your `composer.json` file :

```js
{
    "require": {
        "nilportugues/sitemap-component":"3.0.0"
    }
}
```

---

<a name="block2"></a>
## 2. Features
This component builds sitemaps supported by the main search engines, Google and Bing, in xml and gzip formats.

The **Sitemap Component** is able of building the following types of sitemaps:

#### Sitemap Index
A sitemap that serves as a index containing references to other sitemap.xml files. 
More documentation can be found [here](https://support.google.com/webmasters/answer/71453?hl=en).

{'fraction_non_alphanumeric': 0.18211148951424985, 'fraction_numerical': 0.04445241082631296, 'mean_word_length': 4.161887141535615, 'pattern_counts': {'":': 4, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 30, 'lorem ipsum': 0, 'www.': 0, 'xml': 4}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6971187', 'n_tokens_mistral': 2202, 'n_tokens_neox': 2063, 'n_words': 346}