Moduleslugify-0.1.0.2Haskell2010

Text.Slugify

The module to convert text into slugs. A slug is a hyphen separated string of words. Slugs are often used to make visually pleasant URLs by transforming for example the title of an article into a slug, and use this in the URL, for more information see the Wikipedia section.

Contents

Slug modes
Character tests
Slug algorithms

Synopsis

data SlugMode
value isWordSeparator
value isWordChar
value isRetainChar
value slugify
value slugifyUnicode
value slugifyWith

Packageslugify-0.1.0.2
Exports7
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSlugify.hs

Slug modes

datadata SlugMode

Source#

The given mode to slugify a Text object.

Constructors

SlugAscii
Slugify by removing diacritics and only retain ASCII characters.
SlugUnicode
Slugify by allowing unicode characters.

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded SlugModeDefined in slugify-0.1.0.2 · Text.Slugify
Enum SlugModeDefined in slugify-0.1.0.2 · Text.Slugify
Eq SlugModeDefined in slugify-0.1.0.2 · Text.Slugify
Ord SlugModeDefined in slugify-0.1.0.2 · Text.Slugify
Read SlugModeDefined in slugify-0.1.0.2 · Text.Slugify
Show SlugModeDefined in slugify-0.1.0.2 · Text.Slugify

Character tests

valueisWordSeparator

:: Char
The given Character to check.
-> Bool
True if the given character is a separator; False otherwise.

Source#

Check if the given Character is a word separator, for the given slugify algorithm.

valueisWordChar

:: Char
The given Character to check.
-> Bool
True if it is a word character; False otherwise.

Source#

Check if the given Character is considered a word character for the slugify algorithm.

valueisRetainChar

:: Char
The given Character to check.
-> Bool
True if the given Character will be retained; False otherwise. Some of these characters will however be converted to a hyphen (-), and thus eventually will only produce a different character in the slug.