# Sitemaps v0.1.2 - Table of Contents

> Generating sitemap files

## Pages

- [Sitemaps](readme.md)
- [LICENSE](license.md)

## Modules

- [Sitemaps](Sitemaps.md): Sitemap application is in charge of running the supervisor and the following
processes under it
- [Sitemaps.Builders.File](Sitemaps.Builders.File.md): Build the file content of the sitemap. It creates the file and
it's in charge of the size, if it's growing over the configured
size, it's creating a new file.

- [Sitemaps.Builders.IndexFile](Sitemaps.Builders.IndexFile.md): Creates a index file for the number of files containing the sitemaps.

- [Sitemaps.Builders.IndexUrl](Sitemaps.Builders.IndexUrl.md): It has only one function to convert to XML a link.
Indeed, it's creating a _sitemap_ tag that's returned
to be included inside of a sitemap file.

- [Sitemaps.Builders.Url](Sitemaps.Builders.Url.md): Create the _url_ tag adding all of the information that could be
passed via attributes to the function `to_xml/2` as second parameter.

- [Sitemaps.Config](Sitemaps.Config.md): Configuration for the generation of the sitemap. Here we define some values
that are going to be in use for the sitemap files or index files but we
cannot add in the individual adds, i.e. hostname.
- [Sitemaps.Consts](Sitemaps.Consts.md): Define the information needed to generate XML. Here you can find the schemas,
the XML header, XML footer, and same header and footer for XML indexes.

- [Sitemaps.DSL](Sitemaps.DSL.md): The DSL is the implementation of the most important part
of this project, it's going to help you to define the
pages to be included in the sitemap.
- [Sitemaps.File](Sitemaps.File.md): Perform the write of the file.

- [Sitemaps.Func](Sitemaps.Func.md): Func is that module that is usually called utils, common, or another name
you can figure it out where you have not to think about to put whatever
function you don't know where to put.
- [Sitemaps.Generator](Sitemaps.Generator.md): Generator provides functions for generate the sitemap file.

- [Sitemaps.Location](Sitemaps.Location.md): Location is a facility for giving the path and filename for the sitemap file
and the index file.

- [Sitemaps.Namer](Sitemaps.Namer.md): Names generated for the sitemap files.

- [Sitemaps.State](Sitemaps.State.md): Creates a state for the modules that use this module.

- Exceptions
  - [Sitemaps.DirNotExists](Sitemaps.DirNotExists.md): When the directory where a file will be written doesn't exist, this
error will be triggered.

  - [Sitemaps.NameError](Sitemaps.NameError.md): This error is triggered when `Sitemaps.Namer.previous!/1` function
is called but it's the located in the first file.

