Maintainer	hapytexeu+gh@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Text.Slugify

Contents

Slug modes
Character tests
Slug algorithms

Description

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.

Synopsis

data SlugMode
- = SlugAscii
- | SlugUnicode
isWordSeparator :: Char -> Bool
isWordChar :: Char -> Bool
isRetainChar :: Char -> Bool
slugify :: Text -> Text
slugifyUnicode :: Text -> Text
slugifyWith :: SlugMode -> Text -> Text

Slug modes

data 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.

Instances

Instances details

Bounded SlugMode Source #
Instance details Defined in Text.Slugify Methods minBound :: SlugMode # maxBound :: SlugMode #
Enum SlugMode Source #
Instance details Defined in Text.Slugify Methods succ :: SlugMode -> SlugMode # pred :: SlugMode -> SlugMode # toEnum :: Int -> SlugMode # fromEnum :: SlugMode -> Int # enumFrom :: SlugMode -> [SlugMode] # enumFromThen :: SlugMode -> SlugMode -> [SlugMode] # enumFromTo :: SlugMode -> SlugMode -> [SlugMode] # enumFromThenTo :: SlugMode -> SlugMode -> SlugMode -> [SlugMode] #
Eq SlugMode Source #
Instance details Defined in Text.Slugify Methods (==) :: SlugMode -> SlugMode -> Bool # (/=) :: SlugMode -> SlugMode -> Bool #
Ord SlugMode Source #
Instance details Defined in Text.Slugify Methods compare :: SlugMode -> SlugMode -> Ordering # (<) :: SlugMode -> SlugMode -> Bool # (<=) :: SlugMode -> SlugMode -> Bool # (>) :: SlugMode -> SlugMode -> Bool # (>=) :: SlugMode -> SlugMode -> Bool # max :: SlugMode -> SlugMode -> SlugMode # min :: SlugMode -> SlugMode -> SlugMode #
Read SlugMode Source #
Instance details Defined in Text.Slugify Methods readsPrec :: Int -> ReadS SlugMode # readList :: ReadS [SlugMode] # readPrec :: ReadPrec SlugMode # readListPrec :: ReadPrec [SlugMode] #
Show SlugMode Source #
Instance details Defined in Text.Slugify Methods showsPrec :: Int -> SlugMode -> ShowS # show :: SlugMode -> String # showList :: [SlugMode] -> ShowS #

Character tests

isWordSeparator Source #

Arguments

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

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

isWordChar Source #

Arguments

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

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

isRetainChar Source #

Arguments

:: Char	The given `Char`acter to check.
-> Bool	True if the given `Char`acter 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.

Check if the given character is retained by the slugify algorithm.

Slug algorithms

slugify Source #

Arguments

:: Text	The given text to convert to a slug.
-> Text	The corresponding slug.

Slugify the given Text object and remove diacritics and convert characters to the corresponding ASCII equivalent.

slugifyUnicode Source #

Arguments

:: Text	The given text to convert to a slug.
-> Text	The corresponding slug.

Slugify the given Text object and retain Unicode characters.

slugifyWith Source #

Arguments

:: SlugMode	The given mode to slugify.
-> Text	The given text to convert to a slug.
-> Text	The corresponding slug.

Slugify the given Text with the given SlugMode.