codex.special/README.md

Module for making high-contrast version of websites.

# Модуль для активации контрастной версии сайта

CodeX.Special сделает информацию на вашем сайте более доступной для людей с ограниченными возможностями. Модуль прост в подключении и использовании.

## Установка

CodeX.Special поддерживает несколько возможных вариантов установки.

### Подключение с вашего сервера

Сохраните файлы модуля и подключите js-скрипт.

```html
<script src="/public/extensions/codex.special/codex-special.min.js"></script>
```

### GitHub CDN

Вы также можете подключить скрипт с серверов GitHub, ничего не скачивая.

```html
<script src="https://cdn.rawgit.com/codex-team/codex.special/master/codex-special.min.js"></script>
```

### NPM

Установите [codex.special](https://www.npmjs.com/package/codex.special) с помощью менеджера пакетов для Node.js

```shell
npm i --save codex.special
```

Импортируйте пакет

```js
var codexSpecial = require('codex.special');
```


## Инициализация

Для того, чтобы запустить модуль, достаточно вызвать метод `init()`.

```js
codexSpecial.init({});
```

Чтобы скрипт запускался до того, как загрузится страница, добавьте инициализацию модуля в тег скрипта.

```html
<script ... onload="codexSpecial.init({});"></script>
```


Результат

<img width="515" alt="screen shot 2016-10-20 at 02 38 43" src="https://cloud.githubusercontent.com/assets/15259299/19541365/5f59894e-966e-11e6-937b-216984380db3.png">

## Дополнительные параметры

### Положение панели на странице

По умолчанию скрипт создает панель, которая привязана к верхней правой границе экрана.

Угол, в котором будет располагаться панель управления модулем, можно указать в параметре `position`.

Возможные значения: `top-left`, `bottom-right`, `bottom-left`, `top-right` (устанавливается по-умолчанию).
```js
codexSpecial.init({
    position : 'bottom-right',
});
```


Вы можете определить положение панели, указав в параметре `blockId` идентификатор обертки.

Например, чтобы встроить панель в блок с идентификатором `#panelHolder`:
```js
codexSpecial.init({
    blockId : 'panelHolder',
});
```

<img width="581" alt="screen shot 2016-12-13 at 18 51 13" src="https://cloud.githubusercontent.com/assets/15259299/21147396/e1ed1548-c165-11e6-8707-341676ee11c6.png">

### Мультиязычность

При необходимости можно инициализировать скрипт с параметром `lang`, определяющим язык для надписей на блоке.
Доступны `ru` и `en` для русского и английского языка.

 ```js
codexSpecial.init({
    lang : 'en',
});
```
<img width="501" alt="screen shot 2016-10-20 at 02 56 17" src="https://cloud.githubusercontent.com/assets/15259299/19541744/4e5dea7e-9671-11e6-854d-93d99ee240ec.png">


## Разработка

Codex Team — <team@ifmo.su>

Страница проекта CodeX.Special — https://ifmo.su/special

GitHub — https://github.com/codex-team/codex.special

NPM — https://www.npmjs.com/package/codex.special



## Лицензия

Copyright (c) 2017 CodeX

Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, слияние, публикацию, распространение, сублицензирование и/или продажу копий Программного Обеспечения, а также лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих условий:

Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного Программного Обеспечения.

ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ ГАРАНТИИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ, НО НЕ ОГРАНИЧИВАЯСЬ ИМИ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО КАКИМ-ЛИБО ИСКАМ, ЗА УЩЕРБ ИЛИ ПО ИНЫМ ТРЕБОВАНИЯМ, В ТОМ ЧИСЛЕ, ПРИ ДЕЙСТВИИ КОНТРАКТА, ДЕЛИКТЕ ИЛИ ИНОЙ СИТУАЦИИ, ВОЗНИКШИМ ИЗ-ЗА ИСПОЛЬЗОВАНИЯ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫХ ДЕЙСТВИЙ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.