Giter Site home page Giter Site logo

typographizer's Introduction

Typographizer · Smart Quotes for Swift Apps

Typographizer turns those pesky dumb quotes (""/'') and apostrophes (') into their beautiful, curly, localized counterparts. Because good typography uses smart quotes, not dumb quotes and we should not let the internet kill smart quotes. Speaking of smartness: Typographizer is smart enough to skip HTML tags and everything between certain tags (like <code> and <pre>).

Typographizer has a small footprint, was written in pure Swift 3, and has been tested on macOS, iOS, watchOS, and tvOS.

I started building Typographizer to typographize Wikipedia articles in my V for Wiki app.

Installation

Put the .swift files into your app’s Xcode project.

How to Use

The easiest way to use Typographizer is the String extension (String+Typographizer.swift):

var s = "This is a string with \"dumb\" quotes."

s = s.typographized(language: "en")

print(s) // This is a string with “dumb” quotes.

Ignoring HTML Tags

If your string may contain HTML, set the isHTML parameter to true. Typographizer will then ignore the quotes inside tags and anything between <pre>, <code>, <var>, <samp>, <kbd>, <math>, <script>, and <style> tags:

var s = "This is a \"string\" with HTML. <code class="">print(\"hello world\")</code>"

s = s.typographized(language: "en", isHTML: true)

print(s) // This is a “string” with HTML. <code class="">print("hello world")</code>

Debug Mode

Activate the debug mode to highlight the characters that have been changed—Typographizer will add this tag around them: <span class="typographizer-debug typographizer-debug--XXX"> </span>

var s = "This is a string with \"dumb\" quotes."

s = s.typographized(language: "en", isHTML: true, debug: true)

print(s) // This is a string with <span class="typographizer-debug typographizer-debug--opening-double">“</span>dumb<span class="typographizer-debug typographizer-debug--closing-double">”</span> quotes.

(Yes, the class names are a little wordy, but that’s on purpose.)

Use CSS to visualize the changes:

.typographizer-debug {
  font-weight: bold;
}

.typographizer-debug--apostrophe {
  color: red;
}

/* … */

Measuring Performance

Pass measurePerformance: true to log performance stats:

s = s.typographized(language: "en", isHTML: true, debug: false, measurePerformance: true)

You’ll see something like this in the Xcode console:

Typographizing took 0.00582303 seconds

Features

  • Fixes double quotes: ""“” (localized)
  • Fixes single quotes: ''‘’ (localized)
  • Fixes apostrophes: '
  • Fixes hyphens that are used as en dashes: … - …… – …
  • Demo app project for macOS

Supported Languages

Language Code Double Quotes Single Quotes Comment
bs
cs
da
de
de_CH « » Swiss German
en
et
fi
fr «\u{00A0} \u{00A0}» ‹\u{00A0} \u{00A0}› French Quotes are set with a non-breaking space (\u{00A0}). A thin non-breaking space would be better, but it’s not supported in most browsers.
hu
is
ja
lt
lv
nl
nn « »
no « »
pl
ro
ru « »
sk
sl
sv

Demo App

To get started, try the included demo app for macOS.

To Do

  • Handle special cases like ’80s, ’Twas, Rock ’n’ Roll, etc.
  • Handle primes in coordinates properly:
    52° 27' 20" N, 13° 19' 11" E → 52° 27′ 20″ N, 13° 19′ 11″ E
  • Add support for Hebrew
  • If there is only one dumb single quote in a string, it’s probably an apostrophe
  • Analyze HTML tags to verify correct quotes (opening and closing <p> tags make a good indicator for opening and closing quotation marks)
  • Track open/closed state while iterating over the text to make more informed decisions
  • Add more typographic refinements (e.g. prime symbols, thin spaces)
  • Build a Swift Framework project (or maybe this is overkill?)
  • Add Carthage/CocoaPods support (or maybe this is overkill?)

Credits

Typographizer was created by Frank Rausch (@frankrausch).

Thanks to Tony Allevato for the great article on Strings, characters, and performance in Swift—a deep dive.

License

The Typographizer source code is released under the MIT License. Please view the LICENSE file for details.

The Typographizer logo is © 2017 Frank Rausch; all rights reserved.

typographizer's People

Contributors

frankrausch avatar

Watchers

Samuel Mellert avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.