shortcut-links-0.4.2.0: Link shortcuts for use in text markup

Safe HaskellSafe
LanguageHaskell2010

ShortcutLinks

Synopsis

Documentation

data Result a #

Constructors

Failure String 
Warning [String] a 
Success a 

Instances

Monad Result # 

Methods

(>>=) :: Result a -> (a -> Result b) -> Result b #

(>>) :: Result a -> Result b -> Result b #

return :: a -> Result a #

fail :: String -> Result a #

Functor Result # 

Methods

fmap :: (a -> b) -> Result a -> Result b #

(<$) :: a -> Result b -> Result a #

Applicative Result # 

Methods

pure :: a -> Result a #

(<*>) :: Result (a -> b) -> Result a -> Result b #

(*>) :: Result a -> Result b -> Result b #

(<*) :: Result a -> Result b -> Result a #

Show a => Show (Result a) # 

Methods

showsPrec :: Int -> Result a -> ShowS #

show :: Result a -> String #

showList :: [Result a] -> ShowS #

allShortcuts :: [([Text], Shortcut)] #

A list of all functions included in this module, together with suggested names for them.

useShortcut #

Arguments

:: Text

Shortcut name

-> Maybe Text

Option

-> Text

Link text

-> Result Text

Resulting URL

Use a shortcut from allShortcuts.

This is the main function you should use.

useShortcutFrom #

Arguments

:: [([Text], Shortcut)] 
-> Text

Shortcut name

-> Maybe Text

Option

-> Text

Link text

-> Result Text

Resulting URL

Use a shortcut from a list.

For instance, if you want to add hk as a synonym for hackage, you'd write:

>>> useShortcutFrom ((["hk"], hackage) : allShortcuts)