Описать формат и добавление

This commit is contained in:
2019-09-03 12:58:21 +03:00
parent ac89ac5d34
commit c92d2d915e

View File

@@ -2,13 +2,65 @@
**МЕТКИ** представляют собой простой способ делать заметки с перенаправлением. **МЕТКИ** представляют собой простой способ делать заметки с перенаправлением.
## Добавление метки Они отлично зарекомендовали себя в ходе разработки игр [Память][memory] и [Маджонг][mahjong].
* Добавляем новый файл в директорию `метки/` ### Добавление метки
* Генерируем базу файлов всех меток путём запуска скрипта `./ген`
* Добавляем новый файл под любым удобным именем в директорию `метки/`
* Генерируем базу файлов всех меток
```
$ ./ген
```
* Отправляем изменения в хранилище Git * Отправляем изменения в хранилище Git
```
$ git add .
$ git commit -m "Добавить метку разбора файлов"
$ git push
```
# Формат метки ### Формат файла метки
Файл метки имеет следующий формат:
```
ИМЯ
разборайлов
ДАТА
2019-08-08
ОПИСАНИЕ
Разбор файлов с метками. АПИ.
Можно несколько строк.
АДРЕС
http://ссылка/на/пример/или/прочерк
```
После разбора указанные обязательные ключи будут содержать следующие значения:
* **ИМЯ**: `разборайлов`
* **ДАТА**: `2019-08-08`
* **ОПИСАНИЕ**: ` Разбор файлов с метками. АПИ. Можно несколько строк.`
* **АДРЕС**: `http://ссылка/на/пример/или/прочерк`
Примеры файлов меток для игры "Память" можно [посмотреть здесь][memory-metki].
### Перенаправление
Перенаправление осуществляется файлом `метки_1.0.0.html`, которому в качестве параметра после знака вопроса `?` передаётся имя метки:
Пример метки для игры "Память" выглядит следующим образом: [http://kornerr.ru/память?и.цвет](http://kornerr.ru/память?и.цвет).
### Просмотр существующих меток
Если запрошенного имени метки не существует, отображается список доступных меток с описанием.
Пример списка меток для игры "Память" выглядит следующим образом: [http://kornerr.ru/память?лебедьРакЩука](http://kornerr.ru/память?лебедьРакЩука).
### Создание меток для проекта
НАДО
# EN # EN
[memory]: http://kornerr.ru/память
[mahjong]: http://kornerr.ru/маджонг
[memory-metki]: http://git.opengamestudio.org/kornerr/memory-metki