typograf

Типограф на JavaScript

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

Черты:

• гибкость и расширяемость;
• кроссбраузерность;
• мультиязычность;
• utf-8;
• поддержка Node.js;
• TDD.

Поддерживаемые правила

Форматы:

• HTML
• TXT
• SVG
• XML

Использование

В браузере

bower install typograf

<script src="dist/typograf.min.js"></script>
<script>
    var tp = new Typograf({lang: 'ru'});
    alert(tp.execute('     Мир - мой мир!      '));
</script>

Node.js

npm install typograf

var Typograf = require('typograf'),
    tp = new Typograf({lang: 'ru'});

console.log(tp.execute(' Мир - мой мир!!   '));

Плагины

• grunt-typograf
• gulp-typograf

Командная строка

npm install typograf -g

typograf — вывод справки

typograf -l ru my_file.txt — типографировать текст по русским правилам

typograf -l en my_file.txt — типографировать файл по английским правилам

typograf -l ru -d ru/punctuation/quot -e ru/optaling/* my_file.txt > new_my_file — типографировать файл с отключенным правилом ru/punctuation/quot и включенными правилами ru/optaling/*

API

Висячая пунктуация

По умолчанию висячая пунктуация отключена.

Для включения необходимо подключить правила:

var Typograf = require('typograf'),
    tp = new Typograf({lang: 'ru'});

tp.enable('ru/optalign/*');
console.log(tp.execute('"Мир"'));

А также в HTML-код страницы добавить:

<link rel="stylesheet" href="dist/typograf.css" type="text/css" />

Включить/отключить правило

var tp = new Typograf({lang: 'ru'});
tp.enable('ru/money/ruble'); // Включить правило
//...
tp.disable('ru/money/ruble'); // Отключить правило

Изменить настройку у правила

var tp = new Typograf({lang: 'ru'});
// Название правила, название настройки, значение
tp.setting('common/nbsp/beforeShortLast', 'lengthLastWord', 5);

Добавить правило

Typograf.rule({
    // Заголовок
    title: 'Пример правила',
    // язык/группа/правило
    name: 'common/other/parampampam',
    // Очередность выполнения правил, чем меньше индекс, тем раньше выполнится правило
    sortIndex: 2000,
    // Функция обработки правила
    func: function(text) {
        return text.replace(/parampampam/g, 'tryam');
    }
});

Режим работы

// Режим по умолчанию, HTML-сущности, как utf-8 символы
var tp = new Typograf({lang: 'ru'});
tp.execute('...'); // …

// HTML-сущности, как имена
var tpName = new Typograf({lang: 'ru', mode: 'name'});
tpName.execute('...'); // …

// HTML-сущности, как цифры
var tpDigit = new Typograf({lang: 'ru', mode: 'digit'});
tpDigit.execute('...'); // …

Сжатие с UglifyJS

Если typograf.js сжимается вместе с другими js-файлами в UglifyJS, то необходимо использовать опцию ascii_only: false, иначе типограф будет работать некорректно.

Разработка

git clone https://github.com/typograf/typograf.git ./typograf

Пересборка и запуск тестов: gulp && npm test

Лицензия

MIT License

Ссылки

• Букмарклет для типографа
• Средство поиска опечаток в текстах
• Восстановление буквы «ё» в русских текстах

Changelog

v2.11.1

• Некорректная расстановка кавычек рядом с тегами #100
• Добавлен Changelog

Исправлен ошибочный порядок выполнения правил:

• common/html/pbr
• common/html/nbr
• common/nbsp/nowrap