Tipograph

First of all - correct typography is important. Even if we aren't typography freaks we must say that curly quotes look much better than straight ones. But, let's be honest, not everyone is too thorough to learn all these typography rules. And even if we know them, it's pretty frustrating to press these alt/option combinations for em dash or copyright symbol.

And hence there is Tipograph. It can manage a lot of these rules for you and then you could concentrate just on your words. After you are done take your text and pass it into any Replace module method. It will return the typographically correct sequence of characters. Isn't it amazing! And it can be used in both browser and Node.

When creating this I don't invent all these rules myself. I have been following some of (I think trustworthy) resources. It's impossible to follow all these rules because some of them cannot be managed by code without a complex understanding of context. I hope this is quite enough. And a lot improvements would come.

If you are interested in Tipograph, maybe you will be pleased when I tell you I am going to write module which will provide live replacement and will be useful for (your) word processor.

Note

I would very appreciate if you could check the source code. There are some notes starting with NOTE: and it would be really great if you could tell me your opinion (for example as an issue) about these or not only these. And it would be even better if you could support it via example. Thank you for your possible feedback.

Installation

Node

$ npm install tipograph

Browser

<script type="text/javascript" src="path/to/replace.js"></script>
<!-- optional -->
<script type="text/javascript" src="path/to/languages.js"></script>

Usage

Usage of Tipograph is really simple. Just pass the input and get the transformed result.

//node
var replace = require('tipograph').Replace;

//browser
var replace = window.Tipograph.Replace;

//usage - replace all what is shown below
replace.all('"I\'m Tipograph - a library for better typography"');

It will change "I'm Tipograph - a library for better typography" into “I’m Tipograph – a library for better typography”. Isn't it much better? I think it is. And this is just beginning!

What it can do

Quotes

Tipograph finds pairs of straight quotes (both double and single) and replaces them with curly ones. And it also respects format/language you have defined (see quotes in different languages). Furthermore, Tipograph replaces all single straight quotes which are determined as apostrophe with correct character. Also foot and inch signs are replaced correctly with primes or double primes respectively. Next feature of Tipograph is to recognize some bad habbits of users - some people type two commas in order to make quote look like double low-9 quotation mark or one comma to make quote look like single low-9 quotation mark. This is horrible and even more - it breaks the feature to find quote pairs. In the case of one comma it recognizes what should be comma and what should be single quote.

var output = replace.quotes('your text');

Spaces

There should't be more than two spaces within your text so Tipograph replaces them with single one. And it also put non breaking space after some symbols where it should be. Currently the symbols are:

paragraph (¶)
section sign (§)
copyright (©)
trademark (™)
registered trademark (®)

var output = replace.spaces('your text');

Hyphens

Some people type two consecutive hyphens (--) as representation of en dash (–) and three consecutive hyphens (---) as representation of em dash (—). This is wrong. Therefore Tipograph replaces these sequences with correct characters. Furthermore, ranges of values should be written with en dashes. So Tipograph tries to recognize ranges and replaces hyphen with en dash. It also finds sentence breaks where should be used en dash (or em dash without spaces, this will be configuration option) and corrects it.

var output = replace.hyphens('your text');

Math signs

A lot of people use generally accepted substitutions for some math signs (for example letter "x" for multiplication symbol or "!=" sequence instead of inequality sign). The correct characters look much better than generally used ones. Replaced signs:

minus (2 - 1, -3, not 2-1) - hyphen is replaced with minus character (–)
multiplication (2 x 3, not 1x2) - letter "x" is replaced with multiplication sign (×)
division (6 / 3, not 10/5) - forward slash is replaced with division sign (÷)
plus-minus (+-) - sequence of plus and hyphen is replaced with plus-minus sign (±)
inequality (!=, <>) - these sequences, rather used in programming, are replaced with correct inequality sign (≠)

var output = replace.mathSigns('your text');

Symbols

If we or our users are lazy to learn how to type correct special symbols (see below) we need to replace generally used substitutions with these symbols. In this moment the symbols are:

copyright - (c), (C) => ©
trademark - (tm), (TM) => ™
registered trademark - (r), (R) => ®
ellipsis - ..., not .... => …

var output = replace.symbols('your text');

Custom rules

You can also define your own rules because they are missing in Tipograph.

//add custom rules
replace.addCustomRule('foo', 'bar');
replace.addCustomRule(/qu(.)/g, function (match, p1, offset, string) {
	if (p1 === 'o') return 'Quo';
    return match;
});

//apply them
var output = replace.custom('your text');

addCustomRule(search, replacement)

search

Type: RegExp|String

Define what will be searched in input to be replaced.

replacement

Type: String|Function

Define how found values will be replaced. The String.prototype.replace method is applied to input so format of this parameter could be the same as described here.

Stream

Tipograph also supports streams. If you want to transform input from one stream and write them to another, here is tipograph.createStream([options]) method for you.

NOTE: This is supported only in Node environment.

var fs = require('fs');
var tipograph = require('tipograph');

fs.createReadStream('source.txt')
    .pipe(tipograph.createStream())
    .pipe(fs.createWriteStream('destination.txt'));

Stream applies all replacements by default but you can change it using options object. Just pass what you want to disable e.g. like that:

var stream = tipograph.createStream({ hyphens : false, spaces : false });