alias/README.md

# README

[![Release](https://img.shields.io/badge/release-1.11-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/alias/releases)
![Date](https://img.shields.io/badge/date-2023.10.23-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/alias)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/alias/src/branch/master/LICENSE)

## ABOUT

_alias_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).

> Create aliases of your blog's URLs.

## REQUIREMENTS

* Dotclear 2.28
* PHP 8.1+
* Dotclear admin permission for management

## 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. (Even if it's not at the begining of the URL!)
* It can not redirect an alias to another alias. 
* 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](https://git.dotclear.watch/JcDenis/alias/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/alias/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/alias))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/alias) (or on [GitHub](https://github.com/JcDenis/alias))
* [Issues & security](https://git.dotclear.watch/JcDenis/alias/issues) (or on [GitHub](https://github.com/JcDenis/alias/issues))

## CONTRIBUTORS

* Olivier Meunier (author)
* Franck-paul
* Jean-Christian Denis (latest)

You are welcome to contribute to this code.
update to dotclear 2.24 2022-11-27 13:51:46 +00:00			`# README`

code review 2023-10-24 09:43:11 +00:00			`[![Release](https://img.shields.io/badge/release-1.11-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/alias/releases)`
			`![Date](https://img.shields.io/badge/date-2023.10.23-c44d58.svg)`
upgrade to Dotclear 2.28 2023-10-15 10:07:19 +00:00			`[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)`
use static badge 2023-08-06 22:51:49 +00:00			`[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/alias)`
upgrade to Dotclear 2.28 2023-10-15 10:07:19 +00:00			`[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/alias/src/branch/master/LICENSE)`
update to dotclear 2.24 2022-11-27 13:51:46 +00:00
Use new README style 2023-08-21 18:50:22 +00:00			`## ABOUT`
update to dotclear 2.24 2022-11-27 13:51:46 +00:00
Use new README style 2023-08-21 18:50:22 +00:00			`_alias_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).`
update to dotclear 2.24 2022-11-27 13:51:46 +00:00
Use new README style 2023-08-21 18:50:22 +00:00			`> Create aliases of your blog's URLs.`
update to dotclear 2.24 2022-11-27 13:51:46 +00:00
			`## REQUIREMENTS`

upgrade to Dotclear 2.28 2023-10-15 10:07:19 +00:00			`* Dotclear 2.28`
			`* PHP 8.1+`
Use new README style 2023-08-21 18:50:22 +00:00			`* Dotclear admin permission for management`
update to dotclear 2.24 2022-11-27 13:51:46 +00:00
			`## 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.`

release 1.6 (fix #1) 2023-04-30 23:15:19 +00:00			`## RULES`

Use new README style 2023-08-21 18:50:22 +00:00			`* 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. (Even if it's not at the begining of the URL!)`
			`* It can not redirect an alias to another alias.`
			`* 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.`
release 1.6 (fix #1) 2023-04-30 23:15:19 +00:00
			`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.`

update to dotclear 2.24 2022-11-27 13:51:46 +00:00			`## LINKS`

upgrade to Dotclear 2.28 2023-10-15 10:07:19 +00:00			`* [License](https://git.dotclear.watch/JcDenis/alias/src/branch/master/LICENSE)`
Use new README style 2023-08-21 18:50:22 +00:00			`* [Packages & details](https://git.dotclear.watch/JcDenis/alias/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/alias))`
			`* [Sources & contributions](https://git.dotclear.watch/JcDenis/alias) (or on [GitHub](https://github.com/JcDenis/alias))`
			`* [Issues & security](https://git.dotclear.watch/JcDenis/alias/issues) (or on [GitHub](https://github.com/JcDenis/alias/issues))`
update to dotclear 2.24 2022-11-27 13:51:46 +00:00
			`## CONTRIBUTORS`

Use new README style 2023-08-21 18:50:22 +00:00			`* Olivier Meunier (author)`
			`* Franck-paul`
upgrade to Dotclear 2.28 2023-10-15 10:07:19 +00:00			`* Jean-Christian Denis (latest)`
update to dotclear 2.24 2022-11-27 13:51:46 +00:00
Use new README style 2023-08-21 18:50:22 +00:00			`You are welcome to contribute to this code.`