> For the complete documentation index, see [llms.txt](https://docs.norrnext.com/norrcompetition/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.norrnext.com/norrcompetition/plugins/norrcompetition-sitemap.md).

# NorrCompetition Sitemap

OSMap sitemap integration plugin for NorrCompetition.

### Overview

**NorrCompetition OSMap Plugin** (`plg_osmap_osmnc`) integrates NorrCompetition with the popular [OSMap](https://extensions.joomla.org/extension/osmap/) sitemap generator for Joomla. It automatically builds XML and HTML sitemap trees for your NorrCompetition categories, contests, and participant entries to enhance SEO and search engine discoverability.

### Installation & Updates

1. Install the plugin package via **System > Install > Extensions**.
2. Navigate to **System > Plugins** and search for `OSMap - NorrCompetition`.
3. Enable the plugin and configure your sitemap indexing preferences.
4. Set your **Download Key** to receive automatic updates.

### Configuration

Open the plugin in **System > Plugins > OSMap - NorrCompetition**.

#### 1. Plugin Tab (Structure & Hierarchy)

| Option                           | Type / Values                                                         | Default     | Description                                                                                             |
| -------------------------------- | --------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------- |
| **Show Unauthorized Links**      | Dropdown (*Never*, *Always*, *XML Sitemap Only*, *HTML Sitemap Only*) | `Never`     | Determines whether links to restricted/registered content should appear in sitemaps for guest visitors. |
| **Categories order**             | Dropdown (*Title*, *Created Date*)                                    | `Title`     | Primary sorting field for category links.                                                               |
| **Order direction** (Categories) | Dropdown (*Ascending*, *Descending*)                                  | `Ascending` | Sorting direction for categories.                                                                       |
| **Include Contests**             | Dropdown (*Never*, *Always*, *XML Sitemap Only*, *HTML Sitemap Only*) | `Always`    | Controls whether contest links are added to the sitemap tree.                                           |
| **Max Contests**                 | Integer (`0` = no limit)                                              | `0`         | Maximum number of contests to include in the sitemap.                                                   |
| **Contests order**               | Dropdown (*Ordering*, *Title*, *Created Date*)                        | `Ordering`  | Primary sorting order for contest items.                                                                |
| **Order direction** (Contests)   | Dropdown (*Ascending*, *Descending*)                                  | `Ascending` | Sorting direction for contests.                                                                         |
| **Include Entries**              | Dropdown (*Never*, *Always*, *XML Sitemap Only*, *HTML Sitemap Only*) | `Always`    | Controls whether individual entry pages are included under each contest.                                |
| **Max Entries**                  | Integer (`0` = no limit)                                              | `20`        | Maximum number of entries per contest to include.                                                       |
| **Entries order**                | Dropdown (*Ordering*, *Title*, *Created Date*)                        | `Ordering`  | Primary sorting order for entries.                                                                      |
| **Order direction** (Entries)    | Dropdown (*Ascending*, *Descending*)                                  | `Ascending` | Sorting direction for entries.                                                                          |

#### 2. XML Sitemap Settings Tab

These parameters control metadata hints sent to search engines (Google, Bing) in XML sitemaps:

| Parameter                     | Available Options                                                                               | Default                    | Description                                      |
| ----------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------ |
| **Category Priority**         | `Use Parent Menu Settings`, `0.0` – `1.0`                                                       | `Use Parent Menu Settings` | Priority weighting for category URLs.            |
| **Category Change Frequency** | `Use Parent Menu Settings`, `Always`, `Hourly`, `Daily`, `Weekly`, `Monthly`, `Yearly`, `Never` | `Use Parent Menu Settings` | Suggested indexing frequency for category pages. |
| **Contest Priority**          | `Use Parent Menu Settings`, `0.0` – `1.0`                                                       | `Use Parent Menu Settings` | Priority weighting for contest URLs.             |
| **Contest Change Frequency**  | `Use Parent Menu Settings`, `Always`, `Hourly`, `Daily`, `Weekly`, `Monthly`, `Yearly`, `Never` | `Use Parent Menu Settings` | Suggested indexing frequency for contest pages.  |
| **Entry Priority**            | `Use Parent Menu Settings`, `0.0` – `1.0`                                                       | `Use Parent Menu Settings` | Priority weighting for individual entry URLs.    |
| **Entry Change Frequency**    | `Use Parent Menu Settings`, `Always`, `Hourly`, `Daily`, `Weekly`, `Monthly`, `Yearly`, `Never` | `Use Parent Menu Settings` | Suggested indexing frequency for entry pages.    |