# README

[![Release](https://img.shields.io/github/v/release/JcDenis/alias)](https://github.com/JcDenis/alias/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/alias)](https://github.com/JcDenis/alias/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/alias)](https://github.com/JcDenis/alias/issues)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.26-blue.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/alias)
[![License](https://img.shields.io/github/license/JcDenis/alias)](https://github.com/JcDenis/alias/blob/master/LICENSE)

## WHAT IS ALIAS ?

_alias_ is a plugin for the open-source 
web publishing software called Dotclear.

This plugin creates public aliases of your blog's URLs.

## REQUIREMENTS

 _alias_ requires: 

  * admin permissions for management
  * Dotclear 2.26

## USAGE

First install _alias_, manualy from a zip package or from 
Dotaddict repository. (See Dotclear's documentation to know how do this)

You can manage your aliases from menu ''Alias'' on admin dashboard sidebar.

## RULES

Only blog URLs can be redirected.
It can redirect a specific URL "plop" to another one "post/2023/04/24/my-post".
It can redirect all URLs that content "plop" using alias "/plop/" 
by replacing it by destination "post" into requesting URL.
It can not redirect an alias to another alias. (Even if it's not at the begining of the URL!)
It has priority on all ohters URLs handlers, so if you create an alias of an existing page,
the destination from plugin _alias_ will be used.

Keep in mind, plugin _alias_ loads all registered aliases to test them on each page load, 
so more there are aliases, more page load is slow.

## LINKS

 * License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
 * Source & contribution : [GitHub Page](https://github.com/JcDenis/alias)
 * Packages & details:  [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/alias)

## CONTRIBUTORS

 * Olivier Meunier
 * Franck-paul
 * Jean-Christian Denis

 You are welcome to contribute to this code.